| Message ID | 20220404130207.1162445-1-sudeep.holla@arm.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/2] ARM: vexpress/spc: Fix doxygen comments | expand |
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.
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.
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.
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
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
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(-)