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

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

[Yang Li]

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@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 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

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

[Haris Iqbal]

On Thu, May 26, 2022 at 3:09 PM Yang Li <yang.lee@linux.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@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Reviewed-by: Md Haris Iqbal <haris.iqbal@ionos.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
>

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

[Jason Gunthorpe]

On Thu, May 26, 2022 at 09:09:45PM +0800, Yang Li 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@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  drivers/infiniband/ulp/rtrs/rtrs-clt.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Applied to for-next, thanks

Jason