diff mbox

docbooks: add/fix PCI kernel-doc

Message ID 20090410151750.d38e086a.randy.dunlap@oracle.com
State Accepted, archived
Headers show

Commit Message

Randy Dunlap April 10, 2009, 10:17 p.m. UTC
From: Randy Dunlap <randy.dunlap@oracle.com>

Add drivers/pci/*.c source files to DocBook/kernel-api.tmpl
and update those pci/*.c source files that need kernel-doc fixes.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/DocBook/kernel-api.tmpl |    6 +++++-
 drivers/pci/access.c                  |    4 ++--
 drivers/pci/htirq.c                   |    1 +
 drivers/pci/pci-sysfs.c               |   12 ++++++++----
 drivers/pci/slot.c                    |    4 ++--
 5 files changed, 18 insertions(+), 9 deletions(-)

--
To unsubscribe from this list: send the line "unsubscribe linux-pci" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Jesse Barnes April 22, 2009, 9:50 p.m. UTC | #1
On Fri, 10 Apr 2009 15:17:50 -0700
Randy Dunlap <randy.dunlap@oracle.com> wrote:

> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Add drivers/pci/*.c source files to DocBook/kernel-api.tmpl
> and update those pci/*.c source files that need kernel-doc fixes.
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

Applied, thanks.
diff mbox

Patch

--- linux-2.6.30-rc1-git3.orig/Documentation/DocBook/kernel-api.tmpl
+++ linux-2.6.30-rc1-git3/Documentation/DocBook/kernel-api.tmpl
@@ -190,16 +190,20 @@  X!Ekernel/module.c
 !Edrivers/pci/pci.c
 !Edrivers/pci/pci-driver.c
 !Edrivers/pci/remove.c
-!Edrivers/pci/pci-acpi.c
 !Edrivers/pci/search.c
 !Edrivers/pci/msi.c
 !Edrivers/pci/bus.c
+!Edrivers/pci/access.c
+!Edrivers/pci/irq.c
+!Edrivers/pci/htirq.c
 <!-- FIXME: Removed for now since no structured comments in source
 X!Edrivers/pci/hotplug.c
 -->
 !Edrivers/pci/probe.c
+!Edrivers/pci/slot.c
 !Edrivers/pci/rom.c
 !Edrivers/pci/iov.c
+!Idrivers/pci/pci-sysfs.c
      </sect1>
      <sect1><title>PCI Hotplug Support Library</title>
 !Edrivers/pci/hotplug/pci_hotplug_core.c
--- linux-2.6.30-rc1-git3.orig/drivers/pci/access.c
+++ linux-2.6.30-rc1-git3/drivers/pci/access.c
@@ -87,8 +87,8 @@  EXPORT_SYMBOL(pci_read_vpd);
  * pci_write_vpd - Write entry to Vital Product Data
  * @dev:	pci device struct
  * @pos:	offset in vpd space
- * @count:	number of bytes to read
- * @val:	value to write
+ * @count:	number of bytes to write
+ * @buf:	buffer containing write data
  *
  */
 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf)
--- linux-2.6.30-rc1-git3.orig/drivers/pci/htirq.c
+++ linux-2.6.30-rc1-git3/drivers/pci/htirq.c
@@ -158,6 +158,7 @@  int ht_create_irq(struct pci_dev *dev, i
 
 /**
  * ht_destroy_irq - destroy an irq created with ht_create_irq
+ * @irq: irq to be destroyed
  *
  * This reverses ht_create_irq removing the specified irq from
  * existence.  The irq should be free before this happens.
--- linux-2.6.30-rc1-git3.orig/drivers/pci/slot.c
+++ linux-2.6.30-rc1-git3/drivers/pci/slot.c
@@ -264,8 +264,8 @@  EXPORT_SYMBOL_GPL(pci_create_slot);
 
 /**
  * pci_renumber_slot - update %struct pci_slot -> number
- * @slot - %struct pci_slot to update
- * @slot_nr - new number for slot
+ * @slot: &struct pci_slot to update
+ * @slot_nr: new number for slot
  *
  * The primary purpose of this interface is to allow callers who earlier
  * created a placeholder slot in pci_create_slot() by passing a -1 as
--- linux-2.6.30-rc1-git3.orig/drivers/pci/pci-sysfs.c
+++ linux-2.6.30-rc1-git3/drivers/pci/pci-sysfs.c
@@ -492,6 +492,7 @@  write_vpd_attr(struct kobject *kobj, str
 /**
  * pci_read_legacy_io - read byte(s) from legacy I/O port space
  * @kobj: kobject corresponding to file to read from
+ * @bin_attr: struct bin_attribute for this file
  * @buf: buffer to store results
  * @off: offset into legacy I/O port space
  * @count: number of bytes to read
@@ -517,6 +518,7 @@  pci_read_legacy_io(struct kobject *kobj,
 /**
  * pci_write_legacy_io - write byte(s) to legacy I/O port space
  * @kobj: kobject corresponding to file to read from
+ * @bin_attr: struct bin_attribute for this file
  * @buf: buffer containing value to be written
  * @off: offset into legacy I/O port space
  * @count: number of bytes to write
@@ -733,9 +735,9 @@  pci_mmap_resource_wc(struct kobject *kob
 
 /**
  * pci_remove_resource_files - cleanup resource files
- * @dev: dev to cleanup
+ * @pdev: dev to cleanup
  *
- * If we created resource files for @dev, remove them from sysfs and
+ * If we created resource files for @pdev, remove them from sysfs and
  * free their resources.
  */
 static void
@@ -793,9 +795,9 @@  static int pci_create_attr(struct pci_de
 
 /**
  * pci_create_resource_files - create resource files in sysfs for @dev
- * @dev: dev in question
+ * @pdev: dev in question
  *
- * Walk the resources in @dev creating files for each resource available.
+ * Walk the resources in @pdev creating files for each resource available.
  */
 static int pci_create_resource_files(struct pci_dev *pdev)
 {
@@ -829,6 +831,7 @@  void __weak pci_remove_resource_files(st
 /**
  * pci_write_rom - used to enable access to the PCI ROM display
  * @kobj: kernel object handle
+ * @bin_attr: struct bin_attribute for this file
  * @buf: user input
  * @off: file offset
  * @count: number of byte in input
@@ -852,6 +855,7 @@  pci_write_rom(struct kobject *kobj, stru
 /**
  * pci_read_rom - read a PCI ROM
  * @kobj: kernel object handle
+ * @bin_attr: struct bin_attribute for this file
  * @buf: where to put the data we read from the ROM
  * @off: file offset
  * @count: number of bytes to read