Make reserved struct fields "private:" so that they don't need to
be added to the kernel-doc notation. This removes 24 warnings.
Remove "[]" in one struct field description to that kernel-doc
won't be confused.
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:148: warning: Function
parameter
Remove kernel-doc notation on 4 structs since they are internal and
none of the struct fields/members are described.
This removes 45 kernel-doc warnings.
Signed-off-by: Randy Dunlap
Cc: Randy Dunlap
Cc: Doug Ledford
Cc: Jason Gunthorpe
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/
Fix kernel-doc warnings and typos/spellos.
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or
member 'dma_addr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or
member 'cqe' not described in 'iser_tx_desc
Fix kernel-doc warnings and expected formatting.
../drivers/infiniband/core/iwpm_util.h:219: warning: Function parameter or
member 'a_sockaddr' not described in 'iwpm_compare_sockaddr'
../drivers/infiniband/core/iwpm_util.h:219: warning: Function parameter or
member 'b_sockaddr' not described in
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
Fix struct name in kernel-doc notation to match the struct name below it.
Fix one typo (spello).
Fix formatting as expected for kernel-doc notation.
Fix parameter name to match the function's parameter name to eliminate a
kernel-doc warning.
../drivers/infiniband/ulp/iser/iscsi_iser.c:815: warning
Fix kernel-doc warnings (typos or renames) in ib_srpt.h:
../drivers/infiniband/ulp/srpt/ib_srpt.h:419: warning: Function parameter or
member 'port_guid_id' not described in 'srpt_port'
../drivers/infiniband/ulp/srpt/ib_srpt.h:419: warning: Function parameter or
member 'port_gid_id' not described
Correct function parameter names (typos or renames).
Add kernel-doc notation for missing function parameters.
../drivers/infiniband/core/sa_query.c:1263: warning: Function parameter or
member 'gid_attr' not described in 'ib_init_ah_attr_from_path'
../drivers/infiniband/core/sa_query.c:1263: warni
Various kernel-doc fixes:
- fix typos
- don't use /** for internal structs or functions
- fix Return: kernel-doc formatting
- add kernel-doc notation for missing function parameters
../drivers/infiniband/ulp/iser/iser_verbs.c:159: warning: Function parameter or
member 'ib_conn' not described in
Add kernel-doc notation for missing function parameters:
../drivers/infiniband/ulp/iser/iser_initiator.c:365: warning: Function
parameter or member 'conn' not described in 'iser_send_command'
../drivers/infiniband/ulp/iser/iser_initiator.c:365: warning: Function
parameter or member 'task' not de
Add missing function parameter descriptions:
../drivers/infiniband/core/verbs.c:257: warning: Function parameter or member
'flags' not described in '__ib_alloc_pd'
../drivers/infiniband/core/verbs.c:257: warning: Function parameter or member
'caller' not described in '__ib_alloc_pd'
Signed-off-
Add kernel-doc for missing function parameters.
Remove excess kernel-doc descriptions.
Fix expected kernel-doc formatting (use ':' instead of '-' after @funcarg).
../drivers/infiniband/sw/rdmavt/ah.c:138: warning: Excess function parameter
'udata' description in 'rvt_destroy_ah'
../drivers/infini
Add a driver-api chapter for InfiniBand interfaces.
Signed-off-by: Randy Dunlap
Cc: Randy Dunlap
Cc: Doug Ledford
Cc: Jason Gunthorpe
Cc: linux-doc@vger.kernel.org
---
Documentation/driver-api/index.rst |1
Documentation/driver-api/infiniband.rst | 127 ++
2 fil
13 matches
Mail list logo
