RDMA/rtrs-clt: Fix one kernel-doc comment
Subsystems (2)
PATCH 1/1 RDMA/rtrs-clt: Fix one kernel-doc comment
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'
--- drivers/infiniband/ulp/rtrs/rtrs-clt.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/infiniband/ulp/rtrs/rtrs-clt.c +1 -1
@@ -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
Signature · 1 line
2.20.1.7.g153144c
Quoted 5 lines · Yang Li
Add the description of @pathname and remove @sessname in
rtrs_clt_open()kernel-doc comment to remove warnings found by runningscripts/kernel-doc, which is caused by using 'make W=1'.
Quoted 7 lines
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 <[email protected]>Signed-off-by Yang Li <[email protected]>
Thanks
Quoted 20 lines
--- drivers/infiniband/ulp/rtrs/rtrs-clt.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/infiniband/ulp/rtrs/rtrs-clt.c +1
-2@@ -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
Quoted 9 lines · Yang Li
Add the description of @pathname and remove @sessname in
rtrs_clt_open()kernel-doc comment to remove warnings found by runningscripts/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'
Quoted 5 lines
Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>--- drivers/infiniband/ulp/rtrs/rtrs-clt.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Applied to for-next, thanks
Jason