Skip to content

Commit aca0617

Browse files
rddunlapmartinkpetersen
authored andcommitted
scsi: mpi3mr: Fix some kernel-doc warnings in scsi_bsg_mpi3mr.h
Correct the name of a struct in kernel-doc to match the actual function name. Add kernel-doc comments for 2 reserved fields to match comments for other reserved fields. Correct the kernel-doc comments for a nested struct to eliminate kernel-doc warnings for them. Warnings fixed here are: scsi_bsg_mpi3mr.h:419: warning: expecting prototype for struct mpi3mr_bsg_buf_entry_list. Prototype was for struct mpi3mr_buf_entry_list instead scsi_bsg_mpi3mr.h:435: warning: Function parameter or struct member 'rsvd2' not described in 'mpi3mr_bsg_mptcmd' scsi_bsg_mpi3mr.h:456: warning: Function parameter or struct member 'rsvd3' not described in 'mpi3mr_bsg_packet' scsi_bsg_mpi3mr.h:456: warning: Excess struct member 'drvrcmd' description in 'mpi3mr_bsg_packet' scsi_bsg_mpi3mr.h:456: warning: Excess struct member 'mptcmd' description in 'mpi3mr_bsg_packet' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20240424055322.1400-1-rdunlap@infradead.org Cc: James E.J. Bottomley <James.Bottomley@HansenPartnership.com> Cc: Martin K. Petersen <martin.petersen@oracle.com> Cc: Sathya Prakash Veerichetty <sathya.prakash@broadcom.com> Cc: Kashyap Desai <kashyap.desai@broadcom.com> Cc: Sumit Saxena <sumit.saxena@broadcom.com> Cc: Sreekanth Reddy <sreekanth.reddy@broadcom.com> Cc: mpi3mr-linuxdrv.pdl@broadcom.com Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
1 parent de37677 commit aca0617

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

include/uapi/scsi/scsi_bsg_mpi3mr.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ struct mpi3mr_buf_entry {
401401
__u32 buf_len;
402402
};
403403
/**
404-
* struct mpi3mr_bsg_buf_entry_list - list of user buffer
404+
* struct mpi3mr_buf_entry_list - list of user buffer
405405
* descriptor for MPI Passthrough requests.
406406
*
407407
* @num_of_entries: Number of buffer descriptors
@@ -424,6 +424,7 @@ struct mpi3mr_buf_entry_list {
424424
* @mrioc_id: Controller ID
425425
* @rsvd1: Reserved
426426
* @timeout: MPI request timeout
427+
* @rsvd2: Reserved
427428
* @buf_entry_list: Buffer descriptor list
428429
*/
429430
struct mpi3mr_bsg_mptcmd {
@@ -441,8 +442,9 @@ struct mpi3mr_bsg_mptcmd {
441442
* @cmd_type: represents drvrcmd or mptcmd
442443
* @rsvd1: Reserved
443444
* @rsvd2: Reserved
444-
* @drvrcmd: driver request structure
445-
* @mptcmd: mpt request structure
445+
* @rsvd3: Reserved
446+
* @cmd.drvrcmd: driver request structure
447+
* @cmd.mptcmd: mpt request structure
446448
*/
447449
struct mpi3mr_bsg_packet {
448450
__u8 cmd_type;

0 commit comments

Comments
 (0)