[PATCH] docbook: add edd firmware interfaces

[PATCH] docbook: add edd firmware interfaces

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Cleanup kernel-doc notation in drivers/firmware/edd.c.

Add edd.c to DocBook/kernel-api.tmpl.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/DocBook/kernel-api.tmpl |    3 +++
 drivers/firmware/edd.c                |    8 +++++---
 2 files changed, 8 insertions(+), 3 deletions(-)

--- linux-2620-rc4.orig/drivers/firmware/edd.c
+++ linux-2620-rc4/drivers/firmware/edd.c
@@ -233,6 +233,8 @@ edd_show_interface(struct edd_device *ed
 
 /**
  * edd_show_raw_data() - copies raw data to buffer for userspace to parse
+ * @edev: target edd_device
+ * @buf: output buffer
  *
  * Returns: number of bytes written, or -EINVAL on failure
  */
@@ -634,8 +636,8 @@ static decl_subsys(edd,&ktype_edd,NULL);
 
 /**
  * edd_dev_is_type() - is this EDD device a 'type' device?
- * @edev
- * @type - a host bus or interface identifier string per the EDD spec
+ * @edev: target edd_device
+ * @type: a host bus or interface identifier string per the EDD spec
  *
  * Returns 1 (TRUE) if it is a 'type' device, 0 otherwise.
  */
@@ -657,7 +659,7 @@ edd_dev_is_type(struct edd_device *edev,
 
 /**
  * edd_get_pci_dev() - finds pci_dev that matches edev
- * @edev - edd_device
+ * @edev: edd_device
  *
  * Returns pci_dev if found, or NULL
  */
--- linux-2620-rc4.orig/Documentation/DocBook/kernel-api.tmpl
+++ linux-2620-rc4/Documentation/DocBook/kernel-api.tmpl
@@ -316,6 +316,9 @@ X!Earch/i386/kernel/mca.c
      <sect1><title>DMI Interfaces</title>
 !Edrivers/firmware/dmi_scan.c
      </sect1>
+     <sect1><title>EDD Interfaces</title>
+!Idrivers/firmware/edd.c
+     </sect1>
   </chapter>
 
   <chapter id="security">


---

Re: [PATCH] docbook: add edd firmware interfaces

[Matt Domsch]

[-- Attachment #1: Type: text/plain, Size: 507 bytes --]

On Tue, Jan 09, 2007 at 09:41:09PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Cleanup kernel-doc notation in drivers/firmware/edd.c.
> 
> Add edd.c to DocBook/kernel-api.tmpl.
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

Acked-by: Matt Domsch <Matt_Domsch@dell.com>


Thanks Randy!
-Matt

-- 
Matt Domsch
Software Architect
Dell Linux Solutions linux.dell.com & www.dell.com/linux
Linux on Dell mailing lists @ http://lists.us.dell.com

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]