scsi: Format scsi_track_queue_full() return values as bullet list
PATCH 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.
--- drivers/scsi/scsi.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
drivers/scsi/scsi.c +4 -3
@@ -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 *
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 10 lines · Bagas Sanjaya
- * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
- * -1 - Drop back to untagged operation usinghost->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 usinghost->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.
Quoted 14 lines · Bart Van Assche
Quoted 7 lines · Bagas Sanjaya
- * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
- * -1 - Drop back to untagged operation usinghost->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-Quoted 5 lines
Quoted 1 line
cmd_per_lun+ * as the untagged command depth
*
* Lock Status: None held on entry
*
Quoted 9 lines
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 suspendedWouldn'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.
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 14 lines · Bart Van Assche
Quoted 7 lines · Bagas Sanjaya
- * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
- * -1 - Drop back to untagged operation usinghost->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-Quoted 5 lines
Quoted 1 line
cmd_per_lun+ * as the untagged command depth
*
* Lock Status: None held on entry
*
Quoted 9 lines
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 suspendedWouldn'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.
Signature · 1 line
An old man doll... just what I always wanted! - Clara