scsi: fix various kernel-doc problems in scsi_error.c

PATCH In review Randy Dunlap 4 participants 4 messages Aug 16, 2014 – Aug 26, 2014 SCSI

lore

Share & tools

lore

Randy Dunlap

author

2014-08-16 21:15 UTC #0 lore raw

PATCH 1/1 scsi: fix various kernel-doc problems in scsi_error.c

From: Randy Dunlap <[email protected]>

Convert spaces to tabs in kernel-doc notation.
Correct duplicated (copy-paste) kernel-doc comments that are incorrect. Fix kernel-doc warning:

Warning(..//drivers/scsi/scsi_error.c:1647): No description found for parameter 'shost'

Signed-off-by Randy Dunlap <[email protected]>

---
 drivers/scsi/scsi_error.c |   23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

drivers/scsi/scsi_error.c +12 ~~-11~~

Index: lnx-317-rc1/drivers/scsi/scsi_error.c
===================================================================
@@ -1238,8 +1238,8 @@ retry_tur:
 /**
  * scsi_eh_test_devices - check if devices are responding from error recovery.
  * @cmd_list:	scsi commands in error recovery.
- * @work_q:     queue for commands which still need more error recovery
- * @done_q:     queue for commands which are finished
+ * @work_q:	queue for commands which still need more error recovery
+ * @done_q:	queue for commands which are finished
  * @try_stu:    boolean on if a STU command should be tried in addition to TUR.
  *
  * Decription:

@@ -1373,7 +1373,7 @@ static int scsi_eh_try_stu(struct scsi_c
  /**
  * scsi_eh_stu - send START_UNIT if needed
  * @shost:	&scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  *
  * Notes:

@@ -1436,7 +1436,7 @@ static int scsi_eh_stu(struct Scsi_Host
 /**
  * scsi_eh_bus_device_reset - send bdr if needed
  * @shost:	scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  *
  * Notes:

@@ -1502,7 +1502,7 @@ static int scsi_eh_bus_device_reset(stru
 /**
  * scsi_eh_target_reset - send target reset if needed
  * @shost:	scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  *
  * Notes:

@@ -1567,7 +1567,7 @@ static int scsi_eh_target_reset(struct S
 /**
  * scsi_eh_bus_reset - send a bus reset
  * @shost:	&scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  */
 static int scsi_eh_bus_reset(struct Scsi_Host *shost,

@@ -1638,8 +1638,9 @@ static int scsi_eh_bus_reset(struct Scsi
 
 /**
  * scsi_eh_host_reset - send a host reset
- * @work_q:	list_head for processed commands.
- * @done_q:	list_head for processed commands.
+ * @shost: 	host to be reset.
+ * @work_q:	&list_head for pending commands.
+ * @done_q:	&list_head for processed commands.
  */
 static int scsi_eh_host_reset(struct Scsi_Host *shost,
 			      struct list_head *work_q,

@@ -1677,8 +1678,8 @@ static int scsi_eh_host_reset(struct Scs
 
 /**
  * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
- * @work_q:	list_head for processed commands.
- * @done_q:	list_head for processed commands.
+ * @work_q:	&list_head for pending commands.
+ * @done_q:	&list_head for processed commands.
  */
 static void scsi_eh_offline_sdevs(struct list_head *work_q,
 				  struct list_head *done_q)

@@ -2044,7 +2045,7 @@ static void scsi_restart_operations(stru
 /**
  * scsi_eh_ready_devs - check device ready state and recover if not.
  * @shost: 	host to be recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  */
 void scsi_eh_ready_devs(struct Scsi_Host *shost,

Ewan Milne

Reviewed-by on v1 1/1

2014-08-18 15:45 UTC #1 lore raw

Quoted 9 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>
Convert spaces to tabs in kernel-doc notation.
Correct duplicated (copy-paste) kernel-doc comments that are incorrect. Fix kernel-doc warning:
Warning(..//drivers/scsi/scsi_error.c:1647): No description found for parameter 'shost'
Signed-off-by Randy Dunlap <[email protected]>

Cleaning this stuff up is great, see the notes below...

Reviewed-by Ewan D. Milne <[email protected]>

Quoted 9 lines

---
 drivers/scsi/scsi_error.c |   23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)
Index: lnx-317-rc1/drivers/scsi/scsi_error.c
===================================================================

drivers/scsi/scsi_error.c retry_tur: · line 1243

Quoted 8 lines

drivers/scsi/scsi_error.c +2 -2

@@ -1238,8 +1238,8 @@ retry_tur:
 /**
  * scsi_eh_test_devices - check if devices are responding from error recovery.
  * @cmd_list:	scsi commands in error recovery.
- * @work_q:     queue for commands which still need more error recovery
- * @done_q:     queue for commands which are finished
+ * @work_q:	queue for commands which still need more error recovery
+ * @done_q:	queue for commands which are finished
  * @try_stu:    boolean on if a STU command should be tried in addition to TUR.

There are still tabs instead of spaces after @try_stu.

Quoted 39 lines

drivers/scsi/scsi_error.c +4 -4

  *
  * Decription:

@@ -1373,7 +1373,7 @@ static int scsi_eh_try_stu(struct scsi_c
  /**
  * scsi_eh_stu - send START_UNIT if needed
  * @shost:	&scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  *
  * Notes:

@@ -1436,7 +1436,7 @@ static int scsi_eh_stu(struct Scsi_Host
 /**
  * scsi_eh_bus_device_reset - send bdr if needed
  * @shost:	scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  *
  * Notes:

@@ -1502,7 +1502,7 @@ static int scsi_eh_bus_device_reset(stru
 /**
  * scsi_eh_target_reset - send target reset if needed
  * @shost:	scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  *
  * Notes:

@@ -1567,7 +1567,7 @@ static int scsi_eh_target_reset(struct S
 /**
  * scsi_eh_bus_reset - send a bus reset
  * @shost:	&scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  */
 static int scsi_eh_bus_reset(struct Scsi_Host *shost,

drivers/scsi/scsi_error.c static int scsi_eh_bus_reset(struct Scsi · line 1641

Quoted 6 lines

drivers/scsi/scsi_error.c +1 -2

@@ -1638,8 +1638,9 @@ static int scsi_eh_bus_reset(struct Scsi
 
 /**
  * scsi_eh_host_reset - send a host reset
- * @work_q:	list_head for processed commands.
- * @done_q:	list_head for processed commands.
+ * @shost: 	host to be reset.

There is a space before the tab after @shost.

Quoted 17 lines

drivers/scsi/scsi_error.c +4 -2

+ * @work_q:	&list_head for pending commands.
+ * @done_q:	&list_head for processed commands.
  */
 static int scsi_eh_host_reset(struct Scsi_Host *shost,
 			      struct list_head *work_q,

@@ -1677,8 +1678,8 @@ static int scsi_eh_host_reset(struct Scs
 
 /**
  * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
- * @work_q:	list_head for processed commands.
- * @done_q:	list_head for processed commands.
+ * @work_q:	&list_head for pending commands.
+ * @done_q:	&list_head for processed commands.
  */
 static void scsi_eh_offline_sdevs(struct list_head *work_q,
 				  struct list_head *done_q)

drivers/scsi/scsi_error.c static void scsi_restart_operations(stru · line 2047

Quoted 3 lines

drivers/scsi/scsi_error.c +0 -0

@@ -2044,7 +2045,7 @@ static void scsi_restart_operations(stru
 /**
  * scsi_eh_ready_devs - check device ready state and recover if not.
  * @shost: 	host to be recovered.

There a space before the tab after @shost.

Quoted 6 lines

drivers/scsi/scsi_error.c +1 -2

- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  */
 void scsi_eh_ready_devs(struct Scsi_Host *shost,
--

Christoph Hellwig

2014-08-19 17:26 UTC #2 lore raw

In reply to Randy Dunlap

Thanks, I've applied both docbook fixups to the drivers-for-3.18 and also addressed the addition nitpicks from Ewan.

Hannes Reinecke

Reviewed-by on v1 1/1

2014-08-26 08:48 UTC #3 lore raw

In reply to Randy Dunlap

Quoted 97 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Convert spaces to tabs in kernel-doc notation.
Correct duplicated (copy-paste) kernel-doc comments that are incorrect. Fix kernel-doc warning:

Warning(..//drivers/scsi/scsi_error.c:1647): No description found for parameter 'shost'

Signed-off-by Randy Dunlap <[email protected]>

---
  drivers/scsi/scsi_error.c |   23 ++++++++++++-----------
  1 file changed, 12 insertions(+), 11 deletions(-)

Index: lnx-317-rc1/drivers/scsi/scsi_error.c
===================================================================

drivers/scsi/scsi_error.c +12 ~~-12~~

@@ -1238,8 +1238,8 @@ retry_tur:
  /**
   * scsi_eh_test_devices - check if devices are responding from error recovery.
   * @cmd_list:	scsi commands in error recovery.
- * @work_q:     queue for commands which still need more error recovery
- * @done_q:     queue for commands which are finished
+ * @work_q:	queue for commands which still need more error recovery
+ * @done_q:	queue for commands which are finished
   * @try_stu:    boolean on if a STU command should be tried in addition to TUR.
   *
   * Decription:

@@ -1373,7 +1373,7 @@ static int scsi_eh_try_stu(struct scsi_c
   /**
   * scsi_eh_stu - send START_UNIT if needed
   * @shost:	&scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
   * @done_q:	&list_head for processed commands.
   *
   * Notes:

@@ -1436,7 +1436,7 @@ static int scsi_eh_stu(struct Scsi_Host
  /**
   * scsi_eh_bus_device_reset - send bdr if needed
   * @shost:	scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
   * @done_q:	&list_head for processed commands.
   *
   * Notes:

@@ -1502,7 +1502,7 @@ static int scsi_eh_bus_device_reset(stru
  /**
   * scsi_eh_target_reset - send target reset if needed
   * @shost:	scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
   * @done_q:	&list_head for processed commands.
   *
   * Notes:

@@ -1567,7 +1567,7 @@ static int scsi_eh_target_reset(struct S
  /**
   * scsi_eh_bus_reset - send a bus reset
   * @shost:	&scsi host being recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
   * @done_q:	&list_head for processed commands.
   */
  static int scsi_eh_bus_reset(struct Scsi_Host *shost,

@@ -1638,8 +1638,9 @@ static int scsi_eh_bus_reset(struct Scsi
 
  /**
   * scsi_eh_host_reset - send a host reset
- * @work_q:	list_head for processed commands.
- * @done_q:	list_head for processed commands.
+ * @shost: 	host to be reset.
+ * @work_q:	&list_head for pending commands.
+ * @done_q:	&list_head for processed commands.
   */
  static int scsi_eh_host_reset(struct Scsi_Host *shost,
  			      struct list_head *work_q,

@@ -1677,8 +1678,8 @@ static int scsi_eh_host_reset(struct Scs
 
  /**
   * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
- * @work_q:	list_head for processed commands.
- * @done_q:	list_head for processed commands.
+ * @work_q:	&list_head for pending commands.
+ * @done_q:	&list_head for processed commands.
   */
  static void scsi_eh_offline_sdevs(struct list_head *work_q,
  				  struct list_head *done_q)

@@ -2044,7 +2045,7 @@ static void scsi_restart_operations(stru
  /**
   * scsi_eh_ready_devs - check device ready state and recover if not.
   * @shost: 	host to be recovered.
- * @work_q:     &list_head for pending commands.
+ * @work_q:	&list_head for pending commands.
   * @done_q:	&list_head for processed commands.
   */
  void scsi_eh_ready_devs(struct Scsi_Host *shost,
--

Quoted 4 lines

To unsubscribe from this list: send the line "unsubscribe linux-scsi" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

Reviewed-by Hannes Reinecke <[email protected]>

Cheers,

Hannes

Signature · 8 lines

Dr. Hannes Reinecke		      zSeries & Storage
[email protected]			      +49 911 74053 688
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg
GF: J. Hawn, J. Guild, F. Imendörffer, HRB 16746 (AG Nürnberg)
--
To unsubscribe from this list: send the line "unsubscribe linux-scsi" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html