diff mbox series

scsi: ufs: scsi_bsg_ufs.h: fix all kernel-doc warnings

Message ID 20240424055316.1384-1-rdunlap@infradead.org (mailing list archive)
State Accepted
Headers show
Series scsi: ufs: scsi_bsg_ufs.h: fix all kernel-doc warnings | expand

Commit Message

Randy Dunlap April 24, 2024, 5:53 a.m. UTC
In struct utp_upiu_query_v4_0, add description for @osf3 and mark
the @reserved field as private so that no description is needed for it.

In struct utp_upiu_cmd, use the correct struct member name to
eliminate a kernel-doc warning.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: Alim Akhtar <alim.akhtar@samsung.com>
Cc: Avri Altman <avri.altman@wdc.com>
Cc: Bart Van Assche <bvanassche@acm.org>
---
 include/uapi/scsi/scsi_bsg_ufs.h |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Martin K. Petersen April 25, 2024, 1:30 a.m. UTC | #1
Randy,

> In struct utp_upiu_query_v4_0, add description for @osf3 and mark
> the @reserved field as private so that no description is needed for it.
>
> In struct utp_upiu_cmd, use the correct struct member name to
> eliminate a kernel-doc warning.

Applied to 6.10/scsi-staging, thanks!
Martin K. Petersen May 7, 2024, 1:59 a.m. UTC | #2
On Tue, 23 Apr 2024 22:53:16 -0700, Randy Dunlap wrote:

> In struct utp_upiu_query_v4_0, add description for @osf3 and mark
> the @reserved field as private so that no description is needed for it.
> 
> In struct utp_upiu_cmd, use the correct struct member name to
> eliminate a kernel-doc warning.
> 
> 
> [...]

Applied to 6.10/scsi-queue, thanks!

[1/1] scsi: ufs: scsi_bsg_ufs.h: fix all kernel-doc warnings
      https://git.kernel.org/mkp/scsi/c/de37677ef17d
diff mbox series

Patch

diff -- a/include/uapi/scsi/scsi_bsg_ufs.h b/include/uapi/scsi/scsi_bsg_ufs.h
--- a/include/uapi/scsi/scsi_bsg_ufs.h
+++ b/include/uapi/scsi/scsi_bsg_ufs.h
@@ -123,6 +123,7 @@  struct utp_upiu_query {
  * @idn: a value that indicates the particular type of data B-1
  * @index: Index to further identify data B-2
  * @selector: Index to further identify data B-3
+ * @osf3: spec field B-4
  * @osf4: spec field B-5
  * @osf5: spec field B 6,7
  * @osf6: spec field DW 8,9
@@ -138,12 +139,13 @@  struct utp_upiu_query_v4_0 {
 	__be16 osf5;
 	__be32 osf6;
 	__be32 osf7;
+	/* private: */
 	__be32 reserved;
 };
 
 /**
  * struct utp_upiu_cmd - Command UPIU structure
- * @data_transfer_len: Data Transfer Length DW-3
+ * @exp_data_transfer_len: Data Transfer Length DW-3
  * @cdb: Command Descriptor Block CDB DW-4 to DW-7
  */
 struct utp_upiu_cmd {