* [PATCH] scsi: fix kernel-doc, add kernel-doc
@ 2010-02-22 3:47 Randy Dunlap
2010-02-22 11:51 ` Stefan Richter
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2010-02-22 3:47 UTC (permalink / raw)
To: scsi; +Cc: james.bottomley
From: Randy Dunlap <randy.dunlap@oracle.com>
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>
---
drivers/scsi/scsi_scan.c | 24 ++++++++----------------
1 file changed, 8 insertions(+), 16 deletions(-)
--- linux-2.6.33-rc8-git6.orig/drivers/scsi/scsi_scan.c
+++ linux-2.6.33-rc8-git6/drivers/scsi/scsi_scan.c
@@ -1220,7 +1220,7 @@ static void scsi_sequential_lun_scan(str
}
/**
- * 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:
@@ -1252,7 +1252,7 @@ int scsilun_to_int(struct scsi_lun *scsi
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.
*
@@ -1874,12 +1874,9 @@ void scsi_forget_host(struct Scsi_Host *
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.
*
@@ -1892,7 +1889,7 @@ void scsi_forget_host(struct Scsi_Host *
*
* 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)
{
@@ -1920,17 +1917,12 @@ struct scsi_device *scsi_get_host_dev(st
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 that needs a scsi_device
*
* Lock status: None assumed.
*
* Returns: Nothing
- *
- * Notes:
*/
void scsi_free_host_dev(struct scsi_device *sdev)
{
---
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] scsi: fix kernel-doc, add kernel-doc
2010-02-22 3:47 [PATCH] scsi: fix kernel-doc, add kernel-doc Randy Dunlap
@ 2010-02-22 11:51 ` Stefan Richter
2010-02-22 16:28 ` [PATCH v2] " Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Stefan Richter @ 2010-02-22 11:51 UTC (permalink / raw)
To: Randy Dunlap; +Cc: scsi, james.bottomley
Randy Dunlap wrote:
> --- linux-2.6.33-rc8-git6.orig/drivers/scsi/scsi_scan.c
> +++ linux-2.6.33-rc8-git6/drivers/scsi/scsi_scan.c
[...]
> @@ -1920,17 +1917,12 @@ struct scsi_device *scsi_get_host_dev(st
> EXPORT_SYMBOL(scsi_get_host_dev);
>
> /*
Should be /**.
> - * 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 that needs a scsi_device
Perhaps: @sdev: Device to be freed
> *
> * Lock status: None assumed.
> *
> * Returns: Nothing
> - *
> - * Notes:
> */
> void scsi_free_host_dev(struct scsi_device *sdev)
> {
--
Stefan Richter
-=====-==-=- --=- =--==
http://arcgraph.de/sr/
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v2] scsi: fix kernel-doc, add kernel-doc
2010-02-22 11:51 ` Stefan Richter
@ 2010-02-22 16:28 ` Randy Dunlap
0 siblings, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2010-02-22 16:28 UTC (permalink / raw)
To: Stefan Richter; +Cc: scsi, james.bottomley
From: Randy Dunlap <randy.dunlap@oracle.com>
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>
---
drivers/scsi/scsi_scan.c | 26 +++++++++-----------------
1 file changed, 9 insertions(+), 17 deletions(-)
--- linux-2.6.33-rc8-git6.orig/drivers/scsi/scsi_scan.c
+++ linux-2.6.33-rc8-git6/drivers/scsi/scsi_scan.c
@@ -1220,7 +1220,7 @@ static void scsi_sequential_lun_scan(str
}
/**
- * 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:
@@ -1252,7 +1252,7 @@ int scsilun_to_int(struct scsi_lun *scsi
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.
*
@@ -1874,12 +1874,9 @@ void scsi_forget_host(struct Scsi_Host *
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.
*
@@ -1892,7 +1889,7 @@ void scsi_forget_host(struct Scsi_Host *
*
* 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)
{
@@ -1919,18 +1916,13 @@ struct scsi_device *scsi_get_host_dev(st
}
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)
{
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2010-02-22 16:28 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-02-22 3:47 [PATCH] scsi: fix kernel-doc, add kernel-doc Randy Dunlap
2010-02-22 11:51 ` Stefan Richter
2010-02-22 16:28 ` [PATCH v2] " Randy Dunlap
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.