Skip to content

Commit

Permalink
scsi_scan.c: fix/convert functions to use kernel-doc
Browse files Browse the repository at this point in the history
scsi_scan.c: fix incorrectly formatted kernel-doc notation
& convert documentation of 2 functions into kernel-doc.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
  • Loading branch information
Randy Dunlap authored and Linus Torvalds committed May 24, 2010
1 parent 89bbfb6 commit 9f6aa57
Showing 1 changed file with 9 additions and 17 deletions.
26 changes: 9 additions & 17 deletions drivers/scsi/scsi_scan.c
Original file line number Diff line number Diff line change
Expand Up @@ -1220,7 +1220,7 @@ static void scsi_sequential_lun_scan(struct scsi_target *starget,
}

/**
* scsilun_to_int: convert a scsi_lun to an int
* scsilun_to_int - convert a scsi_lun to an int
* @scsilun: struct scsi_lun to be converted.
*
* Description:
Expand Down Expand Up @@ -1252,7 +1252,7 @@ int scsilun_to_int(struct scsi_lun *scsilun)
EXPORT_SYMBOL(scsilun_to_int);

/**
* int_to_scsilun: reverts an int into a scsi_lun
* int_to_scsilun - reverts an int into a scsi_lun
* @lun: integer to be reverted
* @scsilun: struct scsi_lun to be set.
*
Expand Down Expand Up @@ -1876,12 +1876,9 @@ void scsi_forget_host(struct Scsi_Host *shost)
spin_unlock_irqrestore(shost->host_lock, flags);
}

/*
* Function: scsi_get_host_dev()
*
* Purpose: Create a scsi_device that points to the host adapter itself.
*
* Arguments: SHpnt - Host that needs a scsi_device
/**
* scsi_get_host_dev - Create a scsi_device that points to the host adapter itself
* @shost: Host that needs a scsi_device
*
* Lock status: None assumed.
*
Expand All @@ -1894,7 +1891,7 @@ void scsi_forget_host(struct Scsi_Host *shost)
*
* Note - this device is not accessible from any high-level
* drivers (including generics), which is probably not
* optimal. We can add hooks later to attach
* optimal. We can add hooks later to attach.
*/
struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost)
{
Expand All @@ -1920,18 +1917,13 @@ struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost)
}
EXPORT_SYMBOL(scsi_get_host_dev);

/*
* Function: scsi_free_host_dev()
*
* Purpose: Free a scsi_device that points to the host adapter itself.
*
* Arguments: SHpnt - Host that needs a scsi_device
/**
* scsi_free_host_dev - Free a scsi_device that points to the host adapter itself
* @sdev: Host device to be freed
*
* Lock status: None assumed.
*
* Returns: Nothing
*
* Notes:
*/
void scsi_free_host_dev(struct scsi_device *sdev)
{
Expand Down

0 comments on commit 9f6aa57

Please sign in to comment.