Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
Message-ID: <008aae79-4a6c-721f-7ef5-7b73f6d7e000@infradead.org>
Date:   Mon, 4 Apr 2022 17:21:39 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.7.0
Subject: Re: [PATCH 1/2] ARM: vexpress/spc: Fix doxygen comments
Content-Language: en-US
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>
References: <20220404130207.1162445-1-sudeep.holla@arm.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20220404130207.1162445-1-sudeep.holla@arm.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

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