Message ID | 20231222234623.25231-1-rdunlap@infradead.org (mailing list archive) |
---|---|
State | Accepted |
Headers | show |
Series | IB/iser: iscsi_iser.h: fix kernel-doc warning and spellos | expand |
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 <rdunlap@infradead.org> > Cc: Sagi Grimberg <sagi@grimberg.me> > Cc: Max Gurtovoy <mgurtovoy@nvidia.com> > Cc: Jason Gunthorpe <jgg@nvidia.com> > Cc: Leon Romanovsky <leonro@nvidia.com> > Cc: linux-rdma@vger.kernel.org > --- > 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 <mgurtovoy@nvidia.com>
Reviewed-by: Sagi Grimberg <sagi@grimberg.me>
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,
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
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 <rdunlap@infradead.org> Cc: Sagi Grimberg <sagi@grimberg.me> Cc: Max Gurtovoy <mgurtovoy@nvidia.com> Cc: Jason Gunthorpe <jgg@nvidia.com> Cc: Leon Romanovsky <leonro@nvidia.com> Cc: linux-rdma@vger.kernel.org --- drivers/infiniband/ulp/iser/iscsi_iser.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)