Skip to contentSkip to conversation

docbook: add edd firmware interfaces

PATCH In review Randy Dunlap 2 participants 2 messages Jan 10, 2007 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docbook: add edd firmware interfaces

From: Randy Dunlap <[email protected]>

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

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

---
 Documentation/DocBook/kernel-api.tmpl |    3 +++
 drivers/firmware/edd.c                |    8 +++++---
 2 files changed, 8 insertions(+), 3 deletions(-)
drivers/firmware/edd.c +5 -3
@@ -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
  */
Documentation/DocBook/kernel-api.tmpl +3 -0
@@ -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">

---