linux-kernel - Re: [PATCH v4 3/5] fpga: fpga-mgr: fix kernel-doc warnings

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: <20220416165301.GG301222@yilunxu-OptiPlex-7050>
Date:   Sun, 17 Apr 2022 00:53:01 +0800
From:   Xu Yilun <yilun.xu@...el.com>
To:     Nava kishore Manne <nava.manne@...inx.com>
Cc:     mdf@...nel.org, hao.wu@...el.com, trix@...hat.com,
        michal.simek@...inx.com, linux-fpga@...r.kernel.org,
        linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
        git@...inx.com
Subject: Re: [PATCH v4 3/5] fpga: fpga-mgr: fix kernel-doc warnings

On Sat, Apr 16, 2022 at 07:07:17PM +0530, Nava kishore Manne wrote:
> warnings: No description found for return value of 'xxx'
> 
> In-order to fix the above kernel-doc warnings added the
> 'Return' description for 'devm_fpga_mgr_register_full()'
> and 'devm_fpga_mgr_register()' API's.

                                 APIs.

> 
> Signed-off-by: Nava kishore Manne <nava.manne@...inx.com>

With the minor fix, please add my Acked-by.

Acked-by: Xu Yilun <yilun.xu@...el.com>

> ---
> Changes for v2:
>                 -Replaced s/@...urn:/Return:/
> Changes for v3:
>                -Updated commit description.
> Changes for v4:
>                -Updated commit description.
> 
>  drivers/fpga/fpga-mgr.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
> index a699cc8e2fa6..0f2b28538f17 100644
> --- a/drivers/fpga/fpga-mgr.c
> +++ b/drivers/fpga/fpga-mgr.c
> @@ -730,6 +730,8 @@ static void devm_fpga_mgr_unregister(struct device *dev, void *res)
>   * @parent:	fpga manager device from pdev
>   * @info:	parameters for fpga manager
>   *
> + * Return:  fpga manager pointer on success, negative error code otherwise.
> + *
>   * This is the devres variant of fpga_mgr_register_full() for which the unregister
>   * function will be called automatically when the managing device is detached.
>   */
> @@ -763,6 +765,8 @@ EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full);
>   * @mops:	pointer to structure of fpga manager ops
>   * @priv:	fpga manager private data
>   *
> + * Return:  fpga manager pointer on success, negative error code otherwise.
> + *
>   * This is the devres variant of fpga_mgr_register() for which the
>   * unregister function will be called automatically when the managing
>   * device is detached.
> -- 
> 2.25.1