scsi: fix various kernel-doc problems in scsi_error.c
authorRandy Dunlap <rdunlap@infradead.org>
Sat, 16 Aug 2014 21:15:11 +0000 (14:15 -0700)
committerChristoph Hellwig <hch@lst.de>
Mon, 15 Sep 2014 23:01:57 +0000 (16:01 -0700)
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>
drivers/scsi/scsi_error.c

index 5db8454474eefa7cae0e9a0274b2954381293e95..6b20ef3fee541db301986add797680cc61626ae3 100644 (file)
@@ -1238,9 +1238,9 @@ 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
- * @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:
  *    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
  * @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 *shost,
 /**
  * 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(struct Scsi_Host *shost,
 /**
  * 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 Scsi_Host *shost,
 /**
  * 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_Host *shost,
 
 /**
  * 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 Scsi_Host *shost,
 
 /**
  * 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)
@@ -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.
- * @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.
  */
 void scsi_eh_ready_devs(struct Scsi_Host *shost,