Commit df130f87 authored by rd.dunlab@gmail.com's avatar rd.dunlab@gmail.com Committed by Jason Gunthorpe

infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation

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'

Link: https://lore.kernel.org/r/20191010035239.623888112@gmail.comSigned-off-by: default avatarRandy Dunlap <rd.dunlab@gmail.com>
Reviewed-by: default avatarJason Gunthorpe <jgg@mellanox.com>
Signed-off-by: default avatarJason Gunthorpe <jgg@mellanox.com>
parent a2aca4d7
...@@ -786,7 +786,7 @@ static int iscsi_iser_get_ep_param(struct iscsi_endpoint *ep, ...@@ -786,7 +786,7 @@ static int iscsi_iser_get_ep_param(struct iscsi_endpoint *ep,
* iscsi_iser_ep_connect() - Initiate iSER connection establishment * iscsi_iser_ep_connect() - Initiate iSER connection establishment
* @shost: scsi_host * @shost: scsi_host
* @dst_addr: destination address * @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. * Allocate an iscsi endpoint, an iser_conn structure and bind them.
* After that start RDMA connection establishment via rdma_cm. We * After that start RDMA connection establishment via rdma_cm. We
......
...@@ -311,7 +311,7 @@ struct iser_comp { ...@@ -311,7 +311,7 @@ struct iser_comp {
}; };
/** /**
* struct iser_device - Memory registration operations * struct iser_reg_ops - Memory registration operations
* per-device registration schemes * per-device registration schemes
* *
* @alloc_reg_res: Allocate registration resources * @alloc_reg_res: Allocate registration resources
...@@ -365,7 +365,7 @@ struct iser_device { ...@@ -365,7 +365,7 @@ struct iser_device {
}; };
/** /**
* struct iser_reg_resources - Fast registration recources * struct iser_reg_resources - Fast registration resources
* *
* @mr: memory region * @mr: memory region
* @fmr_pool: pool of fmrs * @fmr_pool: pool of fmrs
...@@ -398,7 +398,7 @@ struct iser_fr_desc { ...@@ -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 * @list: list of fastreg descriptors
* @lock: protects fmr/fastreg pool * @lock: protects fmr/fastreg pool
...@@ -521,7 +521,7 @@ struct iser_page_vec { ...@@ -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_mutex: protects device_list
* @device_list: iser devices global list * @device_list: iser devices global list
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment