diff mbox series

[3/8] scsi: core: add kernel-doc for scsi_msg_to_host_byte()

Message ID 20240408025425.18778-4-rdunlap@infradead.org
State New
Headers show
Series scsi: documentation: clean up docs and fix kernel-doc | expand

Commit Message

Randy Dunlap April 8, 2024, 2:54 a.m. UTC 
Add entries for missing documentation to prevent kernel-doc warnings:

scsi_cmnd.h:365: warning: Function parameter or struct member 'cmd' not described in 'scsi_msg_to_host_byte'
scsi_cmnd.h:365: warning: Function parameter or struct member 'msg' not described in 'scsi_msg_to_host_byte'

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

 include/scsi/scsi_cmnd.h |    2 ++
 1 file changed, 2 insertions(+)

Comments

Bart Van Assche April 8, 2024, 4:28 p.m. UTC | #1 
On 4/7/24 19:54, Randy Dunlap wrote:
> Add entries for missing documentation to prevent kernel-doc warnings:

Reviewed-by: Bart Van Assche <bvanassche@acm.org>
diff mbox series

Patch

diff -- a/include/scsi/scsi_cmnd.h b/include/scsi/scsi_cmnd.h
--- a/include/scsi/scsi_cmnd.h
+++ b/include/scsi/scsi_cmnd.h
@@ -353,6 +353,8 @@  static inline u8 get_host_byte(struct sc
 
 /**
  * scsi_msg_to_host_byte() - translate message byte
+ * @cmd: the SCSI command
+ * @msg: the SCSI parallel message byte to translate
  *
  * Translate the SCSI parallel message byte to a matching
  * host byte setting. A message of COMMAND_COMPLETE indicates