* [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
@ 2022-04-04 13:02 ` Sudeep Holla
0 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-04 13:02 UTC (permalink / raw)
To: linux-arm-kernel, linux-kernel
Cc: Sudeep Holla, Liviu Dudau, Lorenzo Pieralisi, kernel test robot
Kbuild bot reported the following doxygen build warning:
| arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
| '/**', but isn't a kernel-doc comment.
| Refer Documentation/doc-guide/kernel-doc.rst
| * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
Fix the issue by dropping the parameters specified in the kernel doc.
Cc: Liviu Dudau <liviu.dudau@arm.com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
Reported-by: kernel test robot <lkp@intel.com>
Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
arch/arm/mach-vexpress/spc.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
index 1c6500c4e6a1..8f99d47d4b89 100644
--- a/arch/arm/mach-vexpress/spc.c
+++ b/arch/arm/mach-vexpress/spc.c
@@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
}
/**
- * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
+ * ve_spc_cpu_in_wfi()
*
* @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
--
2.35.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [PATCH 2/2] ARM: vexpress/spc: Fix all the doxygen build warnings
2022-04-04 13:02 ` Sudeep Holla
@ 2022-04-04 13:02 ` Sudeep Holla
-1 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-04 13:02 UTC (permalink / raw)
To: linux-arm-kernel, linux-kernel
Cc: Sudeep Holla, Liviu Dudau, Lorenzo Pieralisi, kernel test robot
There are more doxygen build warnings as below than the ones reported
by kernel test robot recently.
| arch/arm/mach-vexpress/spc.c:125: warning: missing initial short description on line:
| * ve_spc_global_wakeup_irq()
| arch/arm/mach-vexpress/spc.c:131: warning: contents before sections
| arch/arm/mach-vexpress/spc.c:148: warning: missing initial short description on line:
| * ve_spc_cpu_wakeup_irq()
| arch/arm/mach-vexpress/spc.c:154: warning: contents before sections
| arch/arm/mach-vexpress/spc.c:203: warning: missing initial short description on line:
| * ve_spc_powerdown()
| arch/arm/mach-vexpress/spc.c:209: warning: contents before sections
| arch/arm/mach-vexpress/spc.c:231: warning: missing initial short description on line:
| * ve_spc_cpu_in_wfi()
| 7 warnings
Fix all the warnings.
Cc: Liviu Dudau <liviu.dudau@arm.com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
arch/arm/mach-vexpress/spc.c | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
index 8f99d47d4b89..6e6985e756af 100644
--- a/arch/arm/mach-vexpress/spc.c
+++ b/arch/arm/mach-vexpress/spc.c
@@ -122,13 +122,13 @@ static inline bool cluster_is_a15(u32 cluster)
}
/**
- * ve_spc_global_wakeup_irq()
+ * ve_spc_global_wakeup_irq() - sets/clears global wakeup IRQs
+ *
+ * @set: if true, global wake-up IRQs are set, if false they are cleared
*
* Function to set/clear global wakeup IRQs. Not protected by locking since
* it might be used in code paths where normal cacheable locks are not
* working. Locking must be provided by the caller to ensure atomicity.
- *
- * @set: if true, global wake-up IRQs are set, if false they are cleared
*/
void ve_spc_global_wakeup_irq(bool set)
{
@@ -145,15 +145,15 @@ void ve_spc_global_wakeup_irq(bool set)
}
/**
- * ve_spc_cpu_wakeup_irq()
- *
- * Function to set/clear per-CPU wake-up IRQs. Not protected by locking since
- * it might be used in code paths where normal cacheable locks are not
- * working. Locking must be provided by the caller to ensure atomicity.
+ * ve_spc_cpu_wakeup_irq() - sets/clears per-CPU wake-up IRQs
*
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
* @cpu: mpidr[7:0] bitfield describing cpu affinity level
* @set: if true, wake-up IRQs are set, if false they are cleared
+ *
+ * Function to set/clear per-CPU wake-up IRQs. Not protected by locking since
+ * it might be used in code paths where normal cacheable locks are not
+ * working. Locking must be provided by the caller to ensure atomicity.
*/
void ve_spc_cpu_wakeup_irq(u32 cluster, u32 cpu, bool set)
{
@@ -200,14 +200,14 @@ void ve_spc_set_resume_addr(u32 cluster, u32 cpu, u32 addr)
}
/**
- * ve_spc_powerdown()
+ * ve_spc_powerdown() - enables/disables cluster powerdown
+ *
+ * @cluster: mpidr[15:8] bitfield describing cluster affinity level
+ * @enable: if true enables powerdown, if false disables it
*
* Function to enable/disable cluster powerdown. Not protected by locking
* since it might be used in code paths where normal cacheable locks are not
* working. Locking must be provided by the caller to ensure atomicity.
- *
- * @cluster: mpidr[15:8] bitfield describing cluster affinity level
- * @enable: if true enables powerdown, if false disables it
*/
void ve_spc_powerdown(u32 cluster, bool enable)
{
@@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
}
/**
- * ve_spc_cpu_in_wfi()
+ * ve_spc_cpu_in_wfi() - Checks if the specified CPU is in WFI or not
*
* @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
--
2.35.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* [PATCH 2/2] ARM: vexpress/spc: Fix all the doxygen build warnings
@ 2022-04-04 13:02 ` Sudeep Holla
0 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-04 13:02 UTC (permalink / raw)
To: linux-arm-kernel, linux-kernel
Cc: Sudeep Holla, Liviu Dudau, Lorenzo Pieralisi, kernel test robot
There are more doxygen build warnings as below than the ones reported
by kernel test robot recently.
| arch/arm/mach-vexpress/spc.c:125: warning: missing initial short description on line:
| * ve_spc_global_wakeup_irq()
| arch/arm/mach-vexpress/spc.c:131: warning: contents before sections
| arch/arm/mach-vexpress/spc.c:148: warning: missing initial short description on line:
| * ve_spc_cpu_wakeup_irq()
| arch/arm/mach-vexpress/spc.c:154: warning: contents before sections
| arch/arm/mach-vexpress/spc.c:203: warning: missing initial short description on line:
| * ve_spc_powerdown()
| arch/arm/mach-vexpress/spc.c:209: warning: contents before sections
| arch/arm/mach-vexpress/spc.c:231: warning: missing initial short description on line:
| * ve_spc_cpu_in_wfi()
| 7 warnings
Fix all the warnings.
Cc: Liviu Dudau <liviu.dudau@arm.com>
Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
arch/arm/mach-vexpress/spc.c | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
index 8f99d47d4b89..6e6985e756af 100644
--- a/arch/arm/mach-vexpress/spc.c
+++ b/arch/arm/mach-vexpress/spc.c
@@ -122,13 +122,13 @@ static inline bool cluster_is_a15(u32 cluster)
}
/**
- * ve_spc_global_wakeup_irq()
+ * ve_spc_global_wakeup_irq() - sets/clears global wakeup IRQs
+ *
+ * @set: if true, global wake-up IRQs are set, if false they are cleared
*
* Function to set/clear global wakeup IRQs. Not protected by locking since
* it might be used in code paths where normal cacheable locks are not
* working. Locking must be provided by the caller to ensure atomicity.
- *
- * @set: if true, global wake-up IRQs are set, if false they are cleared
*/
void ve_spc_global_wakeup_irq(bool set)
{
@@ -145,15 +145,15 @@ void ve_spc_global_wakeup_irq(bool set)
}
/**
- * ve_spc_cpu_wakeup_irq()
- *
- * Function to set/clear per-CPU wake-up IRQs. Not protected by locking since
- * it might be used in code paths where normal cacheable locks are not
- * working. Locking must be provided by the caller to ensure atomicity.
+ * ve_spc_cpu_wakeup_irq() - sets/clears per-CPU wake-up IRQs
*
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
* @cpu: mpidr[7:0] bitfield describing cpu affinity level
* @set: if true, wake-up IRQs are set, if false they are cleared
+ *
+ * Function to set/clear per-CPU wake-up IRQs. Not protected by locking since
+ * it might be used in code paths where normal cacheable locks are not
+ * working. Locking must be provided by the caller to ensure atomicity.
*/
void ve_spc_cpu_wakeup_irq(u32 cluster, u32 cpu, bool set)
{
@@ -200,14 +200,14 @@ void ve_spc_set_resume_addr(u32 cluster, u32 cpu, u32 addr)
}
/**
- * ve_spc_powerdown()
+ * ve_spc_powerdown() - enables/disables cluster powerdown
+ *
+ * @cluster: mpidr[15:8] bitfield describing cluster affinity level
+ * @enable: if true enables powerdown, if false disables it
*
* Function to enable/disable cluster powerdown. Not protected by locking
* since it might be used in code paths where normal cacheable locks are not
* working. Locking must be provided by the caller to ensure atomicity.
- *
- * @cluster: mpidr[15:8] bitfield describing cluster affinity level
- * @enable: if true enables powerdown, if false disables it
*/
void ve_spc_powerdown(u32 cluster, bool enable)
{
@@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
}
/**
- * ve_spc_cpu_in_wfi()
+ * ve_spc_cpu_in_wfi() - Checks if the specified CPU is in WFI or not
*
* @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
--
2.35.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
2022-04-04 13:02 ` Sudeep Holla
@ 2022-04-05 0:21 ` Randy Dunlap
-1 siblings, 0 replies; 12+ messages in thread
From: Randy Dunlap @ 2022-04-05 0:21 UTC (permalink / raw)
To: Sudeep Holla, linux-arm-kernel, linux-kernel
Cc: Liviu Dudau, Lorenzo Pieralisi, kernel test robot
Hi--
On 4/4/22 06:02, Sudeep Holla wrote:
> Kbuild bot reported the following doxygen build warning:
>
> | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
> | '/**', but isn't a kernel-doc comment.
> | Refer Documentation/doc-guide/kernel-doc.rst
> | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>
> Fix the issue by dropping the parameters specified in the kernel doc.
>
> Cc: Liviu Dudau <liviu.dudau@arm.com>
> Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
> Reported-by: kernel test robot <lkp@intel.com>
> Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> ---
> arch/arm/mach-vexpress/spc.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
> index 1c6500c4e6a1..8f99d47d4b89 100644
> --- a/arch/arm/mach-vexpress/spc.c
> +++ b/arch/arm/mach-vexpress/spc.c
> @@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
> }
>
> /**
> - * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
> + * ve_spc_cpu_in_wfi()
This line still needs a "function short description," e.g.
+ * ve_spc_cpu_in_wfi() - fooble the barfloppity
similar to what you did in patch 2/2.
> *
> * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
> * @cluster: mpidr[15:8] bitfield describing cluster affinity level
and I would s/doxygen/kernel-doc/ for both patches.
thanks.
--
~Randy
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
@ 2022-04-05 0:21 ` Randy Dunlap
0 siblings, 0 replies; 12+ messages in thread
From: Randy Dunlap @ 2022-04-05 0:21 UTC (permalink / raw)
To: Sudeep Holla, linux-arm-kernel, linux-kernel
Cc: Liviu Dudau, Lorenzo Pieralisi, kernel test robot
Hi--
On 4/4/22 06:02, Sudeep Holla wrote:
> Kbuild bot reported the following doxygen build warning:
>
> | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
> | '/**', but isn't a kernel-doc comment.
> | Refer Documentation/doc-guide/kernel-doc.rst
> | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>
> Fix the issue by dropping the parameters specified in the kernel doc.
>
> Cc: Liviu Dudau <liviu.dudau@arm.com>
> Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
> Reported-by: kernel test robot <lkp@intel.com>
> Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> ---
> arch/arm/mach-vexpress/spc.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
> index 1c6500c4e6a1..8f99d47d4b89 100644
> --- a/arch/arm/mach-vexpress/spc.c
> +++ b/arch/arm/mach-vexpress/spc.c
> @@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
> }
>
> /**
> - * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
> + * ve_spc_cpu_in_wfi()
This line still needs a "function short description," e.g.
+ * ve_spc_cpu_in_wfi() - fooble the barfloppity
similar to what you did in patch 2/2.
> *
> * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
> * @cluster: mpidr[15:8] bitfield describing cluster affinity level
and I would s/doxygen/kernel-doc/ for both patches.
thanks.
--
~Randy
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
2022-04-05 0:21 ` Randy Dunlap
@ 2022-04-05 14:08 ` Sudeep Holla
-1 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-05 14:08 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-arm-kernel, linux-kernel, Liviu Dudau, Lorenzo Pieralisi,
kernel test robot
Hi Randy,
On Mon, Apr 04, 2022 at 05:21:39PM -0700, Randy Dunlap wrote:
> Hi--
>
> On 4/4/22 06:02, Sudeep Holla wrote:
> > Kbuild bot reported the following doxygen build warning:
> >
> > | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
> > | '/**', but isn't a kernel-doc comment.
> > | Refer Documentation/doc-guide/kernel-doc.rst
> > | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
> >
> > Fix the issue by dropping the parameters specified in the kernel doc.
> >
> > Cc: Liviu Dudau <liviu.dudau@arm.com>
> > Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
> > Reported-by: kernel test robot <lkp@intel.com>
> > Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
> > Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> > ---
> > arch/arm/mach-vexpress/spc.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
> > index 1c6500c4e6a1..8f99d47d4b89 100644
> > --- a/arch/arm/mach-vexpress/spc.c
> > +++ b/arch/arm/mach-vexpress/spc.c
> > @@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
> > }
> >
> > /**
> > - * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
> > + * ve_spc_cpu_in_wfi()
>
> This line still needs a "function short description," e.g.
>
> + * ve_spc_cpu_in_wfi() - fooble the barfloppity
>
> similar to what you did in patch 2/2.
I did this intentionally, I can move only this from the other patch.
Since I saw few others w/o description, I addressed all at once in the
second patch and just remove warning reported in this patch. I am fine
either way.
>
> > *
> > * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
> > * @cluster: mpidr[15:8] bitfield describing cluster affinity level
>
> and I would s/doxygen/kernel-doc/ for both patches.
>
Sure will do.
--
Regards,
Sudeep
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
@ 2022-04-05 14:08 ` Sudeep Holla
0 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-05 14:08 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-arm-kernel, linux-kernel, Liviu Dudau, Lorenzo Pieralisi,
kernel test robot
Hi Randy,
On Mon, Apr 04, 2022 at 05:21:39PM -0700, Randy Dunlap wrote:
> Hi--
>
> On 4/4/22 06:02, Sudeep Holla wrote:
> > Kbuild bot reported the following doxygen build warning:
> >
> > | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
> > | '/**', but isn't a kernel-doc comment.
> > | Refer Documentation/doc-guide/kernel-doc.rst
> > | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
> >
> > Fix the issue by dropping the parameters specified in the kernel doc.
> >
> > Cc: Liviu Dudau <liviu.dudau@arm.com>
> > Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
> > Reported-by: kernel test robot <lkp@intel.com>
> > Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
> > Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> > ---
> > arch/arm/mach-vexpress/spc.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
> > index 1c6500c4e6a1..8f99d47d4b89 100644
> > --- a/arch/arm/mach-vexpress/spc.c
> > +++ b/arch/arm/mach-vexpress/spc.c
> > @@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
> > }
> >
> > /**
> > - * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
> > + * ve_spc_cpu_in_wfi()
>
> This line still needs a "function short description," e.g.
>
> + * ve_spc_cpu_in_wfi() - fooble the barfloppity
>
> similar to what you did in patch 2/2.
I did this intentionally, I can move only this from the other patch.
Since I saw few others w/o description, I addressed all at once in the
second patch and just remove warning reported in this patch. I am fine
either way.
>
> > *
> > * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
> > * @cluster: mpidr[15:8] bitfield describing cluster affinity level
>
> and I would s/doxygen/kernel-doc/ for both patches.
>
Sure will do.
--
Regards,
Sudeep
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
2022-04-05 14:08 ` Sudeep Holla
@ 2022-04-05 14:54 ` Randy Dunlap
-1 siblings, 0 replies; 12+ messages in thread
From: Randy Dunlap @ 2022-04-05 14:54 UTC (permalink / raw)
To: Sudeep Holla
Cc: linux-arm-kernel, linux-kernel, Liviu Dudau, Lorenzo Pieralisi,
kernel test robot
On 4/5/22 07:08, Sudeep Holla wrote:
> Hi Randy,
>
> On Mon, Apr 04, 2022 at 05:21:39PM -0700, Randy Dunlap wrote:
>> Hi--
>>
>> On 4/4/22 06:02, Sudeep Holla wrote:
>>> Kbuild bot reported the following doxygen build warning:
>>>
>>> | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
>>> | '/**', but isn't a kernel-doc comment.
>>> | Refer Documentation/doc-guide/kernel-doc.rst
>>> | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>>>
>>> Fix the issue by dropping the parameters specified in the kernel doc.
>>>
>>> Cc: Liviu Dudau <liviu.dudau@arm.com>
>>> Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
>>> Reported-by: kernel test robot <lkp@intel.com>
>>> Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
>>> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
>>> ---
>>> arch/arm/mach-vexpress/spc.c | 2 +-
>>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
>>> index 1c6500c4e6a1..8f99d47d4b89 100644
>>> --- a/arch/arm/mach-vexpress/spc.c
>>> +++ b/arch/arm/mach-vexpress/spc.c
>>> @@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
>>> }
>>>
>>> /**
>>> - * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>>> + * ve_spc_cpu_in_wfi()
>>
>> This line still needs a "function short description," e.g.
>>
>> + * ve_spc_cpu_in_wfi() - fooble the barfloppity
>>
>> similar to what you did in patch 2/2.
>
> I did this intentionally, I can move only this from the other patch.
> Since I saw few others w/o description, I addressed all at once in the
> second patch and just remove warning reported in this patch. I am fine
> either way.
Oh, my bad. I didn't notice that it was the same function in
both patches.
So no problem there.
>>
>>> *
>>> * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
>>> * @cluster: mpidr[15:8] bitfield describing cluster affinity level
>>
>> and I would s/doxygen/kernel-doc/ for both patches.
>>
>
> Sure will do.
>
thanks.
--
~Randy
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
@ 2022-04-05 14:54 ` Randy Dunlap
0 siblings, 0 replies; 12+ messages in thread
From: Randy Dunlap @ 2022-04-05 14:54 UTC (permalink / raw)
To: Sudeep Holla
Cc: linux-arm-kernel, linux-kernel, Liviu Dudau, Lorenzo Pieralisi,
kernel test robot
On 4/5/22 07:08, Sudeep Holla wrote:
> Hi Randy,
>
> On Mon, Apr 04, 2022 at 05:21:39PM -0700, Randy Dunlap wrote:
>> Hi--
>>
>> On 4/4/22 06:02, Sudeep Holla wrote:
>>> Kbuild bot reported the following doxygen build warning:
>>>
>>> | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
>>> | '/**', but isn't a kernel-doc comment.
>>> | Refer Documentation/doc-guide/kernel-doc.rst
>>> | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>>>
>>> Fix the issue by dropping the parameters specified in the kernel doc.
>>>
>>> Cc: Liviu Dudau <liviu.dudau@arm.com>
>>> Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
>>> Reported-by: kernel test robot <lkp@intel.com>
>>> Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com
>>> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
>>> ---
>>> arch/arm/mach-vexpress/spc.c | 2 +-
>>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/arch/arm/mach-vexpress/spc.c b/arch/arm/mach-vexpress/spc.c
>>> index 1c6500c4e6a1..8f99d47d4b89 100644
>>> --- a/arch/arm/mach-vexpress/spc.c
>>> +++ b/arch/arm/mach-vexpress/spc.c
>>> @@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
>>> }
>>>
>>> /**
>>> - * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>>> + * ve_spc_cpu_in_wfi()
>>
>> This line still needs a "function short description," e.g.
>>
>> + * ve_spc_cpu_in_wfi() - fooble the barfloppity
>>
>> similar to what you did in patch 2/2.
>
> I did this intentionally, I can move only this from the other patch.
> Since I saw few others w/o description, I addressed all at once in the
> second patch and just remove warning reported in this patch. I am fine
> either way.
Oh, my bad. I didn't notice that it was the same function in
both patches.
So no problem there.
>>
>>> *
>>> * @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
>>> * @cluster: mpidr[15:8] bitfield describing cluster affinity level
>>
>> and I would s/doxygen/kernel-doc/ for both patches.
>>
>
> Sure will do.
>
thanks.
--
~Randy
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
2022-04-04 13:02 ` Sudeep Holla
@ 2022-04-07 10:15 ` Sudeep Holla
-1 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-07 10:15 UTC (permalink / raw)
To: linux-arm-kernel, Sudeep Holla, linux-kernel
Cc: Liviu Dudau, Lorenzo Pieralisi, kernel test robot
On Mon, 4 Apr 2022 14:02:06 +0100, Sudeep Holla wrote:
> Kbuild bot reported the following doxygen build warning:
>
> | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
> | '/**', but isn't a kernel-doc comment.
> | Refer Documentation/doc-guide/kernel-doc.rst
> | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>
> [...]
Applied to sudeep.holla/linux (fixes/vexpress) with
s/doxygen/kernel-doc/ as suggested by Randy
[1/2] ARM: vexpress/spc: Fix kernel-doc build warning for ve_spc_cpu_in_wfi
https://git.kernel.org/sudeep.holla/c/5063b7a80e
[2/2] ARM: vexpress/spc: Fix all the kernel-doc build warnings
https://git.kernel.org/sudeep.holla/c/42a997f0bd
--
Regards,
Sudeep
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
@ 2022-04-07 10:15 ` Sudeep Holla
0 siblings, 0 replies; 12+ messages in thread
From: Sudeep Holla @ 2022-04-07 10:15 UTC (permalink / raw)
To: linux-arm-kernel, Sudeep Holla, linux-kernel
Cc: Liviu Dudau, Lorenzo Pieralisi, kernel test robot
On Mon, 4 Apr 2022 14:02:06 +0100, Sudeep Holla wrote:
> Kbuild bot reported the following doxygen build warning:
>
> | arch/arm/mach-versatile/spc.c:231: warning: This comment starts with
> | '/**', but isn't a kernel-doc comment.
> | Refer Documentation/doc-guide/kernel-doc.rst
> | * ve_spc_cpu_in_wfi(u32 cpu, u32 cluster)
>
> [...]
Applied to sudeep.holla/linux (fixes/vexpress) with
s/doxygen/kernel-doc/ as suggested by Randy
[1/2] ARM: vexpress/spc: Fix kernel-doc build warning for ve_spc_cpu_in_wfi
https://git.kernel.org/sudeep.holla/c/5063b7a80e
[2/2] ARM: vexpress/spc: Fix all the kernel-doc build warnings
https://git.kernel.org/sudeep.holla/c/42a997f0bd
--
Regards,
Sudeep
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply [flat|nested] 12+ messages in thread