* [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc
@ 2025-10-17 7:07 Randy Dunlap
2025-10-17 8:17 ` Konrad Dybcio
0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2025-10-17 7:07 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Bartosz Golaszewski, Bjorn Andersson,
Konrad Dybcio, linux-arm-msm
Fix kernel-doc warnings by using correct kernel-doc syntax and
formatting to prevent warnings:
Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Cc: Bjorn Andersson <andersson@kernel.org>
Cc: Konrad Dybcio <konradybcio@kernel.org>
Cc: linux-arm-msm@vger.kernel.org
---
include/linux/firmware/qcom/qcom_tzmem.h | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
--- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
+++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
@@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
* enum qcom_tzmem_policy - Policy for pool growth.
*/
enum qcom_tzmem_policy {
- /**< Static pool, never grow above initial size. */
+ /**
+ * @QCOM_TZMEM_POLICY_STATIC: Static pool,
+ * never grow above initial size. */
QCOM_TZMEM_POLICY_STATIC = 1,
- /**< When out of memory, add increment * current size of memory. */
+ /**
+ * @QCOM_TZMEM_POLICY_MULTIPLIER: When out of memory,
+ * add increment * current size of memory. */
QCOM_TZMEM_POLICY_MULTIPLIER,
- /**< When out of memory add as much as is needed until max_size. */
+ /**
+ * @QCOM_TZMEM_POLICY_ON_DEMAND: When out of memory
+ * add as much as is needed until max_size. */
QCOM_TZMEM_POLICY_ON_DEMAND,
};
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc
2025-10-17 7:07 [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc Randy Dunlap
@ 2025-10-17 8:17 ` Konrad Dybcio
2025-10-17 8:25 ` Bartosz Golaszewski
0 siblings, 1 reply; 4+ messages in thread
From: Konrad Dybcio @ 2025-10-17 8:17 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Bartosz Golaszewski, Bjorn Andersson, Konrad Dybcio, linux-arm-msm
On 10/17/25 9:07 AM, Randy Dunlap wrote:
> Fix kernel-doc warnings by using correct kernel-doc syntax and
> formatting to prevent warnings:
>
> Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> 'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> 'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> 'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
>
> Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> Cc: Bjorn Andersson <andersson@kernel.org>
> Cc: Konrad Dybcio <konradybcio@kernel.org>
> Cc: linux-arm-msm@vger.kernel.org
> ---
> include/linux/firmware/qcom/qcom_tzmem.h | 12 +++++++++---
> 1 file changed, 9 insertions(+), 3 deletions(-)
>
> --- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
> +++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
> @@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
> * enum qcom_tzmem_policy - Policy for pool growth.
> */
> enum qcom_tzmem_policy {
> - /**< Static pool, never grow above initial size. */
> + /**
> + * @QCOM_TZMEM_POLICY_STATIC: Static pool,
> + * never grow above initial size. */
Didn't know inline '*/' was cool, but if the checkers I'm happy, I'm not
going to complain either
Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>
Konrad
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc
2025-10-17 8:17 ` Konrad Dybcio
@ 2025-10-17 8:25 ` Bartosz Golaszewski
2025-10-17 19:05 ` Randy Dunlap
0 siblings, 1 reply; 4+ messages in thread
From: Bartosz Golaszewski @ 2025-10-17 8:25 UTC (permalink / raw)
To: Konrad Dybcio
Cc: Randy Dunlap, linux-kernel, Bjorn Andersson, Konrad Dybcio,
linux-arm-msm
On Fri, 17 Oct 2025 at 10:17, Konrad Dybcio
<konrad.dybcio@oss.qualcomm.com> wrote:
>
> On 10/17/25 9:07 AM, Randy Dunlap wrote:
> > Fix kernel-doc warnings by using correct kernel-doc syntax and
> > formatting to prevent warnings:
> >
> > Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> > 'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
> > Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> > 'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
> > Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> > 'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
> >
> > Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > ---
> > Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> > Cc: Bjorn Andersson <andersson@kernel.org>
> > Cc: Konrad Dybcio <konradybcio@kernel.org>
> > Cc: linux-arm-msm@vger.kernel.org
> > ---
> > include/linux/firmware/qcom/qcom_tzmem.h | 12 +++++++++---
> > 1 file changed, 9 insertions(+), 3 deletions(-)
> >
> > --- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
> > +++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
> > @@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
> > * enum qcom_tzmem_policy - Policy for pool growth.
> > */
> > enum qcom_tzmem_policy {
> > - /**< Static pool, never grow above initial size. */
> > + /**
> > + * @QCOM_TZMEM_POLICY_STATIC: Static pool,
> > + * never grow above initial size. */
>
> Didn't know inline '*/' was cool, but if the checkers I'm happy, I'm not
> going to complain either
>
> Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>
>
> Konrad
Yes, very surprising. Almost doesn't look "right".
Anyway:
Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc
2025-10-17 8:25 ` Bartosz Golaszewski
@ 2025-10-17 19:05 ` Randy Dunlap
0 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2025-10-17 19:05 UTC (permalink / raw)
To: Bartosz Golaszewski, Konrad Dybcio
Cc: linux-kernel, Bjorn Andersson, Konrad Dybcio, linux-arm-msm
On 10/17/25 1:25 AM, Bartosz Golaszewski wrote:
> On Fri, 17 Oct 2025 at 10:17, Konrad Dybcio
> <konrad.dybcio@oss.qualcomm.com> wrote:
>>
>> On 10/17/25 9:07 AM, Randy Dunlap wrote:
>>> Fix kernel-doc warnings by using correct kernel-doc syntax and
>>> formatting to prevent warnings:
>>>
>>> Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>>> 'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
>>> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>>> 'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
>>> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>>> 'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
>>>
>>> Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>> ---
>>> Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>>> Cc: Bjorn Andersson <andersson@kernel.org>
>>> Cc: Konrad Dybcio <konradybcio@kernel.org>
>>> Cc: linux-arm-msm@vger.kernel.org
>>> ---
>>> include/linux/firmware/qcom/qcom_tzmem.h | 12 +++++++++---
>>> 1 file changed, 9 insertions(+), 3 deletions(-)
>>>
>>> --- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
>>> +++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
>>> @@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
>>> * enum qcom_tzmem_policy - Policy for pool growth.
>>> */
>>> enum qcom_tzmem_policy {
>>> - /**< Static pool, never grow above initial size. */
>>> + /**
>>> + * @QCOM_TZMEM_POLICY_STATIC: Static pool,
>>> + * never grow above initial size. */
>>
>> Didn't know inline '*/' was cool, but if the checkers I'm happy, I'm not
>> going to complain either
>>
>> Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>
>>
>> Konrad
>
> Yes, very surprising. Almost doesn't look "right".
>
> Anyway:
> Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Darn. It looks OK but it totally confuses scripts/kernel-doc.
It has to end with a separate */ for each comment.
I'll have to resend this patch.
--
~Randy
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2025-10-17 19:05 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-10-17 7:07 [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc Randy Dunlap
2025-10-17 8:17 ` Konrad Dybcio
2025-10-17 8:25 ` Bartosz Golaszewski
2025-10-17 19:05 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®