Browse Source

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

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 <rdunlap@infradead.org>
Reviewed-by: Ewan D. Milne <emilne@redhat.com>
Signed-off-by: Christoph Hellwig <hch@lst.de>
Randy Dunlap 11 years ago
parent
commit
74cf298fed
1 changed files with 14 additions and 13 deletions
  1. 14 13
      drivers/scsi/scsi_error.c

+ 14 - 13
drivers/scsi/scsi_error.c

@@ -1238,9 +1238,9 @@ retry_tur:
 /**
 /**
  * scsi_eh_test_devices - check if devices are responding from error recovery.
  * scsi_eh_test_devices - check if devices are responding from error recovery.
  * @cmd_list:	scsi commands in 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
- * @try_stu:    boolean on if a STU command should be tried in addition to TUR.
+ * @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:
  * Decription:
  *    Tests if devices are in a working state.  Commands to devices now in
  *    Tests if devices are in a working state.  Commands to devices now in
@@ -1373,7 +1373,7 @@ static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
  /**
  /**
  * scsi_eh_stu - send START_UNIT if needed
  * scsi_eh_stu - send START_UNIT if needed
  * @shost:	&scsi host being recovered.
  * @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.
  * @done_q:	&list_head for processed commands.
  *
  *
  * Notes:
  * Notes:
@@ -1436,7 +1436,7 @@ static int scsi_eh_stu(struct Scsi_Host *shost,
 /**
 /**
  * scsi_eh_bus_device_reset - send bdr if needed
  * scsi_eh_bus_device_reset - send bdr if needed
  * @shost:	scsi host being recovered.
  * @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.
  * @done_q:	&list_head for processed commands.
  *
  *
  * Notes:
  * Notes:
@@ -1502,7 +1502,7 @@ static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
 /**
 /**
  * scsi_eh_target_reset - send target reset if needed
  * scsi_eh_target_reset - send target reset if needed
  * @shost:	scsi host being recovered.
  * @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.
  * @done_q:	&list_head for processed commands.
  *
  *
  * Notes:
  * Notes:
@@ -1567,7 +1567,7 @@ static int scsi_eh_target_reset(struct Scsi_Host *shost,
 /**
 /**
  * scsi_eh_bus_reset - send a bus reset
  * scsi_eh_bus_reset - send a bus reset
  * @shost:	&scsi host being recovered.
  * @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.
  * @done_q:	&list_head for processed commands.
  */
  */
 static int scsi_eh_bus_reset(struct Scsi_Host *shost,
 static int scsi_eh_bus_reset(struct Scsi_Host *shost,
@@ -1638,8 +1638,9 @@ static int scsi_eh_bus_reset(struct Scsi_Host *shost,
 
 
 /**
 /**
  * scsi_eh_host_reset - send a host reset
  * 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,
 static int scsi_eh_host_reset(struct Scsi_Host *shost,
 			      struct list_head *work_q,
 			      struct list_head *work_q,
@@ -1677,8 +1678,8 @@ static int scsi_eh_host_reset(struct Scsi_Host *shost,
 
 
 /**
 /**
  * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
  * 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,
 static void scsi_eh_offline_sdevs(struct list_head *work_q,
 				  struct list_head *done_q)
 				  struct list_head *done_q)
@@ -2043,8 +2044,8 @@ static void scsi_restart_operations(struct Scsi_Host *shost)
 
 
 /**
 /**
  * scsi_eh_ready_devs - check device ready state and recover if not.
  * scsi_eh_ready_devs - check device ready state and recover if not.
- * @shost: 	host to be recovered.
- * @work_q:     &list_head for pending commands.
+ * @shost:	host to be recovered.
+ * @work_q:	&list_head for pending commands.
  * @done_q:	&list_head for processed commands.
  * @done_q:	&list_head for processed commands.
  */
  */
 void scsi_eh_ready_devs(struct Scsi_Host *shost,
 void scsi_eh_ready_devs(struct Scsi_Host *shost,