]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
scsi: core: Fix kernel doc for scsi_track_queue_full()
authorBagas Sanjaya <bagasdotme@gmail.com>
Wed, 2 Jul 2025 03:58:23 +0000 (10:58 +0700)
committerMartin K. Petersen <martin.petersen@oracle.com>
Tue, 15 Jul 2025 00:56:55 +0000 (20:56 -0400)
Sphinx reports indentation warning on scsi_track_queue_full() return
values:

Documentation/driver-api/scsi:101: ./drivers/scsi/scsi.c:247: ERROR: Unexpected indentation. [docutils]

Fix the warning by making the return values listing a bullet list.

Fixes: eb44820c28bc ("[SCSI] Add Documentation and integrate into docbook build")
Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20250702035822.18072-2-bagasdotme@gmail.com
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/scsi/scsi.c

index 534310224e8f8479b9d9589ae01c641e219d518c..9a0f467264b35f8e97edca8644723ae19cf400b7 100644 (file)
@@ -242,9 +242,11 @@ EXPORT_SYMBOL(scsi_change_queue_depth);
  *             specific SCSI device to determine if and when there is a
  *             need to adjust the queue depth on the device.
  *
- * Returns:    0 - No change needed, >0 - Adjust queue depth to this new depth,
- *             -1 - Drop back to untagged operation using host->cmd_per_lun
- *                     as the untagged command depth
+ * Returns:
+ * * 0 - No change needed
+ * * >0 - Adjust queue depth to this new depth,
+ * * -1 - Drop back to untagged operation using host->cmd_per_lun as the
+ *   untagged command depth
  *
  * Lock Status:        None held on entry
  *