RDMA/restrack: update kernel documentation for ib_create_named_qp()
Subsystems (3)
PATCH 1/1 RDMA/restrack: update kernel documentation for ib_create_named_qp()
Commit 66f57b871efc ("RDMA/restrack: Support all QP types") extends ib_create_qp() to a named ib_create_named_qp(), which takes the caller's name as argument, but it did not add the new argument description to the function's kerneldoc.
make htmldocs warns:
./drivers/infiniband/core/verbs.c:1206: warning: Function parameter or member 'caller' not described in 'ib_create_named_qp'
Add a description for this new argument based on the description of the same argument in other related functions.
---
applies on next-20201207
Doug, Jason, Leon, please pick this minor doc fix on your -next tree.
drivers/infiniband/core/verbs.c | 1 + 1 file changed, 1 insertion(+)
drivers/infiniband/core/verbs.c +1 -0
@@ -1197,6 +1197,7 @@ static struct ib_qp *create_xrc_qp_user(struct ib_qp *qp,* @qp_init_attr: A list of initial attributes required to create the * QP. If QP creation succeeds, then the attributes are updated to * the actual capabilities of the created QP. +* @caller: caller's build-time module name * * NOTE: for user qp use ib_create_qp_user with valid udata! */
Signature · 1 line
2.17.1
Quoted 7 lines · Lukas Bulwahn
Commit
66f57b871efc("RDMA/restrack: Support all QP types") extendsib_create_qp()to a namedib_create_named_qp(), which takes the caller's name as argument, but it did not add the new argument description to the function's kerneldoc.make htmldocs warns:
Quoted 8 lines
./drivers/infiniband/core/verbs.c:1206: warning: Function parameter or member 'caller' not described in 'ib_create_named_qp'Add a description for this new argument based on the description of the same argument in other related functions.
Signed-off-by Lukas Bulwahn <[email protected]>---
Thanks,
Jason Gunthorpe
maintainerQuoted 10 lines · Lukas Bulwahn
Commit
66f57b871efc("RDMA/restrack: Support all QP types") extendsib_create_qp()to a namedib_create_named_qp(), which takes the caller's name as argument, but it did not add the new argument description to the function's kerneldoc.make htmldocs warns:
./drivers/infiniband/core/verbs.c:1206: warning: Function parameter or member 'caller' not described in 'ib_create_named_qp'
Quoted 8 lines
Add a description for this new argument based on the description of the same argument in other related functions.
Signed-off-by Lukas Bulwahn <[email protected]>Reviewed-by Leon Romanovsky <[email protected]>--- drivers/infiniband/core/verbs.c | 1 + 1 file changed, 1 insertion(+)
Applies to for-next, thanks
Jason