linux-kernel - Re: [PATCH v2 3/5] fpga: fpga-mgr: Add missing kernel-doc description

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: <1ae23c94-ff10-5033-b3aa-75ec5b755a97@redhat.com>
Date:   Sat, 26 Mar 2022 10:06:16 -0700
From:   Tom Rix <trix@...hat.com>
To:     Nava kishore Manne <nava.manne@...inx.com>, mdf@...nel.org,
        hao.wu@...el.com, yilun.xu@...el.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 v2 3/5] fpga: fpga-mgr: Add missing kernel-doc description


On 3/22/22 1:22 AM, Nava kishore Manne wrote:
> Fixed the warnings: Function parameter or member 'xxx' not
> described.

How were the warnings generated ?

Tom

>
> Signed-off-by: Nava kishore Manne <nava.manne@...inx.com>
> ---
> Changes for v2:
> 		-Replaced s/@...urn:/Return:/
>
>   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.