[PATCH 0/8] scsi: documentation: clean up docs and fix kernel-doc

[PATCH 0/8] scsi: documentation: clean up docs and fix kernel-doc

[Randy Dunlap]

Clean up some SCSI doc files and fix kernel-doc in 6 header files in
include/scsi/.


 [PATCH 1/8] scsi: documentation: clean up overview
 [PATCH 2/8] scsi: documentation: clean up scsi_mid_low_api.rst
 [PATCH 3/8] scsi: core: add kernel-doc for scsi_msg_to_host_byte()
 [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning
 [PATCH 5/8] scsi: libfcoe: fix a slew of kernel-doc warnings
 [PATCH 6/8] scsi: core: add function return kernel-doc for 2 functions
 [PATCH 7/8] scsi: scsi_transport_fc: add kernel-doc for function return
 [PATCH 8/8] scsi: scsi_transport_srp: fix a couple of kernel-doc warnings

 Documentation/driver-api/scsi.rst       |   15 ++++++-------
 Documentation/scsi/scsi_mid_low_api.rst |   20 ++++++++---------
 include/scsi/iser.h                     |    2 -
 include/scsi/libfcoe.h                  |   25 +++++++++++++++-------
 include/scsi/scsi.h                     |    7 +++---
 include/scsi/scsi_cmnd.h                |    2 +
 include/scsi/scsi_transport_fc.h        |    5 +---
 include/scsi/scsi_transport_srp.h       |    4 +--
 8 files changed, 46 insertions(+), 34 deletions(-)


Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Cc: Doug Gilbert <dgilbert@interlog.com>
Cc: Sagi Grimberg <sagi@grimberg.me>
Cc: Max Gurtovoy <mgurtovoy@nvidia.com>
Cc: linux-rdma@vger.kernel.org
Cc: target-devel@vger.kernel.org
Cc: Hannes Reinecke <hare@suse.de>
Cc: Bart Van Assche <bvanassche@acm.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org

[PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning

[Randy Dunlap]

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 {

Re: [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning

[Sagi Grimberg]

Acked-by: Sagi Grimberg <sagi@grimberg.me>

Re: [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning

[Max Gurtovoy]

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>

Re: [PATCH 0/8] scsi: documentation: clean up docs and fix kernel-doc

[Martin K. Petersen]

Randy,

> Clean up some SCSI doc files and fix kernel-doc in 6 header files in
> include/scsi/.

Applied to 6.10/scsi-staging, thanks!

-- 
Martin K. Petersen	Oracle Linux Engineering

Re: [PATCH 0/8] scsi: documentation: clean up docs and fix kernel-doc

[Martin K. Petersen]

On Sun, 07 Apr 2024 19:54:17 -0700, Randy Dunlap wrote:

> Clean up some SCSI doc files and fix kernel-doc in 6 header files in
> include/scsi/.
> 
> 
>  [PATCH 1/8] scsi: documentation: clean up overview
>  [PATCH 2/8] scsi: documentation: clean up scsi_mid_low_api.rst
>  [PATCH 3/8] scsi: core: add kernel-doc for scsi_msg_to_host_byte()
>  [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning
>  [PATCH 5/8] scsi: libfcoe: fix a slew of kernel-doc warnings
>  [PATCH 6/8] scsi: core: add function return kernel-doc for 2 functions
>  [PATCH 7/8] scsi: scsi_transport_fc: add kernel-doc for function return
>  [PATCH 8/8] scsi: scsi_transport_srp: fix a couple of kernel-doc warnings
> 
> [...]

Applied to 6.10/scsi-queue, thanks!

[1/8] scsi: documentation: clean up scsi_mid_low_api.rst
      https://git.kernel.org/mkp/scsi/c/c3bf7774fa24
[2/8] scsi: documentation: clean up overview
      https://git.kernel.org/mkp/scsi/c/293fcea539b5
[3/8] scsi: core: add kernel-doc for scsi_msg_to_host_byte()
      https://git.kernel.org/mkp/scsi/c/fcf8829fd993
[4/8] scsi: iser: fix @read_stag kernel-doc warning
      https://git.kernel.org/mkp/scsi/c/11d99e91846a
[5/8] scsi: libfcoe: fix a slew of kernel-doc warnings
      https://git.kernel.org/mkp/scsi/c/d9c911824145
[6/8] scsi: core: add function return kernel-doc for 2 functions
      https://git.kernel.org/mkp/scsi/c/8d523f0f5383
[7/8] scsi: scsi_transport_fc: add kernel-doc for function return
      https://git.kernel.org/mkp/scsi/c/007c04e53526
[8/8] scsi: scsi_transport_srp: fix a couple of kernel-doc warnings
      https://git.kernel.org/mkp/scsi/c/a2530eb748ff

-- 
Martin K. Petersen	Oracle Linux Engineering