Messages in this thread | ![/](/images/icornerl.gif) | | Date | Mon, 4 Apr 2022 17:21:39 -0700 | Subject | Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments | From | Randy Dunlap <> |
| |
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
| ![\](/images/icornerr.gif) |