drivers/scsi/scsi.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
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>
---
drivers/scsi/scsi.c | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/drivers/scsi/scsi.c b/drivers/scsi/scsi.c
index 518a252eb6aa05..ca8cf50824f35d 100644
--- a/drivers/scsi/scsi.c
+++ b/drivers/scsi/scsi.c
@@ -242,9 +242,10 @@ 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
On 6/25/25 9:18 PM, Bagas Sanjaya wrote: > - * 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 > * Here is an example from Documentation/doc-guide/kernel-doc.rst: * Return: * * %0 - OK to runtime suspend the device * * %-EBUSY - Device should not be runtime suspended Wouldn't it be better to follow that example and to move the list under 'Returns:' and to move it more to the left? Thanks, Bart.
On 6/26/25 23:16, Bart Van Assche wrote: > On 6/25/25 9:18 PM, Bagas Sanjaya wrote: >> - * 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 >> * > > Here is an example from Documentation/doc-guide/kernel-doc.rst: > > * Return: > * * %0 - OK to runtime suspend the device > * * %-EBUSY - Device should not be runtime suspended > > Wouldn't it be better to follow that example and to move the list under > 'Returns:' and to move it more to the left? > Ack. I will do that in v2. Thanks. -- An old man doll... just what I always wanted! - Clara
On 6/26/25 23:16, Bart Van Assche wrote: > On 6/25/25 9:18 PM, Bagas Sanjaya wrote: >> - * 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 >> * > > Here is an example from Documentation/doc-guide/kernel-doc.rst: > > * Return: > * * %0 - OK to runtime suspend the device > * * %-EBUSY - Device should not be runtime suspended > > Wouldn't it be better to follow that example and to move the list under > 'Returns:' and to move it more to the left? > Ack. Thanks. -- An old man doll... just what I always wanted! - Clara
© 2016 - 2025 Red Hat, Inc.