Skip to content

Commit

Permalink
infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation
Browse files Browse the repository at this point in the history
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.com
Signed-off-by: Randy Dunlap <rd.dunlab@gmail.com>
Reviewed-by: Jason Gunthorpe <jgg@mellanox.com>
Signed-off-by: Jason Gunthorpe <jgg@mellanox.com>
  • Loading branch information
rd.dunlab@gmail.com authored and Jason Gunthorpe committed Oct 22, 2019
1 parent a2aca4d commit df130f8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion drivers/infiniband/ulp/iser/iscsi_iser.c
Original file line number Diff line number Diff line change
Expand Up @@ -786,7 +786,7 @@ static int iscsi_iser_get_ep_param(struct iscsi_endpoint *ep,
* 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
Expand Down
8 changes: 4 additions & 4 deletions drivers/infiniband/ulp/iser/iscsi_iser.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit df130f8

Please sign in to comment.