Skip to contentSkip to conversation

scsi: Format scsi_track_queue_full() return values as bullet list

PATCH Applied Bagas Sanjaya 2 participants 3 messages Jul 2, 2025 – Jul 22, 2025 SCSI

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 scsi: Format scsi_track_queue_full() return values as bullet list

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")

---
Changes since v1 [1]:
* Follow kernel-doc style on return list (Bart)

[1]: https://lore.kernel.org/r/[email protected]/

 drivers/scsi/scsi.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/scsi/scsi.c +5 -3
index 518a252eb6aa05..c2527dd289d9eb 100644
@@ -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
  *
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

Bagas,

Quoted 4 lines

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]

Applied to 6.17/scsi-staging, thanks!

Signature · 1 line
Martin K. Petersen
#2 lore raw
In reply to Bagas Sanjaya
Quoted 8 lines · Bagas Sanjaya

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.

[...]

Applied to 6.17/scsi-queue, thanks!

[1/1] scsi: Format scsi_track_queue_full() return values as bullet list

      https://git.kernel.org/mkp/scsi/c/6070bd558aee
Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering