| Message ID | 20240408025425.18778-5-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | scsi: documentation: clean up docs and fix kernel-doc | expand |
Acked-by: Sagi Grimberg <sagi@grimberg.me>
On 08/04/2024 5:54, Randy Dunlap wrote: > Correct kernel-doc comments for struct iser_ctrl to prevent warnings: > > iser.h:76: warning: Function parameter or struct member 'read_stag' not described in 'iser_ctrl' > iser.h:76: warning: Excess struct member 'reaf_stag' description in 'iser_ctrl' > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > --- > Cc: "James E.J. Bottomley" <jejb@linux.ibm.com> > Cc: "Martin K. Petersen" <martin.petersen@oracle.com> > Cc: linux-scsi@vger.kernel.org > Cc: Sagi Grimberg <sagi@grimberg.me> > Cc: Max Gurtovoy <mgurtovoy@nvidia.com> > Cc: linux-rdma@vger.kernel.org > Cc: target-devel@vger.kernel.org > > include/scsi/iser.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff -- a/include/scsi/iser.h b/include/scsi/iser.h > --- a/include/scsi/iser.h > +++ b/include/scsi/iser.h > @@ -63,7 +63,7 @@ struct iser_cm_hdr { > * @rsvd: reserved > * @write_stag: write rkey > * @write_va: write virtual address > - * @reaf_stag: read rkey > + * @read_stag: read rkey > * @read_va: read virtual address > */ > struct iser_ctrl { Looks good, Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>
diff -- a/include/scsi/iser.h b/include/scsi/iser.h --- a/include/scsi/iser.h +++ b/include/scsi/iser.h @@ -63,7 +63,7 @@ struct iser_cm_hdr { * @rsvd: reserved * @write_stag: write rkey * @write_va: write virtual address - * @reaf_stag: read rkey + * @read_stag: read rkey * @read_va: read virtual address */ struct iser_ctrl {
Correct kernel-doc comments for struct iser_ctrl to prevent warnings: iser.h:76: warning: Function parameter or struct member 'read_stag' not described in 'iser_ctrl' iser.h:76: warning: Excess struct member 'reaf_stag' description in 'iser_ctrl' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> --- Cc: "James E.J. Bottomley" <jejb@linux.ibm.com> Cc: "Martin K. Petersen" <martin.petersen@oracle.com> Cc: linux-scsi@vger.kernel.org Cc: Sagi Grimberg <sagi@grimberg.me> Cc: Max Gurtovoy <mgurtovoy@nvidia.com> Cc: linux-rdma@vger.kernel.org Cc: target-devel@vger.kernel.org include/scsi/iser.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)