linux-kernel - Re: [PATCH -next] RDMA/rtrs-clt: Fix one kernel-doc comment

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: <CAJpMwyhG152M9iLWRwLk5ewijj7gzE9rTmv2KFCZODbxLRCcFQ@mail.gmail.com>
Date:   Thu, 26 May 2022 15:53:01 +0200
From:   Haris Iqbal <haris.iqbal@...os.com>
To:     Yang Li <yang.lee@...ux.alibaba.com>
Cc:     jinpu.wang@...os.com, jgg@...pe.ca, leon@...nel.org,
        linux-rdma@...r.kernel.org, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] RDMA/rtrs-clt: Fix one kernel-doc comment

On Thu, May 26, 2022 at 3:09 PM Yang Li <yang.lee@...ux.alibaba.com> wrote:
>
> Add the description of @pathname and remove @sessname in rtrs_clt_open()
> kernel-doc comment to remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
>
> drivers/infiniband/ulp/rtrs/rtrs-clt.c:2809: warning: Function parameter
> or member 'pathname' not described in 'rtrs_clt_open'
> drivers/infiniband/ulp/rtrs/rtrs-clt.c:2809: warning: Excess function
> parameter 'sessname' description in 'rtrs_clt_open'
>
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
Reviewed-by: Md Haris Iqbal <haris.iqbal@...os.com>

Thanks

> ---
>  drivers/infiniband/ulp/rtrs/rtrs-clt.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/infiniband/ulp/rtrs/rtrs-clt.c b/drivers/infiniband/ulp/rtrs/rtrs-clt.c
> index c2c860d0c56e..9809c3883979 100644
> --- a/drivers/infiniband/ulp/rtrs/rtrs-clt.c
> +++ b/drivers/infiniband/ulp/rtrs/rtrs-clt.c
> @@ -2785,7 +2785,7 @@ static void free_clt(struct rtrs_clt_sess *clt)
>  /**
>   * rtrs_clt_open() - Open a path to an RTRS server
>   * @ops: holds the link event callback and the private pointer.
> - * @sessname: name of the session
> + * @pathname: name of the path to an RTRS server
>   * @paths: Paths to be established defined by their src and dst addresses
>   * @paths_num: Number of elements in the @paths array
>   * @port: port to be used by the RTRS session
> --
> 2.20.1.7.g153144c
>