2023-12-22 23:46:35

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] IB/iser: iscsi_iser.h: fix kernel-doc warning and spellos

Drop one kernel-doc comment to prevent a warning:

iscsi_iser.h:313: warning: Excess struct member 'mr' description in 'iser_device'

and spell 2 words correctly (buffer and deferred).

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Sagi Grimberg <[email protected]>
Cc: Max Gurtovoy <[email protected]>
Cc: Jason Gunthorpe <[email protected]>
Cc: Leon Romanovsky <[email protected]>
Cc: [email protected]
---
drivers/infiniband/ulp/iser/iscsi_iser.h | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)

diff -- a/drivers/infiniband/ulp/iser/iscsi_iser.h b/drivers/infiniband/ulp/iser/iscsi_iser.h
--- a/drivers/infiniband/ulp/iser/iscsi_iser.h
+++ b/drivers/infiniband/ulp/iser/iscsi_iser.h
@@ -182,7 +182,7 @@ enum iser_data_dir {
*
* @sg: pointer to the sg list
* @size: num entries of this sg
- * @data_len: total beffer byte len
+ * @data_len: total buffer byte len
* @dma_nents: returned by dma_map_sg
*/
struct iser_data_buf {
@@ -299,7 +299,6 @@ struct ib_conn;
*
* @ib_device: RDMA device
* @pd: Protection Domain for this device
- * @mr: Global DMA memory region
* @event_handler: IB events handle routine
* @ig_list: entry in devices list
* @refcount: Reference counter, dominated by open iser connections
@@ -389,7 +388,7 @@ struct ib_conn {
* to max number of post recvs
* @max_cmds: maximum cmds allowed for this connection
* @name: connection peer portal
- * @release_work: deffered work for release job
+ * @release_work: deferred work for release job
* @state_mutex: protects iser onnection state
* @stop_completion: conn_stop completion
* @ib_completion: RDMA cleanup completion


2023-12-24 00:23:57

by Max Gurtovoy

[permalink] [raw]
Subject: Re: [PATCH] IB/iser: iscsi_iser.h: fix kernel-doc warning and spellos



On 23/12/2023 1:46, Randy Dunlap wrote:
> Drop one kernel-doc comment to prevent a warning:
>
> iscsi_iser.h:313: warning: Excess struct member 'mr' description in 'iser_device'
>
> and spell 2 words correctly (buffer and deferred).
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Sagi Grimberg <[email protected]>
> Cc: Max Gurtovoy <[email protected]>
> Cc: Jason Gunthorpe <[email protected]>
> Cc: Leon Romanovsky <[email protected]>
> Cc: [email protected]
> ---
> drivers/infiniband/ulp/iser/iscsi_iser.h | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff -- a/drivers/infiniband/ulp/iser/iscsi_iser.h b/drivers/infiniband/ulp/iser/iscsi_iser.h
> --- a/drivers/infiniband/ulp/iser/iscsi_iser.h
> +++ b/drivers/infiniband/ulp/iser/iscsi_iser.h
> @@ -182,7 +182,7 @@ enum iser_data_dir {
> *
> * @sg: pointer to the sg list
> * @size: num entries of this sg
> - * @data_len: total beffer byte len
> + * @data_len: total buffer byte len
> * @dma_nents: returned by dma_map_sg
> */
> struct iser_data_buf {
> @@ -299,7 +299,6 @@ struct ib_conn;
> *
> * @ib_device: RDMA device
> * @pd: Protection Domain for this device
> - * @mr: Global DMA memory region
> * @event_handler: IB events handle routine
> * @ig_list: entry in devices list
> * @refcount: Reference counter, dominated by open iser connections
> @@ -389,7 +388,7 @@ struct ib_conn {
> * to max number of post recvs
> * @max_cmds: maximum cmds allowed for this connection
> * @name: connection peer portal
> - * @release_work: deffered work for release job
> + * @release_work: deferred work for release job
> * @state_mutex: protects iser onnection state
> * @stop_completion: conn_stop completion
> * @ib_completion: RDMA cleanup completion

Looks good,

Acked-by: Max Gurtovoy <[email protected]>

2023-12-26 08:41:33

by Leon Romanovsky

[permalink] [raw]
Subject: Re: [PATCH] IB/iser: iscsi_iser.h: fix kernel-doc warning and spellos


On Fri, 22 Dec 2023 15:46:23 -0800, Randy Dunlap wrote:
> Drop one kernel-doc comment to prevent a warning:
>
> iscsi_iser.h:313: warning: Excess struct member 'mr' description in 'iser_device'
>
> and spell 2 words correctly (buffer and deferred).
>
>
> [...]

Applied, thanks!

[1/1] IB/iser: iscsi_iser.h: fix kernel-doc warning and spellos
https://git.kernel.org/rdma/rdma/c/d42fafb895246e

Best regards,
--
Leon Romanovsky <[email protected]>