From: Randy Dunlap <rdunlap@infradead.org>
To: Sudeep Holla <sudeep.holla@arm.com>,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org
Cc: Liviu Dudau <liviu.dudau@arm.com>,
Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
kernel test robot <lkp@intel.com>
Subject: Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
Date: Mon, 4 Apr 2022 17:21:39 -0700 [thread overview]
Message-ID: <008aae79-4a6c-721f-7ef5-7b73f6d7e000@infradead.org> (raw)
In-Reply-To: <20220404130207.1162445-1-sudeep.holla@arm.com>
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
WARNING: multiple messages have this Message-ID (diff)
From: Randy Dunlap <rdunlap@infradead.org>
To: Sudeep Holla <sudeep.holla@arm.com>,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org
Cc: Liviu Dudau <liviu.dudau@arm.com>,
Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
kernel test robot <lkp@intel.com>
Subject: Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
Date: Mon, 4 Apr 2022 17:21:39 -0700 [thread overview]
Message-ID: <008aae79-4a6c-721f-7ef5-7b73f6d7e000@infradead.org> (raw)
In-Reply-To: <20220404130207.1162445-1-sudeep.holla@arm.com>
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
next prev parent reply other threads:[~2022-04-05 0:23 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-04 13:02 [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments Sudeep Holla
2022-04-04 13:02 ` Sudeep Holla
2022-04-04 13:02 ` [PATCH 2/2] ARM: vexpress/spc: Fix all the doxygen build warnings Sudeep Holla
2022-04-04 13:02 ` Sudeep Holla
2022-04-05 0:21 ` Randy Dunlap [this message]
2022-04-05 0:21 ` [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments Randy Dunlap
2022-04-05 14:08 ` Sudeep Holla
2022-04-05 14:08 ` Sudeep Holla
2022-04-05 14:54 ` Randy Dunlap
2022-04-05 14:54 ` Randy Dunlap
2022-04-07 10:15 ` Sudeep Holla
2022-04-07 10:15 ` Sudeep Holla
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=008aae79-4a6c-721f-7ef5-7b73f6d7e000@infradead.org \
--to=rdunlap@infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=liviu.dudau@arm.com \
--cc=lkp@intel.com \
--cc=lorenzo.pieralisi@arm.com \
--cc=sudeep.holla@arm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.