linux-kernel - Re: [PATCH] fpga: dfl: fme: fix kernel-doc comments for some functions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Zgt/wftzm4xthfio@yilunxu-OptiPlex-7050>
Date: Tue, 2 Apr 2024 11:47:13 +0800
From: Xu Yilun <yilun.xu@...ux.intel.com>
To: Peter Colberg <peter.colberg@...el.com>
Cc: Wu Hao <hao.wu@...el.com>, Tom Rix <trix@...hat.com>,
	Moritz Fischer <mdf@...nel.org>, Xu Yilun <yilun.xu@...el.com>,
	Alan Tull <atull@...nel.org>, Shiva Rao <shiva.rao@...el.com>,
	Kang Luwei <luwei.kang@...el.com>,
	Enno Luebbers <enno.luebbers@...el.com>, linux-fpga@...r.kernel.org,
	linux-kernel@...r.kernel.org, Russ Weight <russ.weight@...ux.dev>,
	Marco Pagani <marpagan@...hat.com>,
	Matthew Gerlach <matthew.gerlach@...ux.intel.com>,
	kernel test robot <lkp@...el.com>
Subject: Re: [PATCH] fpga: dfl: fme: fix kernel-doc comments for some
 functions

On Thu, Mar 28, 2024 at 08:15:42PM -0400, Peter Colberg wrote:
> From: Xu Yilun <yilun.xu@...el.com>

I didn't remember I wrote this exact patch, but anyway the patch itself
is confusing.

> 
> lkp reported 2 build warnings:
> 
>    drivers/fpga/dfl/dfl-fme-pr.c:175: warning: Function parameter or member 'feature' not described in 'dfl_fme_create_mgr'
> 
> >> drivers/fpga/dfl/dfl-fme-pr.c:280: warning: expecting prototype for
> >> dfl_fme_destroy_bridge(). Prototype was for dfl_fme_destroy_bridges()
> >> instead
> 
> Fixes: 29de76240e86 ("fpga: dfl: fme: add partial reconfiguration sub feature support")
> Reported-by: kernel test robot <lkp@...el.com>
> Signed-off-by: Xu Yilun <yilun.xu@...el.com>
> Signed-off-by: Peter Colberg <peter.colberg@...el.com>
> ---
>  drivers/fpga/dfl-fme-pr.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/fpga/dfl-fme-pr.c b/drivers/fpga/dfl-fme-pr.c
> index cdcf6dea4cc9..96cb24787ab1 100644
> --- a/drivers/fpga/dfl-fme-pr.c
> +++ b/drivers/fpga/dfl-fme-pr.c
> @@ -166,6 +166,7 @@ static int fme_pr(struct platform_device *pdev, unsigned long arg)
>   * dfl_fme_create_mgr - create fpga mgr platform device as child device
>   * @feature: sub feature info

The member 'feature' is described here. It still causes build warning?

>   * @pdata: fme platform_device's pdata
> + * @feature: the dfl fme PR sub feature

Why adding a duplicated item would fix the warning?

>   *
>   * Return: mgr platform device if successful, and error code otherwise.
>   */
> @@ -273,7 +274,7 @@ static void dfl_fme_destroy_bridge(struct dfl_fme_bridge *fme_br)
>  }
>  
>  /**
> - * dfl_fme_destroy_bridges - destroy all fpga bridge platform device

The prototype is for dfl_fme_destroy_bridges(), why the warning?

> + * dfl_fme_destroy_bridges - destroy all fpga bridge platform devices

Correct the plural form in description would fix the warning?

>   * @pdata: fme platform device's pdata
>   */
>  static void dfl_fme_destroy_bridges(struct dfl_feature_platform_data *pdata)
> -- 
> 2.44.0
> 
>