Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
Message-ID: <f28c49a8-4e5a-5601-4d0b-05d34024779f@infradead.org>
Date:   Tue, 8 Mar 2022 13:38:45 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.6.2
Subject: Re: [PATCH 4/6] fpga: fpga-mgr: Add missing kernel-doc description
Content-Language: en-US
To:     Nava kishore Manne <nava.manne@xilinx.com>, mdf@kernel.org,
        hao.wu@intel.com, yilun.xu@intel.com, trix@redhat.com,
        michal.simek@xilinx.com, linux-fpga@vger.kernel.org,
        linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org
References: <20220308094519.1816649-1-nava.manne@xilinx.com>
 <20220308094519.1816649-5-nava.manne@xilinx.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20220308094519.1816649-5-nava.manne@xilinx.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

Hi--

On 3/8/22 01:45, Nava kishore Manne wrote:
> Fixed the warnings: Function parameter or member 'xxx' not
> described.
> 
> Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
> ---
>  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..354789740529 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.

Not quite. Should be:

 * Return: foo bar blah

> + *
>   * 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.

ditto.

> + *
>   * This is the devres variant of fpga_mgr_register() for which the
>   * unregister function will be called automatically when the managing
>   * device is detached.

thanks.
-- 
~Randy