linux-kernel - Re: [PATCH -next] bus/fsl-mc: fix doc warning

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] [day] [month] [year] [list]

Message-ID: <44f606cf-ef71-952f-eeb4-1d9f3ce20a67@nxp.com>
Date:   Mon, 7 Jun 2021 15:17:20 +0300
From:   Laurentiu Tudor <laurentiu.tudor@....com>
To:     ChenXiaoSong <chenxiaosong2@...wei.com>, stuyoder@...il.com
Cc:     linux-kernel@...r.kernel.org, yukuai3@...wei.com,
        yi.zhang@...wei.com
Subject: Re: [PATCH -next] bus/fsl-mc: fix doc warning

Hi,

On 6/7/2021 6:53 AM, ChenXiaoSong wrote:
> Fix gcc W=1 warning:
> 
> drivers/bus/fsl-mc/dprc.c:345: warning: Function parameter or member 'attr' not described in 'dprc_get_attributes'
> drivers/bus/fsl-mc/dprc.c:521: warning: Function parameter or member 'obj_type' not described in 'dprc_get_obj_region'
> 
> Signed-off-by: ChenXiaoSong <chenxiaosong2@...wei.com>
> ---
>  drivers/bus/fsl-mc/dprc.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/bus/fsl-mc/dprc.c b/drivers/bus/fsl-mc/dprc.c
> index 27b0a01bad9b..c862e9119b4d 100644
> --- a/drivers/bus/fsl-mc/dprc.c
> +++ b/drivers/bus/fsl-mc/dprc.c
> @@ -334,7 +334,7 @@ int dprc_clear_irq_status(struct fsl_mc_io *mc_io,
>   * @mc_io:	Pointer to MC portal's I/O object
>   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
>   * @token:	Token of DPRC object
> - * @attributes	Returned container attributes
> + * @attr	Returned container attributes
>   *
>   * Return:     '0' on Success; Error code otherwise.
>   */
> @@ -504,7 +504,7 @@ EXPORT_SYMBOL_GPL(dprc_set_obj_irq);
>   * @mc_io:	Pointer to MC portal's I/O object
>   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
>   * @token:	Token of DPRC object
> - * @obj_type;	Object type as returned in dprc_get_obj()
> + * @obj_type:	Object type as returned in dprc_get_obj()
>   * @obj_id:	Unique object instance as returned in dprc_get_obj()
>   * @region_index: The specific region to query
>   * @region_desc:  Returns the requested region descriptor
> 


Thanks for the patch. This was already submitted [1] as part of a larger
series [2] by Lee Jones.

[1] https://lore.kernel.org/patchwork/patch/1436378/
[2] https://lore.kernel.org/patchwork/cover/1436375/

---
Best Regards, Laurentiu