* [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter
@ 2019-10-10 3:52 rd.dunlab
2019-10-10 3:52 ` [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation rd.dunlab
` (12 more replies)
0 siblings, 13 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
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(-)
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 02/12] infiniband: fix core/ipwm_util.h kernel-doc warnings rd.dunlab
` (11 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 006-iband-iser-iscsi-iser-kerndoc.patch --]
[-- Type: text/plain, Size: 2497 bytes --]
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: Function parameter or member 'non_blocking' not described in 'iscsi_iser_ep_connect'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/iser/iscsi_iser.c | 2 +-
drivers/infiniband/ulp/iser/iscsi_iser.h | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/ulp/iser/iscsi_iser.h
+++ linux-next-20191009/drivers/infiniband/ulp/iser/iscsi_iser.h
@@ -311,7 +311,7 @@ struct iser_comp {
};
/**
- * struct iser_device - Memory registration operations
+ * struct iser_reg_ops - Memory registration operations
* per-device registration schemes
*
* @alloc_reg_res: Allocate registration resources
@@ -365,7 +365,7 @@ struct iser_device {
};
/**
- * struct iser_reg_resources - Fast registration recources
+ * struct iser_reg_resources - Fast registration resources
*
* @mr: memory region
* @fmr_pool: pool of fmrs
@@ -398,7 +398,7 @@ struct iser_fr_desc {
};
/**
- * struct iser_fr_pool: connection fast registration pool
+ * struct iser_fr_pool - connection fast registration pool
*
* @list: list of fastreg descriptors
* @lock: protects fmr/fastreg pool
@@ -521,7 +521,7 @@ struct iser_page_vec {
};
/**
- * struct iser_global: iSER global context
+ * struct iser_global - iSER global context
*
* @device_list_mutex: protects device_list
* @device_list: iser devices global list
--- linux-next-20191009.orig/drivers/infiniband/ulp/iser/iscsi_iser.c
+++ linux-next-20191009/drivers/infiniband/ulp/iser/iscsi_iser.c
@@ -786,7 +786,7 @@ static int iscsi_iser_get_ep_param(struc
* iscsi_iser_ep_connect() - Initiate iSER connection establishment
* @shost: scsi_host
* @dst_addr: destination address
- * @non-blocking: indicate if routine can block
+ * @non_blocking: indicate if routine can block
*
* Allocate an iscsi endpoint, an iser_conn structure and bind them.
* After that start RDMA connection establishment via rdma_cm. We
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 02/12] infiniband: fix core/ipwm_util.h kernel-doc warnings
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
2019-10-10 3:52 ` [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 03/12] infiniband: fix ulp/iser/iscsi_iser.h " rd.dunlab
` (10 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 007-iband-core-hdr001.patch --]
[-- Type: text/plain, Size: 1633 bytes --]
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 'iwpm_compare_sockaddr'
../drivers/infiniband/core/iwpm_util.h:280: warning: Function parameter or member 'iwpm_pid' not described in 'iwpm_send_hello'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/core/iwpm_util.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
--- linux-next-20191009.orig/drivers/infiniband/core/iwpm_util.h
+++ linux-next-20191009/drivers/infiniband/core/iwpm_util.h
@@ -210,8 +210,10 @@ int iwpm_mapinfo_available(void);
/**
* iwpm_compare_sockaddr - Compare two sockaddr storage structs
+ * @a_sockaddr: first sockaddr to compare
+ * @b_sockaddr: second sockaddr to compare
*
- * Returns 0 if they are holding the same ip/tcp address info,
+ * Return: 0 if they are holding the same ip/tcp address info,
* otherwise returns 1
*/
int iwpm_compare_sockaddr(struct sockaddr_storage *a_sockaddr,
@@ -272,6 +274,7 @@ void iwpm_print_sockaddr(struct sockaddr
* iwpm_send_hello - Send hello response to iwpmd
*
* @nl_client: The index of the netlink client
+ * @iwpm_pid: The pid of the user space port mapper
* @abi_version: The kernel's abi_version
*
* Returns 0 on success or a negative error code
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 03/12] infiniband: fix ulp/iser/iscsi_iser.h kernel-doc warnings
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
2019-10-10 3:52 ` [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation rd.dunlab
2019-10-10 3:52 ` [PATCH 02/12] infiniband: fix core/ipwm_util.h kernel-doc warnings rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 04/12] infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notation rd.dunlab
` (9 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 008-iband-iscsi-iserhdr.patch --]
[-- Type: text/plain, Size: 5098 bytes --]
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'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'reg_wr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'send_wr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:254: warning: Function parameter or member 'inv_wr' not described in 'iser_tx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:277: warning: Function parameter or member 'cqe' not described in 'iser_rx_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:296: warning: Function parameter or member 'rsp' not described in 'iser_login_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:339: warning: Function parameter or member 'reg_mem' not described in 'iser_reg_ops'
../drivers/infiniband/ulp/iser/iscsi_iser.h:399: warning: Function parameter or member 'all_list' not described in 'iser_fr_desc'
../drivers/infiniband/ulp/iser/iscsi_iser.h:413: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool'
../drivers/infiniband/ulp/iser/iscsi_iser.h:439: warning: Function parameter or member 'reg_cqe' not described in 'ib_conn'
../drivers/infiniband/ulp/iser/iscsi_iser.h:491: warning: Function parameter or member 'snd_w_inv' not described in 'iser_conn'
This leaves 2 "member not described" warnings that I don't know how to fix:
../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'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/iser/iscsi_iser.h | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/ulp/iser/iscsi_iser.h
+++ linux-next-20191009/drivers/infiniband/ulp/iser/iscsi_iser.h
@@ -228,15 +228,16 @@ enum iser_desc_type {
* @iser_header: iser header
* @iscsi_header: iscsi header
* @type: command/control/dataout
- * @dam_addr: header buffer dma_address
+ * @dma_addr: header buffer dma_address
* @tx_sg: sg[0] points to iser/iscsi headers
* sg[1] optionally points to either of immediate data
* unsolicited data-out or control
* @num_sge: number sges used on this TX task
+ * @cqe: completion handler
* @mapped: Is the task header mapped
- * reg_wr: registration WR
- * send_wr: send WR
- * inv_wr: invalidate WR
+ * @reg_wr: registration WR
+ * @send_wr: send WR
+ * @inv_wr: invalidate WR
*/
struct iser_tx_desc {
struct iser_ctrl iser_header;
@@ -263,6 +264,7 @@ struct iser_tx_desc {
* @data: received data segment
* @dma_addr: receive buffer dma address
* @rx_sg: ib_sge of receive buffer
+ * @cqe: completion handler
* @pad: for sense data TODO: Modify to maximum sense length supported
*/
struct iser_rx_desc {
@@ -279,9 +281,9 @@ struct iser_rx_desc {
* struct iser_login_desc - iSER login descriptor
*
* @req: pointer to login request buffer
- * @resp: pointer to login response buffer
+ * @rsp: pointer to login response buffer
* @req_dma: DMA address of login request buffer
- * @rsp_dma: DMA address of login response buffer
+ * @rsp_dma: DMA address of login response buffer
* @sge: IB sge for login post recv
* @cqe: completion handler
*/
@@ -316,7 +318,7 @@ struct iser_comp {
*
* @alloc_reg_res: Allocate registration resources
* @free_reg_res: Free registration resources
- * @fast_reg_mem: Register memory buffers
+ * @reg_mem: Register memory buffers
* @unreg_mem: Un-register memory buffers
* @reg_desc_get: Get a registration descriptor for pool
* @reg_desc_put: Get a registration descriptor to pool
@@ -423,6 +425,7 @@ struct iser_fr_pool {
* @comp: iser completion context
* @fr_pool: connection fast registration poool
* @pi_support: Indicate device T10-PI support
+ * @reg_cqe: completion handler
*/
struct ib_conn {
struct rdma_cm_id *cma_id;
@@ -463,6 +466,7 @@ struct ib_conn {
* @num_rx_descs: number of rx descriptors
* @scsi_sg_tablesize: scsi host sg_tablesize
* @pages_per_mr: maximum pages available for registration
+ * @snd_w_inv: connection uses remote invalidation
*/
struct iser_conn {
struct ib_conn ib_conn;
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 04/12] infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (2 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 03/12] infiniband: fix ulp/iser/iscsi_iser.h " rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h " rd.dunlab
` (8 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 009-iband-opa-vnic-internalhdr.patch --]
[-- Type: text/plain, Size: 1444 bytes --]
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 <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h
+++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h
@@ -70,7 +70,7 @@
struct opa_vnic_adapter;
-/**
+/*
* struct __opa_vesw_info - OPA vnic virtual switch info
*
* Same as opa_vesw_info without bitwise attribute.
@@ -96,7 +96,7 @@ struct __opa_vesw_info {
u8 rsvd4[2];
} __packed;
-/**
+/*
* struct __opa_per_veswport_info - OPA vnic per port info
*
* Same as opa_per_veswport_info without bitwise attribute.
@@ -136,7 +136,7 @@ struct __opa_per_veswport_info {
u8 rsvd3[8];
} __packed;
-/**
+/*
* struct __opa_veswport_info - OPA vnic port info
*
* Same as opa_veswport_info without bitwise attribute.
@@ -146,7 +146,7 @@ struct __opa_veswport_info {
struct __opa_per_veswport_info vport;
};
-/**
+/*
* struct __opa_veswport_trap - OPA vnic trap info
*
* Same as opa_veswport_trap without bitwise attribute.
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (3 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 04/12] infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notation rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-22 17:52 ` Jason Gunthorpe
2019-10-10 3:52 ` [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h " rd.dunlab
` (7 subsequent siblings)
12 siblings, 1 reply; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 010-iband-opa-vnic-encaphdr.patch --]
[-- Type: text/plain, Size: 5332 bytes --]
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 or member 'rsvd0' not described in 'opa_vesw_info' [5 rsvd members]
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:205: warning: Function parameter or member 'rsvd0' not described in 'opa_per_veswport_info' [4 rsvd members]
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:342: warning: Function parameter or member 'reserved' not described in 'opa_veswport_summary_counters'
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:394: warning: Function parameter or member 'rsvd0' not described in 'opa_veswport_error_counters' [10 rsvd members]
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:460: warning: Function parameter or member 'reserved' not described in 'opa_vnic_vema_mad'
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:485: warning: Function parameter or member 'reserved' not described in 'opa_vnic_notice_attr'
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:500: warning: Function parameter or member 'reserved' not described in 'opa_vnic_vema_mad_trap'
../drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h:263: warning: Function parameter or member 'tbl_entries' not described in 'opa_veswport_mactable'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h | 42 ++++++++++++-
1 file changed, 41 insertions(+), 1 deletion(-)
--- linux-next-20191009.orig/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
+++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
@@ -129,21 +129,31 @@ struct opa_vesw_info {
__be16 fabric_id;
__be16 vesw_id;
+ /* private: */
u8 rsvd0[6];
+ /* public: */
__be16 def_port_mask;
+ /* private: */
u8 rsvd1[2];
+ /* public: */
__be16 pkey;
+ /* private: */
u8 rsvd2[4];
+ /* public: */
__be32 u_mcast_dlid;
__be32 u_ucast_dlid[OPA_VESW_MAX_NUM_DEF_PORT];
__be32 rc;
+ /* private: */
u8 rsvd3[56];
+ /* public: */
__be16 eth_mtu;
+ /* private: */
u8 rsvd4[2];
+ /* public: */
} __packed;
/**
@@ -172,7 +182,9 @@ struct opa_per_veswport_info {
__be32 port_num;
u8 eth_link_status;
+ /* private: */
u8 rsvd0[3];
+ /* public: */
u8 base_mac_addr[ETH_ALEN];
u8 config_state;
@@ -181,7 +193,9 @@ struct opa_per_veswport_info {
__be16 max_mac_tbl_ent;
__be16 max_smac_ent;
__be32 mac_tbl_digest;
+ /* private: */
u8 rsvd1[4];
+ /* public: */
__be32 encap_slid;
@@ -195,12 +209,16 @@ struct opa_per_veswport_info {
u8 non_vlan_sc_mc;
u8 non_vlan_vl_mc;
+ /* private: */
u8 rsvd2[48];
+ /* public: */
__be16 uc_macs_gen_count;
__be16 mc_macs_gen_count;
+ /* private: */
u8 rsvd3[8];
+ /* public: */
} __packed;
/**
@@ -239,7 +257,7 @@ struct opa_veswport_mactable_entry {
* @offset: mac table starting offset
* @num_entries: Number of entries to get or set
* @mac_tbl_digest: mac table digest
- * @tbl_entries[]: Array of table entries
+ * @tbl_entries: Array of table entries
*
* The EM sends down this structure in a MAD indicating
* the starting offset in the forwarding table that this
@@ -337,7 +355,9 @@ struct opa_veswport_summary_counters {
__be64 rx_1024_1518;
__be64 rx_1519_max;
+ /* private: */
__be64 reserved[16];
+ /* public: */
} __packed;
/**
@@ -368,28 +388,42 @@ struct opa_veswport_error_counters {
__be64 tx_errors;
__be64 rx_errors;
+ /* private: */
__be64 rsvd0;
+ /* public: */
__be64 tx_smac_filt;
+ /* private: */
__be64 rsvd1;
__be64 rsvd2;
__be64 rsvd3;
+ /* public: */
__be64 tx_dlid_zero;
+ /* private: */
__be64 rsvd4;
+ /* public: */
__be64 tx_logic;
+ /* private: */
__be64 rsvd5;
+ /* public: */
__be64 tx_drop_state;
__be64 rx_bad_veswid;
+ /* private: */
__be64 rsvd6;
+ /* public: */
__be64 rx_runt;
__be64 rx_oversize;
+ /* private: */
__be64 rsvd7;
+ /* public: */
__be64 rx_eth_down;
__be64 rx_drop_state;
__be64 rx_logic;
+ /* private: */
__be64 rsvd8;
__be64 rsvd9[16];
+ /* public: */
} __packed;
/**
@@ -453,7 +487,9 @@ struct opa_veswport_iface_macs {
struct opa_vnic_vema_mad {
struct ib_mad_hdr mad_hdr;
struct ib_rmpp_hdr rmpp_hdr;
+ /* private: */
u8 reserved;
+ /* public: */
u8 oui[3];
u8 data[OPA_VNIC_EMA_DATA];
};
@@ -478,7 +514,9 @@ struct opa_vnic_notice_attr {
__be16 trap_num;
__be16 toggle_count;
__be32 issuer_lid;
+ /* private: */
__be32 reserved;
+ /* public: */
u8 issuer_gid[16];
u8 raw_data[64];
} __packed;
@@ -493,7 +531,9 @@ struct opa_vnic_notice_attr {
struct opa_vnic_vema_mad_trap {
struct ib_mad_hdr mad_hdr;
struct ib_rmpp_hdr rmpp_hdr;
+ /* private: */
u8 reserved;
+ /* public: */
u8 oui[3];
struct opa_vnic_notice_attr notice;
};
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (4 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h " rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-23 20:30 ` Bart Van Assche
2019-10-10 3:52 ` [PATCH 07/12] infiniband: fix core/verbs.c " rd.dunlab
` (6 subsequent siblings)
12 siblings, 1 reply; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 011-iband-ulp-srpthdr.patch --]
[-- Type: text/plain, Size: 1587 bytes --]
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 in 'srpt_port'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/srpt/ib_srpt.h | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/ulp/srpt/ib_srpt.h
+++ linux-next-20191009/drivers/infiniband/ulp/srpt/ib_srpt.h
@@ -387,12 +387,9 @@ struct srpt_port_id {
* @sm_lid: cached value of the port's sm_lid.
* @lid: cached value of the port's lid.
* @gid: cached value of the port's gid.
- * @port_acl_lock spinlock for port_acl_list:
* @work: work structure for refreshing the aforementioned cached values.
- * @port_guid_tpg: TPG associated with target port GUID.
- * @port_guid_wwn: WWN associated with target port GUID.
- * @port_gid_tpg: TPG associated with target port GID.
- * @port_gid_wwn: WWN associated with target port GID.
+ * @port_guid_id: target port GUID
+ * @port_gid_id: target port GID
* @port_attrib: Port attributes that can be accessed through configfs.
* @refcount: Number of objects associated with this port.
* @freed_channels: Completion that will be signaled once @refcount becomes 0.
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 07/12] infiniband: fix core/verbs.c kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (5 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h " rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 08/12] infiniband: fix ulp/iser/iser_verbs.c " rd.dunlab
` (5 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 012-iband-core-verbs.patch --]
[-- Type: text/plain, Size: 1411 bytes --]
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-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
This leaves a few Sphinx format warnings:
../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.
drivers/infiniband/core/verbs.c | 2 ++
1 file changed, 2 insertions(+)
--- linux-next-20191009.orig/drivers/infiniband/core/verbs.c
+++ linux-next-20191009/drivers/infiniband/core/verbs.c
@@ -244,6 +244,8 @@ EXPORT_SYMBOL(rdma_port_get_link_layer);
/**
* ib_alloc_pd - Allocates an unused protection domain.
* @device: The device on which to allocate the protection domain.
+ * @flags: protection domain flags
+ * @caller: caller's build-time module name
*
* A protection domain object provides an association between QPs, shared
* receive queues, address handles, memory regions, and memory windows.
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 08/12] infiniband: fix ulp/iser/iser_verbs.c kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (6 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 07/12] infiniband: fix core/verbs.c " rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 09/12] infiniband: fix ulp/iser/iser_initiator.c kernel-doc warnings rd.dunlab
` (4 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 013-iband-iser-verbs.patch --]
[-- Type: text/plain, Size: 7283 bytes --]
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 'iser_alloc_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:159: warning: Function parameter or member 'cmds_max' not described in 'iser_alloc_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:159: warning: Function parameter or member 'size' not described in 'iser_alloc_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:221: warning: Function parameter or member 'ib_conn' not described in 'iser_free_fmr_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:304: warning: Function parameter or member 'ib_conn' not described in 'iser_alloc_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:304: warning: Function parameter or member 'cmds_max' not described in 'iser_alloc_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:304: warning: Function parameter or member 'size' not described in 'iser_alloc_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:338: warning: Function parameter or member 'ib_conn' not described in 'iser_free_fastreg_pool'
../drivers/infiniband/ulp/iser/iser_verbs.c:568: warning: Function parameter or member 'iser_conn' not described in 'iser_conn_release'
../drivers/infiniband/ulp/iser/iser_verbs.c:603: warning: Function parameter or member 'iser_conn' not described in 'iser_conn_terminate'
../drivers/infiniband/ulp/iser/iser_verbs.c:1040: warning: Function parameter or member 'signal' not described in 'iser_post_send'
../drivers/infiniband/ulp/iser/iser_verbs.c:1040: warning: Function parameter or member 'ib_conn' not described in 'iser_post_send'
../drivers/infiniband/ulp/iser/iser_verbs.c:1040: warning: Function parameter or member 'tx_desc' not described in 'iser_post_send'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/iser/iser_verbs.c | 60 +++++++++++++--------
1 file changed, 38 insertions(+), 22 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/ulp/iser/iser_verbs.c
+++ linux-next-20191009/drivers/infiniband/ulp/iser/iser_verbs.c
@@ -58,12 +58,12 @@ static void iser_event_handler(struct ib
dev_name(&event->device->dev), event->element.port_num);
}
-/**
+/*
* iser_create_device_ib_res - creates Protection Domain (PD), Completion
* Queue (CQ), DMA Memory Region (DMA MR) with the device associated with
- * the adapator.
+ * the adaptor.
*
- * returns 0 on success, -1 on failure
+ * Return: 0 on success, -1 on failure
*/
static int iser_create_device_ib_res(struct iser_device *device)
{
@@ -124,9 +124,9 @@ comps_err:
return -1;
}
-/**
+/*
* iser_free_device_ib_res - destroy/dealloc/dereg the DMA MR,
- * CQ and PD created with the device associated with the adapator.
+ * CQ and PD created with the device associated with the adaptor.
*/
static void iser_free_device_ib_res(struct iser_device *device)
{
@@ -149,8 +149,11 @@ static void iser_free_device_ib_res(stru
/**
* iser_alloc_fmr_pool - Creates FMR pool and page_vector
+ * @ib_conn: connection RDMA resources
+ * @cmds_max: max number of SCSI commands for this connection
+ * @size: max number of pages per map request
*
- * returns 0 on success, or errno code on failure
+ * Return: 0 on success, or errno code on failure
*/
int iser_alloc_fmr_pool(struct ib_conn *ib_conn,
unsigned cmds_max,
@@ -215,6 +218,7 @@ err_frpl:
/**
* iser_free_fmr_pool - releases the FMR pool and page vec
+ * @ib_conn: connection RDMA resources
*/
void iser_free_fmr_pool(struct ib_conn *ib_conn)
{
@@ -295,7 +299,11 @@ static void iser_destroy_fastreg_desc(st
/**
* iser_alloc_fastreg_pool - Creates pool of fast_reg descriptors
* for fast registration work requests.
- * returns 0 on success, or errno code on failure
+ * @ib_conn: connection RDMA resources
+ * @cmds_max: max number of SCSI commands for this connection
+ * @size: max number of pages per map request
+ *
+ * Return: 0 on success, or errno code on failure
*/
int iser_alloc_fastreg_pool(struct ib_conn *ib_conn,
unsigned cmds_max,
@@ -332,6 +340,7 @@ err:
/**
* iser_free_fastreg_pool - releases the pool of fast_reg descriptors
+ * @ib_conn: connection RDMA resources
*/
void iser_free_fastreg_pool(struct ib_conn *ib_conn)
{
@@ -355,10 +364,10 @@ void iser_free_fastreg_pool(struct ib_co
fr_pool->size - i);
}
-/**
+/*
* iser_create_ib_conn_res - Queue-Pair (QP)
*
- * returns 0 on success, -1 on failure
+ * Return: 0 on success, -1 on failure
*/
static int iser_create_ib_conn_res(struct ib_conn *ib_conn)
{
@@ -436,7 +445,7 @@ out_err:
return ret;
}
-/**
+/*
* based on the resolved device node GUID see if there already allocated
* device for this device. If there's no such, create one.
*/
@@ -487,9 +496,9 @@ static void iser_device_try_release(stru
mutex_unlock(&ig.device_list_mutex);
}
-/**
+/*
* Called with state mutex held
- **/
+ */
static int iser_conn_state_comp_exch(struct iser_conn *iser_conn,
enum iser_conn_state comp,
enum iser_conn_state exch)
@@ -561,7 +570,8 @@ static void iser_free_ib_conn_res(struct
}
/**
- * Frees all conn objects and deallocs conn descriptor
+ * iser_conn_release - Frees all conn objects and deallocs conn descriptor
+ * @iser_conn: iSER connection context
*/
void iser_conn_release(struct iser_conn *iser_conn)
{
@@ -595,7 +605,10 @@ void iser_conn_release(struct iser_conn
}
/**
- * triggers start of the disconnect procedures and wait for them to be done
+ * iser_conn_terminate - triggers start of the disconnect procedures and
+ * waits for them to be done
+ * @iser_conn: iSER connection context
+ *
* Called with state mutex held
*/
int iser_conn_terminate(struct iser_conn *iser_conn)
@@ -632,9 +645,9 @@ int iser_conn_terminate(struct iser_conn
return 1;
}
-/**
+/*
* Called with state mutex held
- **/
+ */
static void iser_connect_error(struct rdma_cm_id *cma_id)
{
struct iser_conn *iser_conn;
@@ -684,9 +697,9 @@ iser_calc_scsi_params(struct iser_conn *
iser_conn->scsi_sg_tablesize + reserved_mr_pages;
}
-/**
+/*
* Called with state mutex held
- **/
+ */
static void iser_addr_handler(struct rdma_cm_id *cma_id)
{
struct iser_device *device;
@@ -732,9 +745,9 @@ static void iser_addr_handler(struct rdm
}
}
-/**
+/*
* Called with state mutex held
- **/
+ */
static void iser_route_handler(struct rdma_cm_id *cma_id)
{
struct rdma_conn_param conn_param;
@@ -1030,9 +1043,12 @@ int iser_post_recvm(struct iser_conn *is
/**
- * iser_start_send - Initiate a Send DTO operation
+ * iser_post_send - Initiate a Send DTO operation
+ * @ib_conn: connection RDMA resources
+ * @tx_desc: iSER TX descriptor
+ * @signal: true to send work request as SIGNALED
*
- * returns 0 on success, -1 on failure
+ * Return: 0 on success, -1 on failure
*/
int iser_post_send(struct ib_conn *ib_conn, struct iser_tx_desc *tx_desc,
bool signal)
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 09/12] infiniband: fix ulp/iser/iser_initiator.c kernel-doc warnings
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (7 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 08/12] infiniband: fix ulp/iser/iser_verbs.c " rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 10/12] infiniband: fix core/ kernel-doc notation rd.dunlab
` (3 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 014-iband-iser-initor.patch --]
[-- Type: text/plain, Size: 1752 bytes --]
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 described in 'iser_send_command'
../drivers/infiniband/ulp/iser/iser_initiator.c:437: warning: Function parameter or member 'conn' not described in 'iser_send_data_out'
../drivers/infiniband/ulp/iser/iser_initiator.c:437: warning: Function parameter or member 'task' not described in 'iser_send_data_out'
../drivers/infiniband/ulp/iser/iser_initiator.c:437: warning: Function parameter or member 'hdr' not described in 'iser_send_data_out'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/ulp/iser/iser_initiator.c | 5 +++++
1 file changed, 5 insertions(+)
--- linux-next-20191009.orig/drivers/infiniband/ulp/iser/iser_initiator.c
+++ linux-next-20191009/drivers/infiniband/ulp/iser/iser_initiator.c
@@ -358,6 +358,8 @@ static inline bool iser_signal_comp(u8 s
/**
* iser_send_command - send command PDU
+ * @conn: link to matching iscsi connection
+ * @task: SCSI command task
*/
int iser_send_command(struct iscsi_conn *conn,
struct iscsi_task *task)
@@ -429,6 +431,9 @@ send_command_error:
/**
* iser_send_data_out - send data out PDU
+ * @conn: link to matching iscsi connection
+ * @task: SCSI command task
+ * @hdr: pointer to the LLD's iSCSI message header
*/
int iser_send_data_out(struct iscsi_conn *conn,
struct iscsi_task *task,
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 10/12] infiniband: fix core/ kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (8 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 09/12] infiniband: fix ulp/iser/iser_initiator.c kernel-doc warnings rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 11/12] infiniband: fix sw/rdmavt/ " rd.dunlab
` (2 subsequent siblings)
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 015-iband-core-fixes.patch --]
[-- Type: text/plain, Size: 5033 bytes --]
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: warning: Excess function parameter 'sgid_attr' description in 'ib_init_ah_attr_from_path'
../drivers/infiniband/core/device.c:145: warning: Function parameter or member 'dev' not described in 'rdma_dev_access_netns'
../drivers/infiniband/core/device.c:145: warning: Excess function parameter 'device' description in 'rdma_dev_access_netns'
../drivers/infiniband/core/device.c:1333: warning: Function parameter or member 'name' not described in 'ib_register_device'
../drivers/infiniband/core/device.c:1461: warning: Function parameter or member 'ib_dev' not described in 'ib_unregister_device'
../drivers/infiniband/core/device.c:1461: warning: Excess function parameter 'device' description in 'ib_unregister_device'
../drivers/infiniband/core/device.c:1483: warning: Function parameter or member 'ib_dev' not described in 'ib_unregister_device_and_put'
../drivers/infiniband/core/device.c:1550: warning: Function parameter or member 'ib_dev' not described in 'ib_unregister_device_queued'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
drivers/infiniband/core/device.c | 23 +++++++++++------------
drivers/infiniband/core/sa_query.c | 2 +-
2 files changed, 12 insertions(+), 13 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/core/sa_query.c
+++ linux-next-20191009/drivers/infiniband/core/sa_query.c
@@ -1246,7 +1246,7 @@ static int init_ah_attr_grh_fields(struc
* @port_num: Port on the specified device.
* @rec: path record entry to use for ah attributes initialization.
* @ah_attr: address handle attributes to initialization from path record.
- * @sgid_attr: SGID attribute to consider during initialization.
+ * @gid_attr: SGID attribute to consider during initialization.
*
* When ib_init_ah_attr_from_path() returns success,
* (a) for IB link layer it optionally contains a reference to SGID attribute
--- linux-next-20191009.orig/drivers/infiniband/core/device.c
+++ linux-next-20191009/drivers/infiniband/core/device.c
@@ -128,17 +128,14 @@ module_param_named(netns_mode, ib_device
MODULE_PARM_DESC(netns_mode,
"Share device among net namespaces; default=1 (shared)");
/**
- * rdma_dev_access_netns() - Return whether a rdma device can be accessed
+ * rdma_dev_access_netns() - Return whether an rdma device can be accessed
* from a specified net namespace or not.
- * @device: Pointer to rdma device which needs to be checked
+ * @dev: Pointer to rdma device which needs to be checked
* @net: Pointer to net namesapce for which access to be checked
*
- * rdma_dev_access_netns() - Return whether a rdma device can be accessed
- * from a specified net namespace or not. When
- * rdma device is in shared mode, it ignores the
- * net namespace. When rdma device is exclusive
- * to a net namespace, rdma device net namespace is
- * checked against the specified one.
+ * When the rdma device is in shared mode, it ignores the net namespace.
+ * When the rdma device is exclusive to a net namespace, rdma device net
+ * namespace is checked against the specified one.
*/
bool rdma_dev_access_netns(const struct ib_device *dev, const struct net *net)
{
@@ -1317,7 +1314,9 @@ out:
/**
* ib_register_device - Register an IB device with IB core
- * @device:Device to register
+ * @device: Device to register
+ * @name: unique string device name. This may include a '%' which will
+ * cause a unique index to be added to the passed device name.
*
* Low-level drivers use ib_register_device() to register their
* devices with the IB core. All registered clients will receive a
@@ -1444,7 +1443,7 @@ out:
/**
* ib_unregister_device - Unregister an IB device
- * @device: The device to unregister
+ * @ib_dev: The device to unregister
*
* Unregister an IB device. All clients will receive a remove callback.
*
@@ -1466,7 +1465,7 @@ EXPORT_SYMBOL(ib_unregister_device);
/**
* ib_unregister_device_and_put - Unregister a device while holding a 'get'
- * device: The device to unregister
+ * @ib_dev: The device to unregister
*
* This is the same as ib_unregister_device(), except it includes an internal
* ib_device_put() that should match a 'get' obtained by the caller.
@@ -1536,7 +1535,7 @@ static void ib_unregister_work(struct wo
/**
* ib_unregister_device_queued - Unregister a device using a work queue
- * device: The device to unregister
+ * @ib_dev: The device to unregister
*
* This schedules an asynchronous unregistration using a WQ for the device. A
* driver should use this to avoid holding locks while doing unregistration,
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 11/12] infiniband: fix sw/rdmavt/ kernel-doc notation
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (9 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 10/12] infiniband: fix core/ kernel-doc notation rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 3:52 ` [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband rd.dunlab
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
12 siblings, 0 replies; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 016-iband-rdmavt-fixes.patch --]
[-- Type: text/plain, Size: 6334 bytes --]
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/infiniband/sw/rdmavt/vt.c:698: warning: Function parameter or member 'pkey_table' not described in 'rvt_init_port'
../drivers/infiniband/sw/rdmavt/cq.c:561: warning: Excess function parameter 'rdi' description in 'rvt_driver_cq_init'
../drivers/infiniband/sw/rdmavt/cq.c:575: warning: Excess function parameter 'rdi' description in 'rvt_cq_exit'
../drivers/infiniband/sw/rdmavt/qp.c:2573: warning: Function parameter or member 'qp' not described in 'rvt_add_rnr_timer'
../drivers/infiniband/sw/rdmavt/qp.c:2573: warning: Function parameter or member 'aeth' not described in 'rvt_add_rnr_timer'
../drivers/infiniband/sw/rdmavt/qp.c:2591: warning: Function parameter or member 'qp' not described in 'rvt_stop_rc_timers'
../drivers/infiniband/sw/rdmavt/qp.c:2624: warning: Function parameter or member 'qp' not described in 'rvt_del_timers_sync'
../drivers/infiniband/sw/rdmavt/qp.c:2697: warning: Function parameter or member 'cb' not described in 'rvt_qp_iter_init'
../drivers/infiniband/sw/rdmavt/qp.c:2728: warning: Function parameter or member 'iter' not described in 'rvt_qp_iter_next'
../drivers/infiniband/sw/rdmavt/qp.c:2796: warning: Function parameter or member 'rdi' not described in 'rvt_qp_iter'
../drivers/infiniband/sw/rdmavt/qp.c:2796: warning: Function parameter or member 'v' not described in 'rvt_qp_iter'
../drivers/infiniband/sw/rdmavt/qp.c:2796: warning: Function parameter or member 'cb' not described in 'rvt_qp_iter'
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
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 +-
4 files changed, 17 insertions(+), 19 deletions(-)
--- linux-next-20191009.orig/drivers/infiniband/sw/rdmavt/ah.c
+++ linux-next-20191009/drivers/infiniband/sw/rdmavt/ah.c
@@ -129,7 +129,6 @@ int rvt_create_ah(struct ib_ah *ibah, st
* rvt_destory_ah - Destory an address handle
* @ibah: address handle
* @destroy_flags: destroy address handle flags (see enum rdma_destroy_ah_flags)
- * @udata: user data or NULL for kernel object
*
* Return: 0 on success
*/
--- linux-next-20191009.orig/drivers/infiniband/sw/rdmavt/vt.c
+++ linux-next-20191009/drivers/infiniband/sw/rdmavt/vt.c
@@ -683,9 +683,10 @@ EXPORT_SYMBOL(rvt_unregister_device);
/**
* rvt_init_port - init internal data for driver port
- * @rdi: rvt dev strut
+ * @rdi: rvt_dev_info struct
* @port: rvt port
* @port_index: 0 based index of ports, different from IB core port num
+ * @pkey_table: pkey_table for @port
*
* Keep track of a list of ports. No need to have a detach port.
* They persist until the driver goes away.
--- linux-next-20191009.orig/drivers/infiniband/sw/rdmavt/cq.c
+++ linux-next-20191009/drivers/infiniband/sw/rdmavt/cq.c
@@ -552,7 +552,6 @@ int rvt_poll_cq(struct ib_cq *ibcq, int
/**
* rvt_driver_cq_init - Init cq resources on behalf of driver
- * @rdi: rvt dev structure
*
* Return: 0 on success
*/
@@ -568,7 +567,6 @@ int rvt_driver_cq_init(void)
/**
* rvt_cq_exit - tear down cq reources
- * @rdi: rvt dev structure
*/
void rvt_cq_exit(void)
{
--- linux-next-20191009.orig/drivers/infiniband/sw/rdmavt/qp.c
+++ linux-next-20191009/drivers/infiniband/sw/rdmavt/qp.c
@@ -2563,10 +2563,9 @@ void rvt_add_retry_timer_ext(struct rvt_
EXPORT_SYMBOL(rvt_add_retry_timer_ext);
/**
- * rvt_add_rnr_timer - add/start an rnr timer
- * @qp - the QP
- * @aeth - aeth of RNR timeout, simulated aeth for loopback
- * add an rnr timer on the QP
+ * rvt_add_rnr_timer - add/start an rnr timer on the QP
+ * @qp: the QP
+ * @aeth: aeth of RNR timeout, simulated aeth for loopback
*/
void rvt_add_rnr_timer(struct rvt_qp *qp, u32 aeth)
{
@@ -2583,7 +2582,7 @@ EXPORT_SYMBOL(rvt_add_rnr_timer);
/**
* rvt_stop_rc_timers - stop all timers
- * @qp - the QP
+ * @qp: the QP
* stop any pending timers
*/
void rvt_stop_rc_timers(struct rvt_qp *qp)
@@ -2617,7 +2616,7 @@ static void rvt_stop_rnr_timer(struct rv
/**
* rvt_del_timers_sync - wait for any timeout routines to exit
- * @qp - the QP
+ * @qp: the QP
*/
void rvt_del_timers_sync(struct rvt_qp *qp)
{
@@ -2626,7 +2625,7 @@ void rvt_del_timers_sync(struct rvt_qp *
}
EXPORT_SYMBOL(rvt_del_timers_sync);
-/**
+/*
* This is called from s_timer for missing responses.
*/
static void rvt_rc_timeout(struct timer_list *t)
@@ -2676,12 +2675,13 @@ EXPORT_SYMBOL(rvt_rc_rnr_retry);
* rvt_qp_iter_init - initial for QP iteration
* @rdi: rvt devinfo
* @v: u64 value
+ * @cb: user-defined callback
*
* This returns an iterator suitable for iterating QPs
* in the system.
*
- * The @cb is a user defined callback and @v is a 64
- * bit value passed to and relevant for processing in the
+ * The @cb is a user-defined callback and @v is a 64-bit
+ * value passed to and relevant for processing in the
* @cb. An example use case would be to alter QP processing
* based on criteria not part of the rvt_qp.
*
@@ -2712,7 +2712,7 @@ EXPORT_SYMBOL(rvt_qp_iter_init);
/**
* rvt_qp_iter_next - return the next QP in iter
- * @iter - the iterator
+ * @iter: the iterator
*
* Fine grained QP iterator suitable for use
* with debugfs seq_file mechanisms.
@@ -2775,14 +2775,14 @@ EXPORT_SYMBOL(rvt_qp_iter_next);
/**
* rvt_qp_iter - iterate all QPs
- * @rdi - rvt devinfo
- * @v - a 64 bit value
- * @cb - a callback
+ * @rdi: rvt devinfo
+ * @v: a 64-bit value
+ * @cb: a callback
*
* This provides a way for iterating all QPs.
*
- * The @cb is a user defined callback and @v is a 64
- * bit value passed to and relevant for processing in the
+ * The @cb is a user-defined callback and @v is a 64-bit
+ * value passed to and relevant for processing in the
* cb. An example use case would be to alter QP processing
* based on criteria not part of the rvt_qp.
*
^ permalink raw reply [flat|nested] 26+ messages in thread
* [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (10 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 11/12] infiniband: fix sw/rdmavt/ " rd.dunlab
@ 2019-10-10 3:52 ` rd.dunlab
2019-10-10 15:45 ` kbuild test robot
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
12 siblings, 1 reply; 26+ messages in thread
From: rd.dunlab @ 2019-10-10 3:52 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
[-- Attachment #1: 017-docum-iband-chapter.patch --]
[-- Type: text/plain, Size: 4051 bytes --]
Add a driver-api chapter for InfiniBand interfaces.
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@mellanox.com>
Cc: linux-doc@vger.kernel.org
---
Documentation/driver-api/index.rst | 1
Documentation/driver-api/infiniband.rst | 127 ++++++++++++++++++++++
2 files changed, 128 insertions(+)
--- linux-next-20191009.orig/Documentation/driver-api/index.rst
+++ linux-next-20191009/Documentation/driver-api/index.rst
@@ -26,6 +26,7 @@ available subsections can be seen below.
device_link
component
message-based
+ infiniband
sound
frame-buffer
regulator
--- /dev/null
+++ linux-next-20191009/Documentation/driver-api/infiniband.rst
@@ -0,0 +1,127 @@
+===========================================
+InfiniBand and Remote DMA (RDMA) Interfaces
+===========================================
+
+Introduction and Overview
+=========================
+
+TBD
+
+InfiniBand core interfaces
+==========================
+
+.. kernel-doc:: drivers/infiniband/core/iwpm_util.h
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/core/cq.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/cm.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/rw.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/device.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/verbs.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/packer.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/sa_query.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/ud_header.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/fmr_pool.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/umem.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/core/umem_odp.c
+ :export:
+
+RDMA Verbs transport library
+============================
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/mr.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/rc.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/ah.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/vt.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/cq.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/qp.c
+ :export:
+
+.. kernel-doc:: drivers/infiniband/sw/rdmavt/mcast.c
+ :export:
+
+Upper Layer Protocols
+=====================
+
+iSCSI Extensions for RDMA (iSER)
+--------------------------------
+
+.. kernel-doc:: drivers/infiniband/ulp/iser/iscsi_iser.h
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/ulp/iser/iscsi_iser.c
+ :functions: iscsi_iser_pdu_alloc iser_initialize_task_headers \
+ iscsi_iser_task_init iscsi_iser_mtask_xmit iscsi_iser_task_xmit \
+ iscsi_iser_cleanup_task iscsi_iser_check_protection \
+ iscsi_iser_conn_create iscsi_iser_conn_bind \
+ iscsi_iser_conn_start iscsi_iser_conn_stop \
+ iscsi_iser_session_destroy iscsi_iser_session_create \
+ iscsi_iser_set_param iscsi_iser_ep_connect iscsi_iser_ep_poll \
+ iscsi_iser_ep_disconnect
+
+.. kernel-doc:: drivers/infiniband/ulp/iser/iser_initiator.c
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/ulp/iser/iser_verbs.c
+ :internal:
+
+Omni-Path (OPA) Virtual NIC support
+-----------------------------------
+
+.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_vema_iface.c
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/ulp/opa_vnic/opa_vnic_vema.c
+ :internal:
+
+InfiniBand SCSI RDMA protocol target support
+--------------------------------------------
+
+.. kernel-doc:: drivers/infiniband/ulp/srpt/ib_srpt.h
+ :internal:
+
+.. kernel-doc:: drivers/infiniband/ulp/srpt/ib_srpt.c
+ :internal:
+
+iSCSI Extensions for RDMA (iSER) target support
+-----------------------------------------------
+
+.. kernel-doc:: drivers/infiniband/ulp/isert/ib_isert.c
+ :internal:
+
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband
2019-10-10 3:52 ` [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband rd.dunlab
@ 2019-10-10 15:45 ` kbuild test robot
2019-10-21 17:07 ` Jason Gunthorpe
0 siblings, 1 reply; 26+ messages in thread
From: kbuild test robot @ 2019-10-10 15:45 UTC (permalink / raw)
To: rd.dunlab
Cc: kbuild-all, linux-rdma, Doug Ledford, Jason Gunthorpe, linux-doc,
Randy Dunlap
[-- Attachment #1: Type: text/plain, Size: 18134 bytes --]
Hi,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on rdma/for-next]
[cannot apply to v5.4-rc2 next-20191010]
[if your patch is applied to the wrong git tree, please drop us a note to help
improve the system. BTW, we also suggest to use '--base' option to specify the
base tree in git format-patch, please see https://stackoverflow.com/a/37406982]
url: https://github.com/0day-ci/linux/commits/rd-dunlab-gmail-com/infiniband-kernel-doc-fixes-driver-api-chapter/20191010-220426
base: https://git.kernel.org/pub/scm/linux/kernel/git/rdma/rdma.git for-next
reproduce: make htmldocs
If you fix the issue, kindly add following tag
Reported-by: kbuild test robot <lkp@intel.com>
All warnings (new ones prefixed by >>):
Warning: The Sphinx 'sphinx_rtd_theme' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.
WARNING: dot(1) not found, for better output quality install graphviz from http://www.graphviz.org
WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org)
Error: Cannot open file drivers/dma-buf/reservation.c
Error: Cannot open file drivers/dma-buf/reservation.c
Error: Cannot open file drivers/dma-buf/reservation.c
Error: Cannot open file include/linux/reservation.h
Error: Cannot open file include/linux/reservation.h
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'quotactl' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'quota_on' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_free_mnt_opts' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_eat_lsm_opts' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_kern_mount' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_show_options' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_add_mnt_opt' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'd_instantiate' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'getprocattr' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'setprocattr' not described in 'security_list_options'
include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'locked_down' not described in 'security_list_options'
include/linux/regulator/machine.h:196: warning: Function parameter or member 'max_uV_step' not described in 'regulation_constraints'
include/linux/regulator/driver.h:223: warning: Function parameter or member 'resume' not described in 'regulator_ops'
include/linux/spi/spi.h:190: warning: Function parameter or member 'driver_override' not described in 'spi_device'
fs/fs-writeback.c:913: warning: Excess function parameter 'nr_pages' description in 'cgroup_writeback_by_id'
fs/direct-io.c:258: warning: Excess function parameter 'offset' description in 'dio_complete'
fs/libfs.c:496: warning: Excess function parameter 'available' description in 'simple_write_end'
fs/posix_acl.c:647: warning: Function parameter or member 'inode' not described in 'posix_acl_update_mode'
fs/posix_acl.c:647: warning: Function parameter or member 'mode_p' not described in 'posix_acl_update_mode'
fs/posix_acl.c:647: warning: Function parameter or member 'acl' not described in 'posix_acl_update_mode'
drivers/usb/typec/bus.c:1: warning: 'typec_altmode_unregister_driver' not found
drivers/usb/typec/bus.c:1: warning: 'typec_altmode_register_driver' not found
drivers/usb/typec/class.c:1: warning: 'typec_altmode_register_notifier' not found
drivers/usb/typec/class.c:1: warning: 'typec_altmode_unregister_notifier' not found
include/linux/w1.h:277: warning: Function parameter or member 'of_match_table' not described in 'w1_family'
drivers/gpio/gpiolib-of.c:92: warning: Excess function parameter 'dev' description in 'of_gpio_need_valid_mask'
include/linux/i2c.h:337: warning: Function parameter or member 'init_irq' not described in 'i2c_client'
>> 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'
kernel/dma/coherent.c:1: warning: no structured comments found
include/linux/input/sparse-keymap.h:43: warning: Function parameter or member 'sw' not described in 'key_entry'
include/linux/skbuff.h:888: warning: Function parameter or member 'dev_scratch' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'list' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'ip_defrag_offset' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'skb_mstamp_ns' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member '__cloned_offset' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'head_frag' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member '__pkt_type_offset' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'encapsulation' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'encap_hdr_csum' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'csum_valid' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member '__pkt_vlan_present_offset' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'vlan_present' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'csum_complete_sw' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'csum_level' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'inner_protocol_type' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'remcsum_offload' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'sender_cpu' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'reserved_tailroom' not described in 'sk_buff'
include/linux/skbuff.h:888: warning: Function parameter or member 'inner_ipproto' not described in 'sk_buff'
include/net/sock.h:233: warning: Function parameter or member 'skc_addrpair' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_portpair' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_ipv6only' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_net_refcnt' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_v6_daddr' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_v6_rcv_saddr' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_cookie' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_listener' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_tw_dr' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_rcv_wnd' not described in 'sock_common'
include/net/sock.h:233: warning: Function parameter or member 'skc_tw_rcv_nxt' not described in 'sock_common'
include/net/sock.h:515: warning: Function parameter or member 'sk_rx_skb_cache' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'sk_wq_raw' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'tcp_rtx_queue' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'sk_tx_skb_cache' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'sk_route_forced_caps' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'sk_txtime_report_errors' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'sk_validate_xmit_skb' not described in 'sock'
include/net/sock.h:515: warning: Function parameter or member 'sk_bpf_storage' not described in 'sock'
include/net/sock.h:2439: warning: Function parameter or member 'tcp_rx_skb_cache_key' not described in 'DECLARE_STATIC_KEY_FALSE'
include/net/sock.h:2439: warning: Excess function parameter 'sk' description in 'DECLARE_STATIC_KEY_FALSE'
include/net/sock.h:2439: warning: Excess function parameter 'skb' description in 'DECLARE_STATIC_KEY_FALSE'
include/linux/netdevice.h:2053: warning: Function parameter or member 'gso_partial_features' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'l3mdev_ops' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'xfrmdev_ops' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'tlsdev_ops' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'name_assign_type' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'ieee802154_ptr' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'mpls_ptr' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'xdp_prog' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'gro_flush_timeout' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'nf_hooks_ingress' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member '____cacheline_aligned_in_smp' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'qdisc_hash' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'xps_cpus_map' not described in 'net_device'
include/linux/netdevice.h:2053: warning: Function parameter or member 'xps_rxqs_map' not described in 'net_device'
include/linux/phylink.h:56: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising' not described in 'phylink_link_state'
include/linux/phylink.h:56: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising' not described in 'phylink_link_state'
drivers/net/phy/phylink.c:595: warning: Function parameter or member 'config' not described in 'phylink_create'
drivers/net/phy/phylink.c:595: warning: Excess function parameter 'ndev' description in 'phylink_create'
lib/genalloc.c:1: warning: 'gen_pool_add_virt' not found
lib/genalloc.c:1: warning: 'gen_pool_alloc' not found
lib/genalloc.c:1: warning: 'gen_pool_free' not found
lib/genalloc.c:1: warning: 'gen_pool_alloc_algo' not found
include/linux/bitmap.h:341: warning: Function parameter or member 'nbits' not described in 'bitmap_or_equal'
include/linux/rculist.h:374: warning: Excess function parameter 'cond' description in 'list_for_each_entry_rcu'
include/linux/rculist.h:651: warning: Excess function parameter 'cond' description in 'hlist_for_each_entry_rcu'
mm/util.c:1: warning: 'get_user_pages_fast' not found
mm/slab.c:4215: warning: Function parameter or member 'objp' not described in '__ksize'
drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c:335: warning: Excess function parameter 'dev' description in 'amdgpu_gem_prime_export'
drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c:336: warning: Excess function parameter 'dev' description in 'amdgpu_gem_prime_export'
drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:142: warning: Function parameter or member 'blockable' not described in 'amdgpu_mn_read_lock'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:347: warning: cannot understand function prototype: 'struct amdgpu_vm_pt_cursor '
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:348: warning: cannot understand function prototype: 'struct amdgpu_vm_pt_cursor '
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:494: warning: Function parameter or member 'start' not described in 'amdgpu_vm_pt_first_dfs'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'adev' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'vm' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'start' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'cursor' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'entry' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:823: warning: Function parameter or member 'level' not described in 'amdgpu_vm_bo_param'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'params' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'bo' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'level' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'pe' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'addr' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'count' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'incr' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'flags' not described in 'amdgpu_vm_update_flags'
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:2823: warning: Function parameter or member 'pasid' not described in 'amdgpu_vm_make_compute'
drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:378: warning: Excess function parameter 'entry' description in 'amdgpu_irq_dispatch'
drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:379: warning: Function parameter or member 'ih' not described in 'amdgpu_irq_dispatch'
drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:379: warning: Excess function parameter 'entry' description in 'amdgpu_irq_dispatch'
drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c:1: warning: no structured comments found
drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c:1: warning: no structured comments found
drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c:1: warning: 'pp_dpm_sclk pp_dpm_mclk pp_dpm_pcie' not found
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:132: warning: Incorrect use of kernel-doc format: Documentation Makefile include scripts source @atomic_obj
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:238: warning: Incorrect use of kernel-doc format: Documentation Makefile include scripts source gpu_info FW provided soc bounding box struct or 0 if not
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:243: warning: Function parameter or member 'atomic_obj' not described in 'amdgpu_display_manager'
vim +401 drivers/infiniband/ulp/iser/iscsi_iser.h
5587856c9659ac Sagi Grimberg 2013-07-28 @401
385ad87d4b637c Sagi Grimberg 2015-08-06 402 /**
e506e0f630a40d rd.dunlab@gmail.com 2019-10-09 403 * struct iser_fr_pool - connection fast registration pool
385ad87d4b637c Sagi Grimberg 2015-08-06 404 *
2b3bf958103899 Adir Lev 2015-08-06 405 * @list: list of fastreg descriptors
385ad87d4b637c Sagi Grimberg 2015-08-06 406 * @lock: protects fmr/fastreg pool
2b3bf958103899 Adir Lev 2015-08-06 407 * @size: size of the pool
385ad87d4b637c Sagi Grimberg 2015-08-06 408 */
385ad87d4b637c Sagi Grimberg 2015-08-06 409 struct iser_fr_pool {
2b3bf958103899 Adir Lev 2015-08-06 410 struct list_head list;
385ad87d4b637c Sagi Grimberg 2015-08-06 411 spinlock_t lock;
2b3bf958103899 Adir Lev 2015-08-06 412 int size;
ea174c9573b0e0 Sagi Grimberg 2017-02-27 413 struct list_head all_list;
385ad87d4b637c Sagi Grimberg 2015-08-06 414 };
385ad87d4b637c Sagi Grimberg 2015-08-06 @415
:::::: The code at line 401 was first introduced by commit
:::::: 5587856c9659ac2d6ab201141aa8a5c2ff3be4cd IB/iser: Introduce fast memory registration model (FRWR)
:::::: TO: Sagi Grimberg <sagig@mellanox.com>
:::::: CC: Roland Dreier <roland@purestorage.com>
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation
[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 7278 bytes --]
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband
2019-10-10 15:45 ` kbuild test robot
@ 2019-10-21 17:07 ` Jason Gunthorpe
2019-10-21 21:57 ` Randy Dunlap
0 siblings, 1 reply; 26+ messages in thread
From: Jason Gunthorpe @ 2019-10-21 17:07 UTC (permalink / raw)
To: kbuild test robot
Cc: rd.dunlab, kbuild-all, linux-rdma, Doug Ledford, linux-doc, Randy Dunlap
Randy,
What do you want to do with this series? Is this error below related
needing respin, or just noise?
Thanks,
Jason
On Thu, Oct 10, 2019 at 11:45:28PM +0800, kbuild test robot wrote:
> Hi,
>
> Thank you for the patch! Perhaps something to improve:
>
> [auto build test WARNING on rdma/for-next]
> [cannot apply to v5.4-rc2 next-20191010]
> [if your patch is applied to the wrong git tree, please drop us a note to help
> improve the system. BTW, we also suggest to use '--base' option to specify the
> base tree in git format-patch, please see https://stackoverflow.com/a/37406982]
>
> url: https://github.com/0day-ci/linux/commits/rd-dunlab-gmail-com/infiniband-kernel-doc-fixes-driver-api-chapter/20191010-220426
> base: https://git.kernel.org/pub/scm/linux/kernel/git/rdma/rdma.git for-next
> reproduce: make htmldocs
>
> If you fix the issue, kindly add following tag
> Reported-by: kbuild test robot <lkp@intel.com>
>
> All warnings (new ones prefixed by >>):
>
> Warning: The Sphinx 'sphinx_rtd_theme' HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.
> WARNING: dot(1) not found, for better output quality install graphviz from http://www.graphviz.org
> WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org)
> Error: Cannot open file drivers/dma-buf/reservation.c
> Error: Cannot open file drivers/dma-buf/reservation.c
> Error: Cannot open file drivers/dma-buf/reservation.c
> Error: Cannot open file include/linux/reservation.h
> Error: Cannot open file include/linux/reservation.h
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'quotactl' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'quota_on' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_free_mnt_opts' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_eat_lsm_opts' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_kern_mount' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_show_options' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'sb_add_mnt_opt' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'd_instantiate' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'getprocattr' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'setprocattr' not described in 'security_list_options'
> include/linux/lsm_hooks.h:1822: warning: Function parameter or member 'locked_down' not described in 'security_list_options'
> include/linux/regulator/machine.h:196: warning: Function parameter or member 'max_uV_step' not described in 'regulation_constraints'
> include/linux/regulator/driver.h:223: warning: Function parameter or member 'resume' not described in 'regulator_ops'
> include/linux/spi/spi.h:190: warning: Function parameter or member 'driver_override' not described in 'spi_device'
> fs/fs-writeback.c:913: warning: Excess function parameter 'nr_pages' description in 'cgroup_writeback_by_id'
> fs/direct-io.c:258: warning: Excess function parameter 'offset' description in 'dio_complete'
> fs/libfs.c:496: warning: Excess function parameter 'available' description in 'simple_write_end'
> fs/posix_acl.c:647: warning: Function parameter or member 'inode' not described in 'posix_acl_update_mode'
> fs/posix_acl.c:647: warning: Function parameter or member 'mode_p' not described in 'posix_acl_update_mode'
> fs/posix_acl.c:647: warning: Function parameter or member 'acl' not described in 'posix_acl_update_mode'
> drivers/usb/typec/bus.c:1: warning: 'typec_altmode_unregister_driver' not found
> drivers/usb/typec/bus.c:1: warning: 'typec_altmode_register_driver' not found
> drivers/usb/typec/class.c:1: warning: 'typec_altmode_register_notifier' not found
> drivers/usb/typec/class.c:1: warning: 'typec_altmode_unregister_notifier' not found
> include/linux/w1.h:277: warning: Function parameter or member 'of_match_table' not described in 'w1_family'
> drivers/gpio/gpiolib-of.c:92: warning: Excess function parameter 'dev' description in 'of_gpio_need_valid_mask'
> include/linux/i2c.h:337: warning: Function parameter or member 'init_irq' not described in 'i2c_client'
> >> 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'
> kernel/dma/coherent.c:1: warning: no structured comments found
> include/linux/input/sparse-keymap.h:43: warning: Function parameter or member 'sw' not described in 'key_entry'
> include/linux/skbuff.h:888: warning: Function parameter or member 'dev_scratch' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'list' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'ip_defrag_offset' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'skb_mstamp_ns' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member '__cloned_offset' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'head_frag' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member '__pkt_type_offset' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'encapsulation' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'encap_hdr_csum' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'csum_valid' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member '__pkt_vlan_present_offset' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'vlan_present' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'csum_complete_sw' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'csum_level' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'inner_protocol_type' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'remcsum_offload' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'sender_cpu' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'reserved_tailroom' not described in 'sk_buff'
> include/linux/skbuff.h:888: warning: Function parameter or member 'inner_ipproto' not described in 'sk_buff'
> include/net/sock.h:233: warning: Function parameter or member 'skc_addrpair' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_portpair' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_ipv6only' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_net_refcnt' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_v6_daddr' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_v6_rcv_saddr' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_cookie' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_listener' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_tw_dr' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_rcv_wnd' not described in 'sock_common'
> include/net/sock.h:233: warning: Function parameter or member 'skc_tw_rcv_nxt' not described in 'sock_common'
> include/net/sock.h:515: warning: Function parameter or member 'sk_rx_skb_cache' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'sk_wq_raw' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'tcp_rtx_queue' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'sk_tx_skb_cache' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'sk_route_forced_caps' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'sk_txtime_report_errors' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'sk_validate_xmit_skb' not described in 'sock'
> include/net/sock.h:515: warning: Function parameter or member 'sk_bpf_storage' not described in 'sock'
> include/net/sock.h:2439: warning: Function parameter or member 'tcp_rx_skb_cache_key' not described in 'DECLARE_STATIC_KEY_FALSE'
> include/net/sock.h:2439: warning: Excess function parameter 'sk' description in 'DECLARE_STATIC_KEY_FALSE'
> include/net/sock.h:2439: warning: Excess function parameter 'skb' description in 'DECLARE_STATIC_KEY_FALSE'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'gso_partial_features' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'l3mdev_ops' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'xfrmdev_ops' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'tlsdev_ops' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'name_assign_type' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'ieee802154_ptr' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'mpls_ptr' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'xdp_prog' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'gro_flush_timeout' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'nf_hooks_ingress' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member '____cacheline_aligned_in_smp' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'qdisc_hash' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'xps_cpus_map' not described in 'net_device'
> include/linux/netdevice.h:2053: warning: Function parameter or member 'xps_rxqs_map' not described in 'net_device'
> include/linux/phylink.h:56: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising' not described in 'phylink_link_state'
> include/linux/phylink.h:56: warning: Function parameter or member '__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising' not described in 'phylink_link_state'
> drivers/net/phy/phylink.c:595: warning: Function parameter or member 'config' not described in 'phylink_create'
> drivers/net/phy/phylink.c:595: warning: Excess function parameter 'ndev' description in 'phylink_create'
> lib/genalloc.c:1: warning: 'gen_pool_add_virt' not found
> lib/genalloc.c:1: warning: 'gen_pool_alloc' not found
> lib/genalloc.c:1: warning: 'gen_pool_free' not found
> lib/genalloc.c:1: warning: 'gen_pool_alloc_algo' not found
> include/linux/bitmap.h:341: warning: Function parameter or member 'nbits' not described in 'bitmap_or_equal'
> include/linux/rculist.h:374: warning: Excess function parameter 'cond' description in 'list_for_each_entry_rcu'
> include/linux/rculist.h:651: warning: Excess function parameter 'cond' description in 'hlist_for_each_entry_rcu'
> mm/util.c:1: warning: 'get_user_pages_fast' not found
> mm/slab.c:4215: warning: Function parameter or member 'objp' not described in '__ksize'
> drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c:335: warning: Excess function parameter 'dev' description in 'amdgpu_gem_prime_export'
> drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c:336: warning: Excess function parameter 'dev' description in 'amdgpu_gem_prime_export'
> drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:142: warning: Function parameter or member 'blockable' not described in 'amdgpu_mn_read_lock'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:347: warning: cannot understand function prototype: 'struct amdgpu_vm_pt_cursor '
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:348: warning: cannot understand function prototype: 'struct amdgpu_vm_pt_cursor '
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:494: warning: Function parameter or member 'start' not described in 'amdgpu_vm_pt_first_dfs'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'adev' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'vm' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'start' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'cursor' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'entry' not described in 'for_each_amdgpu_vm_pt_dfs_safe'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:823: warning: Function parameter or member 'level' not described in 'amdgpu_vm_bo_param'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'params' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'bo' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'level' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'pe' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'addr' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'count' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'incr' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'flags' not described in 'amdgpu_vm_update_flags'
> drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:2823: warning: Function parameter or member 'pasid' not described in 'amdgpu_vm_make_compute'
> drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:378: warning: Excess function parameter 'entry' description in 'amdgpu_irq_dispatch'
> drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:379: warning: Function parameter or member 'ih' not described in 'amdgpu_irq_dispatch'
> drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:379: warning: Excess function parameter 'entry' description in 'amdgpu_irq_dispatch'
> drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c:1: warning: no structured comments found
> drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c:1: warning: no structured comments found
> drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c:1: warning: 'pp_dpm_sclk pp_dpm_mclk pp_dpm_pcie' not found
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:132: warning: Incorrect use of kernel-doc format: Documentation Makefile include scripts source @atomic_obj
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:238: warning: Incorrect use of kernel-doc format: Documentation Makefile include scripts source gpu_info FW provided soc bounding box struct or 0 if not
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:243: warning: Function parameter or member 'atomic_obj' not described in 'amdgpu_display_manager'
>
> vim +401 drivers/infiniband/ulp/iser/iscsi_iser.h
>
> 5587856c9659ac Sagi Grimberg 2013-07-28 @401
> 385ad87d4b637c Sagi Grimberg 2015-08-06 402 /**
> e506e0f630a40d rd.dunlab@gmail.com 2019-10-09 403 * struct iser_fr_pool - connection fast registration pool
> 385ad87d4b637c Sagi Grimberg 2015-08-06 404 *
> 2b3bf958103899 Adir Lev 2015-08-06 405 * @list: list of fastreg descriptors
> 385ad87d4b637c Sagi Grimberg 2015-08-06 406 * @lock: protects fmr/fastreg pool
> 2b3bf958103899 Adir Lev 2015-08-06 407 * @size: size of the pool
> 385ad87d4b637c Sagi Grimberg 2015-08-06 408 */
> 385ad87d4b637c Sagi Grimberg 2015-08-06 409 struct iser_fr_pool {
> 2b3bf958103899 Adir Lev 2015-08-06 410 struct list_head list;
> 385ad87d4b637c Sagi Grimberg 2015-08-06 411 spinlock_t lock;
> 2b3bf958103899 Adir Lev 2015-08-06 412 int size;
> ea174c9573b0e0 Sagi Grimberg 2017-02-27 413 struct list_head all_list;
> 385ad87d4b637c Sagi Grimberg 2015-08-06 414 };
> 385ad87d4b637c Sagi Grimberg 2015-08-06 @415
>
> :::::: The code at line 401 was first introduced by commit
> :::::: 5587856c9659ac2d6ab201141aa8a5c2ff3be4cd IB/iser: Introduce fast memory registration model (FRWR)
>
> :::::: TO: Sagi Grimberg <sagig@mellanox.com>
> :::::: CC: Roland Dreier <roland@purestorage.com>
>
> 0-DAY kernel test infrastructure Open Source Technology Center
> https://lists.01.org/pipermail/kbuild-all Intel Corporation
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband
2019-10-21 17:07 ` Jason Gunthorpe
@ 2019-10-21 21:57 ` Randy Dunlap
0 siblings, 0 replies; 26+ messages in thread
From: Randy Dunlap @ 2019-10-21 21:57 UTC (permalink / raw)
To: Jason Gunthorpe, kbuild test robot
Cc: rd.dunlab, kbuild-all, linux-rdma, Doug Ledford, linux-doc
On 10/21/19 10:07 AM, Jason Gunthorpe wrote:
> Randy,
>
> What do you want to do with this series? Is this error below related
> needing respin, or just noise?
>
> Thanks,
> Jason
Hi Jason,
I certainly would like to see patches 1-11 merged since they do lots of
cleanups/fixes that I prefer not to be lost.
If you don't want to merge patch 12, so be it.
My docs build has a total of 8 errors and 173 warnings, so I consider these
just more noise. Please note that I am also working on cleaning up lots of
that noise.
Patches 3 and 7 mention new warnings that I am already aware of.
If you can tell me what the 'all_list' field [below] is/means,
I'll be glad to add a patch for that.
> On Thu, Oct 10, 2019 at 11:45:28PM +0800, kbuild test robot wrote:
>> Hi,
>>
>> Thank you for the patch! Perhaps something to improve:
>>
>> [auto build test WARNING on rdma/for-next]
>> [cannot apply to v5.4-rc2 next-20191010]
>> [if your patch is applied to the wrong git tree, please drop us a note to help
>> improve the system. BTW, we also suggest to use '--base' option to specify the
>> base tree in git format-patch, please see https://stackoverflow.com/a/37406982]
>>
>> url: https://github.com/0day-ci/linux/commits/rd-dunlab-gmail-com/infiniband-kernel-doc-fixes-driver-api-chapter/20191010-220426
>> base: https://git.kernel.org/pub/scm/linux/kernel/git/rdma/rdma.git for-next
>> reproduce: make htmldocs
>>
>> If you fix the issue, kindly add following tag
>> Reported-by: kbuild test robot <lkp@intel.com>
>>
>> All warnings (new ones prefixed by >>):
>>
[cutting non-related errors/warnings]
>>>> 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'
>>
>> vim +401 drivers/infiniband/ulp/iser/iscsi_iser.h
>>
>> 5587856c9659ac Sagi Grimberg 2013-07-28 @401
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 402 /**
>> e506e0f630a40d rd.dunlab@gmail.com 2019-10-09 403 * struct iser_fr_pool - connection fast registration pool
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 404 *
>> 2b3bf958103899 Adir Lev 2015-08-06 405 * @list: list of fastreg descriptors
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 406 * @lock: protects fmr/fastreg pool
>> 2b3bf958103899 Adir Lev 2015-08-06 407 * @size: size of the pool
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 408 */
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 409 struct iser_fr_pool {
>> 2b3bf958103899 Adir Lev 2015-08-06 410 struct list_head list;
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 411 spinlock_t lock;
>> 2b3bf958103899 Adir Lev 2015-08-06 412 int size;
>> ea174c9573b0e0 Sagi Grimberg 2017-02-27 413 struct list_head all_list;
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 414 };
>> 385ad87d4b637c Sagi Grimberg 2015-08-06 @415
>>
>> :::::: The code at line 401 was first introduced by commit
>> :::::: 5587856c9659ac2d6ab201141aa8a5c2ff3be4cd IB/iser: Introduce fast memory registration model (FRWR)
thanks,
--
~Randy
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
2019-10-10 3:52 ` [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h " rd.dunlab
@ 2019-10-22 17:52 ` Jason Gunthorpe
2019-10-22 19:51 ` Randy Dunlap
0 siblings, 1 reply; 26+ messages in thread
From: Jason Gunthorpe @ 2019-10-22 17:52 UTC (permalink / raw)
To: rd.dunlab; +Cc: linux-rdma, Doug Ledford, linux-doc, Randy Dunlap
On Wed, Oct 09, 2019 at 08:52:44PM -0700, rd.dunlab@gmail.com wrote:
> Make reserved struct fields "private:" so that they don't need to
> be added to the kernel-doc notation. This removes 24 warnings.
> +++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
> @@ -129,21 +129,31 @@ struct opa_vesw_info {
> __be16 fabric_id;
> __be16 vesw_id;
>
> + /* private: */
> u8 rsvd0[6];
> + /* public: */
> __be16 def_port_mask;
This seems overly ugly, is there some other way to handle these
reserved fields? Maybe wire protocol structures shouldn't be kdoc?
Jason
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
` (11 preceding siblings ...)
2019-10-10 3:52 ` [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband rd.dunlab
@ 2019-10-22 18:41 ` Jason Gunthorpe
2019-10-22 22:51 ` Max Gurtovoy
2019-10-23 11:54 ` Dennis Dalessandro
12 siblings, 2 replies; 26+ messages in thread
From: Jason Gunthorpe @ 2019-10-22 18:41 UTC (permalink / raw)
To: rd.dunlab, Max Gurtovoy; +Cc: linux-rdma, Doug Ledford, linux-doc, Randy Dunlap
On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
>
> 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'
Maybe Max can help?
> ../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 don't know what to make of these either.
Anyhow, it is an overall improvement, so I applied everything but
[05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
pending some discussion.
Thanks,
Jason
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
2019-10-22 17:52 ` Jason Gunthorpe
@ 2019-10-22 19:51 ` Randy Dunlap
2019-10-23 7:26 ` Jani Nikula
2019-10-23 12:03 ` Dennis Dalessandro
0 siblings, 2 replies; 26+ messages in thread
From: Randy Dunlap @ 2019-10-22 19:51 UTC (permalink / raw)
To: Jason Gunthorpe, rd.dunlab; +Cc: linux-rdma, Doug Ledford, linux-doc
On 10/22/19 10:52 AM, Jason Gunthorpe wrote:
> On Wed, Oct 09, 2019 at 08:52:44PM -0700, rd.dunlab@gmail.com wrote:
>> Make reserved struct fields "private:" so that they don't need to
>> be added to the kernel-doc notation. This removes 24 warnings.
>
>> +++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
>> @@ -129,21 +129,31 @@ struct opa_vesw_info {
>> __be16 fabric_id;
>> __be16 vesw_id;
>>
>> + /* private: */
>> u8 rsvd0[6];
>> + /* public: */
>> __be16 def_port_mask;
>
> This seems overly ugly, is there some other way to handle these
> reserved fields? Maybe wire protocol structures shouldn't be kdoc?
I don't know of any other way to handle them with kernel-doc.
Sure, changing the /** to just /* would be one way to hide the
warnings. Either this patch or not having them be kernel-doc
is needed just to "fix" 24 warnings.
--
~Randy
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
@ 2019-10-22 22:51 ` Max Gurtovoy
2019-10-23 11:54 ` Dennis Dalessandro
1 sibling, 0 replies; 26+ messages in thread
From: Max Gurtovoy @ 2019-10-22 22:51 UTC (permalink / raw)
To: Jason Gunthorpe, rd.dunlab
Cc: linux-rdma, Doug Ledford, linux-doc, Randy Dunlap
On 10/22/2019 9:41 PM, Jason Gunthorpe wrote:
> On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
>> 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'
@all_list: entry in the entire fastreg descriptors list
or
@all_list: entry in the whole fastreg descriptors list
>> ../drivers/infiniband/ulp/iser/iscsi_iser.h:415: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool'
@all_list: list of all fastreg descriptors for the connection
> Maybe Max can help?
>
>> ../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 don't know what to make of these either.
>
> Anyhow, it is an overall improvement, so I applied everything but
>
> [05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
>
> pending some discussion.
>
> Thanks,
> Jason
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
2019-10-22 19:51 ` Randy Dunlap
@ 2019-10-23 7:26 ` Jani Nikula
2019-10-23 12:03 ` Dennis Dalessandro
1 sibling, 0 replies; 26+ messages in thread
From: Jani Nikula @ 2019-10-23 7:26 UTC (permalink / raw)
To: Randy Dunlap, Jason Gunthorpe, rd.dunlab
Cc: linux-rdma, Doug Ledford, linux-doc, Jonathan Corbet
On Tue, 22 Oct 2019, Randy Dunlap <rdunlap@infradead.org> wrote:
> On 10/22/19 10:52 AM, Jason Gunthorpe wrote:
>> On Wed, Oct 09, 2019 at 08:52:44PM -0700, rd.dunlab@gmail.com wrote:
>>> Make reserved struct fields "private:" so that they don't need to
>>> be added to the kernel-doc notation. This removes 24 warnings.
>>
>>> +++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
>>> @@ -129,21 +129,31 @@ struct opa_vesw_info {
>>> __be16 fabric_id;
>>> __be16 vesw_id;
>>>
>>> + /* private: */
>>> u8 rsvd0[6];
>>> + /* public: */
>>> __be16 def_port_mask;
>>
>> This seems overly ugly, is there some other way to handle these
>> reserved fields? Maybe wire protocol structures shouldn't be kdoc?
>
> I don't know of any other way to handle them with kernel-doc.
> Sure, changing the /** to just /* would be one way to hide the
> warnings. Either this patch or not having them be kernel-doc
> is needed just to "fix" 24 warnings.
The currently available options are:
- The patch at hand (private/public comments). Ugly and verbose.
- Document the structs using regular comments instead of
kernel-doc. Might be suitable here, but not a generally useful
approach. Loses all format checking and generated documentation.
- Also document the reserved fields. Ugly and verbose, also in the
generated documentation.
Some options that I think might be relatively easy to implement:
- Add struct documentation comment indicator to not complain about
missing member documentation. Some special tag in the struct
comment. This would also ignore members that actually need to be
documented.
- Add support for designating private members in the member
documentation, i.e. require the documentation, but omit the members
from the generated document. Something like this, with PRIVATE
replaced with your favorite bikeshed colors:
/**
* @rsvd0: PRIVATE
*/
This could be used either in the struct documentation comment or in
the inline member documentation comment. Less ugly than the patch at
hand, and arguably a better notation, but still requires documenting
the members.
- Add support for a catch-all member documentation comment, for example:
/**
* struct foo - bar
* @*: This member is private.
*/
Would generate the documentation for the member with the catch-all
documentation, which might be a generally useful feature, and would be
easy on the source code side. This could be combined with the PRIVATE
designation above, practically leading to the same result as the first
option but with more flexibility.
BR,
Jani.
--
Jani Nikula, Intel Open Source Graphics Center
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
2019-10-22 22:51 ` Max Gurtovoy
@ 2019-10-23 11:54 ` Dennis Dalessandro
2019-10-23 14:39 ` Jason Gunthorpe
1 sibling, 1 reply; 26+ messages in thread
From: Dennis Dalessandro @ 2019-10-23 11:54 UTC (permalink / raw)
To: Jason Gunthorpe, rd.dunlab, Max Gurtovoy
Cc: linux-rdma, Doug Ledford, linux-doc, Randy Dunlap
On 10/22/2019 2:41 PM, Jason Gunthorpe wrote:
> On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
>>
>> 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'
>
> Maybe Max can help?
>
>> ../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 don't know what to make of these either.
>
> Anyhow, it is an overall improvement, so I applied everything but
>
> [05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
Safe to assume the kbuild robot failure [1] is a result of this?
[1] https://marc.info/?l=linux-rdma&m=157177785916141&w=2
-Denny
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
2019-10-22 19:51 ` Randy Dunlap
2019-10-23 7:26 ` Jani Nikula
@ 2019-10-23 12:03 ` Dennis Dalessandro
1 sibling, 0 replies; 26+ messages in thread
From: Dennis Dalessandro @ 2019-10-23 12:03 UTC (permalink / raw)
To: Randy Dunlap, Jason Gunthorpe, rd.dunlab
Cc: linux-rdma, Doug Ledford, linux-doc
On 10/22/2019 3:51 PM, Randy Dunlap wrote:
> On 10/22/19 10:52 AM, Jason Gunthorpe wrote:
>> On Wed, Oct 09, 2019 at 08:52:44PM -0700, rd.dunlab@gmail.com wrote:
>>> Make reserved struct fields "private:" so that they don't need to
>>> be added to the kernel-doc notation. This removes 24 warnings.
>>
>>> +++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
>>> @@ -129,21 +129,31 @@ struct opa_vesw_info {
>>> __be16 fabric_id;
>>> __be16 vesw_id;
>>>
>>> + /* private: */
>>> u8 rsvd0[6];
>>> + /* public: */
>>> __be16 def_port_mask;
>>
>> This seems overly ugly, is there some other way to handle these
>> reserved fields? Maybe wire protocol structures shouldn't be kdoc?
>
> I don't know of any other way to handle them with kernel-doc.
> Sure, changing the /** to just /* would be one way to hide the
> warnings. Either this patch or not having them be kernel-doc
> is needed just to "fix" 24 warnings.
>
I would be in favor of just not including this in kernel-doc at this
time, but the mess of private/public tags while hard on the eyes doesn't
really bother me either.
Also wouldn't take this as a statement that wire protocol structures not
be in kdoc, but just that this one doesn't need to be there.
-Denny
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter
2019-10-23 11:54 ` Dennis Dalessandro
@ 2019-10-23 14:39 ` Jason Gunthorpe
0 siblings, 0 replies; 26+ messages in thread
From: Jason Gunthorpe @ 2019-10-23 14:39 UTC (permalink / raw)
To: Dennis Dalessandro
Cc: rd.dunlab, Max Gurtovoy, linux-rdma, Doug Ledford, linux-doc,
Randy Dunlap
On Wed, Oct 23, 2019 at 07:54:46AM -0400, Dennis Dalessandro wrote:
> On 10/22/2019 2:41 PM, Jason Gunthorpe wrote:
> > On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
> > >
> > > 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'
> >
> > Maybe Max can help?
> >
> > > ../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 don't know what to make of these either.
> >
> > Anyhow, it is an overall improvement, so I applied everything but
> >
> > [05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
>
> Safe to assume the kbuild robot failure [1] is a result of this?
>
> [1] https://marc.info/?l=linux-rdma&m=157177785916141&w=2
Yes, just more warnings
Jason
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notation
2019-10-10 3:52 ` [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h " rd.dunlab
@ 2019-10-23 20:30 ` Bart Van Assche
2019-10-23 20:39 ` Randy Dunlap
0 siblings, 1 reply; 26+ messages in thread
From: Bart Van Assche @ 2019-10-23 20:30 UTC (permalink / raw)
To: rd.dunlab, linux-rdma
Cc: Doug Ledford, Jason Gunthorpe, linux-doc, Randy Dunlap
On 2019-10-09 20:52, rd.dunlab@gmail.com wrote:
> --- linux-next-20191009.orig/drivers/infiniband/ulp/srpt/ib_srpt.h
> +++ linux-next-20191009/drivers/infiniband/ulp/srpt/ib_srpt.h
> @@ -387,12 +387,9 @@ struct srpt_port_id {
> * @sm_lid: cached value of the port's sm_lid.
> * @lid: cached value of the port's lid.
> * @gid: cached value of the port's gid.
> - * @port_acl_lock spinlock for port_acl_list:
> * @work: work structure for refreshing the aforementioned cached values.
> - * @port_guid_tpg: TPG associated with target port GUID.
> - * @port_guid_wwn: WWN associated with target port GUID.
> - * @port_gid_tpg: TPG associated with target port GID.
> - * @port_gid_wwn: WWN associated with target port GID.
> + * @port_guid_id: target port GUID
> + * @port_gid_id: target port GID
> * @port_attrib: Port attributes that can be accessed through configfs.
> * @refcount: Number of objects associated with this port.
> * @freed_channels: Completion that will be signaled once @refcount becomes 0.
This is sufficient to silence the warnings reported by the kernel-doc
tool but I don't think that the new descriptions make really clear what
these structure members represent. Do you want to address this or do you
expect me to post a follow-up patch?
Thanks,
Bart.
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notation
2019-10-23 20:30 ` Bart Van Assche
@ 2019-10-23 20:39 ` Randy Dunlap
0 siblings, 0 replies; 26+ messages in thread
From: Randy Dunlap @ 2019-10-23 20:39 UTC (permalink / raw)
To: Bart Van Assche, rd.dunlab, linux-rdma
Cc: Doug Ledford, Jason Gunthorpe, linux-doc
On 10/23/19 1:30 PM, Bart Van Assche wrote:
> On 2019-10-09 20:52, rd.dunlab@gmail.com wrote:
>> --- linux-next-20191009.orig/drivers/infiniband/ulp/srpt/ib_srpt.h
>> +++ linux-next-20191009/drivers/infiniband/ulp/srpt/ib_srpt.h
>> @@ -387,12 +387,9 @@ struct srpt_port_id {
>> * @sm_lid: cached value of the port's sm_lid.
>> * @lid: cached value of the port's lid.
>> * @gid: cached value of the port's gid.
>> - * @port_acl_lock spinlock for port_acl_list:
>> * @work: work structure for refreshing the aforementioned cached values.
>> - * @port_guid_tpg: TPG associated with target port GUID.
>> - * @port_guid_wwn: WWN associated with target port GUID.
>> - * @port_gid_tpg: TPG associated with target port GID.
>> - * @port_gid_wwn: WWN associated with target port GID.
>> + * @port_guid_id: target port GUID
>> + * @port_gid_id: target port GID
>> * @port_attrib: Port attributes that can be accessed through configfs.
>> * @refcount: Number of objects associated with this port.
>> * @freed_channels: Completion that will be signaled once @refcount becomes 0.
>
> This is sufficient to silence the warnings reported by the kernel-doc
> tool but I don't think that the new descriptions make really clear what
> these structure members represent. Do you want to address this or do you
> expect me to post a follow-up patch?
Hi Bart,
Since you know what the descriptions should say, I would appreciate it if you
would post a follow-up patch.
Thanks.
--
~Randy
^ permalink raw reply [flat|nested] 26+ messages in thread
end of thread, other threads:[~2019-10-23 20:39 UTC | newest]
Thread overview: 26+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-10 3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
2019-10-10 3:52 ` [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation rd.dunlab
2019-10-10 3:52 ` [PATCH 02/12] infiniband: fix core/ipwm_util.h kernel-doc warnings rd.dunlab
2019-10-10 3:52 ` [PATCH 03/12] infiniband: fix ulp/iser/iscsi_iser.h " rd.dunlab
2019-10-10 3:52 ` [PATCH 04/12] infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notation rd.dunlab
2019-10-10 3:52 ` [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h " rd.dunlab
2019-10-22 17:52 ` Jason Gunthorpe
2019-10-22 19:51 ` Randy Dunlap
2019-10-23 7:26 ` Jani Nikula
2019-10-23 12:03 ` Dennis Dalessandro
2019-10-10 3:52 ` [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h " rd.dunlab
2019-10-23 20:30 ` Bart Van Assche
2019-10-23 20:39 ` Randy Dunlap
2019-10-10 3:52 ` [PATCH 07/12] infiniband: fix core/verbs.c " rd.dunlab
2019-10-10 3:52 ` [PATCH 08/12] infiniband: fix ulp/iser/iser_verbs.c " rd.dunlab
2019-10-10 3:52 ` [PATCH 09/12] infiniband: fix ulp/iser/iser_initiator.c kernel-doc warnings rd.dunlab
2019-10-10 3:52 ` [PATCH 10/12] infiniband: fix core/ kernel-doc notation rd.dunlab
2019-10-10 3:52 ` [PATCH 11/12] infiniband: fix sw/rdmavt/ " rd.dunlab
2019-10-10 3:52 ` [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband rd.dunlab
2019-10-10 15:45 ` kbuild test robot
2019-10-21 17:07 ` Jason Gunthorpe
2019-10-21 21:57 ` Randy Dunlap
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
2019-10-22 22:51 ` Max Gurtovoy
2019-10-23 11:54 ` Dennis Dalessandro
2019-10-23 14:39 ` Jason Gunthorpe
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).