Skip to content

infiniband kernel-doc fixes & driver-api/ chapter

[email protected] linux-doc linux-rdma oe-kbuild-all 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest12 patches 12 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/12infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notationdrivers/infiniband/ulp/iser/iscsi_iser.c drivers/infiniband/ulp/iser/iscsi_iser.h+5 -50 replies
2/12infiniband: fix core/ipwm_util.h kernel-doc warningsdrivers/infiniband/core/iwpm_util.h+4 -10 replies
3/12infiniband: fix ulp/iser/iscsi_iser.h kernel-doc warningsdrivers/infiniband/ulp/iser/iscsi_iser.h+11 -70 replies
4/12infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notationdrivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h+4 -40 replies
5/12infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notationdrivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h+41 -14 replies
6/12infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notationdrivers/infiniband/ulp/srpt/ib_srpt.h+2 -52 replies
7/12infiniband: fix core/verbs.c kernel-doc notationdrivers/infiniband/core/verbs.c+2 -00 replies
8/12infiniband: fix ulp/iser/iser_verbs.c kernel-doc notationdrivers/infiniband/ulp/iser/iser_verbs.c+38 -220 replies
9/12infiniband: fix ulp/iser/iser_initiator.c kernel-doc warningsdrivers/infiniband/ulp/iser/iser_initiator.c+5 -00 replies
10/12infiniband: fix core/ kernel-doc notationdrivers/infiniband/core/device.c drivers/infiniband/core/sa_query.c+12 -130 replies
11/12infiniband: fix sw/rdmavt/ kernel-doc notationdrivers/infiniband/sw/rdmavt/ah.c drivers/infiniband/sw/rdmavt/cq.c drivers/infiniband/sw/rdmavt/qp.c +1 more+17 -190 replies
12/12infiniband: add a Documentation driver-api chapter for InfinibandDocumentation/driver-api/index.rst Documentation/driver-api/infiniband.rst+128 -02 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter

This patch series cleans up lots of kernel-doc in drivers/infiniband/ and then adds an infiniband.rst file.

It also changes a few instances of non-exported functions from kernel-doc notation back to non-kernel-doc comments.

There are still a few kernel-doc and Sphinx warnings that I don't know how to resolve:

../drivers/infiniband/ulp/iser/iscsi_iser.h:401: warning: Function parameter or member 'all_list' not described in 'iser_fr_desc' ../drivers/infiniband/ulp/iser/iscsi_iser.h:415: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool' ../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation. ../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent. ../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.

I have not added any Fixes: tags to these patches because I don't think that they need to be applied to any stable releases...

 Documentation/driver-api/index.rst                  |    1 
 Documentation/driver-api/infiniband.rst             |  127 ++++++++++
 drivers/infiniband/core/device.c                    |   23 -
 drivers/infiniband/core/iwpm_util.h                 |    5 
 drivers/infiniband/core/sa_query.c                  |    2 
 drivers/infiniband/core/verbs.c                     |    2 
 drivers/infiniband/sw/rdmavt/ah.c                   |    1 
 drivers/infiniband/sw/rdmavt/cq.c                   |    2 
 drivers/infiniband/sw/rdmavt/qp.c                   |   30 +-
 drivers/infiniband/sw/rdmavt/vt.c                   |    3 
 drivers/infiniband/ulp/iser/iscsi_iser.c            |    2 
 drivers/infiniband/ulp/iser/iscsi_iser.h            |   26 +-
 drivers/infiniband/ulp/iser/iser_initiator.c        |    5 
 drivers/infiniband/ulp/iser/iser_verbs.c            |   60 ++--
 drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h    |   42 +++
 drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h |    8 
 drivers/infiniband/ulp/srpt/ib_srpt.h               |    7 
 17 files changed, 269 insertions(+), 77 deletions(-)