From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5C868C43219 for ; Wed, 6 Apr 2022 00:40:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1836954AbiDFAlC (ORCPT ); Tue, 5 Apr 2022 20:41:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59722 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1445217AbiDEPml (ORCPT ); Tue, 5 Apr 2022 11:42:41 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id E8C62191437 for ; Tue, 5 Apr 2022 07:08:05 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 9388C23A; Tue, 5 Apr 2022 07:08:05 -0700 (PDT) Received: from bogus (unknown [10.57.43.163]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 14E7D3F5A1; Tue, 5 Apr 2022 07:08:03 -0700 (PDT) Date: Tue, 5 Apr 2022 15:08:00 +0100 From: Sudeep Holla To: Randy Dunlap Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Liviu Dudau , Lorenzo Pieralisi , kernel test robot Subject: Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments Message-ID: <20220405140800.baww2wrow3hdp5ho@bogus> References: <20220404130207.1162445-1-sudeep.holla@arm.com> <008aae79-4a6c-721f-7ef5-7b73f6d7e000@infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <008aae79-4a6c-721f-7ef5-7b73f6d7e000@infradead.org> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > > Cc: Lorenzo Pieralisi > > Reported-by: kernel test robot > > Link: https://lore.kernel.org/linux-doc/202204031026.4ogKxt89-lkp@intel.com > > Signed-off-by: Sudeep Holla > > --- > > 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