[PATCH v2] scsi: Format scsi_track_queue_full() return values as bullet list

[PATCH v2] scsi: Format scsi_track_queue_full() return values as bullet list

[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.

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>
---
Changes since v1 [1]:
  * Follow kernel-doc style on return list (Bart)

[1]: https://lore.kernel.org/r/20250626041857.44259-2-bagasdotme@gmail.com/

 drivers/scsi/scsi.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/drivers/scsi/scsi.c b/drivers/scsi/scsi.c
index 518a252eb6aa05..c2527dd289d9eb 100644
--- a/drivers/scsi/scsi.c
+++ b/drivers/scsi/scsi.c
@@ -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
  *
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH v2] scsi: Format scsi_track_queue_full() return values as bullet list

[Martin K. Petersen]

Bagas,

> 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!

-- 
Martin K. Petersen

Re: [PATCH v2] scsi: Format scsi_track_queue_full() return values as bullet list

[Martin K. Petersen]

On Wed, 02 Jul 2025 10:58:23 +0700, Bagas Sanjaya wrote:

> 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

-- 
Martin K. Petersen	Oracle Linux Engineering