Commit 67be2dd1 authored by Martin Waitz's avatar Martin Waitz Committed by Linus Torvalds
Browse files

[PATCH] DocBook: fix some descriptions 



Some KernelDoc descriptions are updated to match the current code.
No code changes.

Signed-off-by: default avatarMartin Waitz <tali@admingilde.org>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 6013d544

drivers/acpi/scan.c

+2 −2
Original line number Diff line number Diff line
@@ -379,8 +379,8 @@ ACPI_DEVICE_ATTR(eject, 0200, NULL, acpi_eject_store); 


/**

 * setup_sys_fs_device_files - sets up the device files under device namespace

 * @@dev:	acpi_device object

 * @@func:	function pointer to create or destroy the device file

 * @dev:	acpi_device object

 * @func:	function pointer to create or destroy the device file

 */

static void

setup_sys_fs_device_files (

drivers/base/platform.c

+2 −2
Original line number Diff line number Diff line
@@ -115,7 +115,7 @@ int platform_add_devices(struct platform_device **devs, int num) 


/**

 *	platform_device_register - add a platform-level device

 *	@dev:	platform device we're adding

 *	@pdev:	platform device we're adding

 *

 */

int platform_device_register(struct platform_device * pdev)
@@ -174,7 +174,7 @@ int platform_device_register(struct platform_device * pdev) 


/**

 *	platform_device_unregister - remove a platform-level device

 *	@dev:	platform device we're removing

 *	@pdev:	platform device we're removing

 *

 *	Note that this function will also release all memory- and port-based

 *	resources owned by the device (@dev->resource).

drivers/pci/hotplug.c

+4 −0
Original line number Diff line number Diff line
@@ -120,6 +120,10 @@ static int pci_visit_bridge (struct pci_visit * fn, 


/**

 * pci_visit_dev - scans the pci buses.

 * @fn: callback functions that are called while visiting

 * @wrapped_dev: the device to scan

 * @wrapped_parent: the bus where @wrapped_dev is connected to

 *

 * Every bus and every function is presented to a custom

 * function that can act upon it.

 */

drivers/pci/rom.c

+7 −7
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ 


/**

 * pci_enable_rom - enable ROM decoding for a PCI device

 * @dev: PCI device to enable

 * @pdev: PCI device to enable

 *

 * Enable ROM decoding on @dev.  This involves simply turning on the last

 * bit of the PCI ROM BAR.  Note that some cards may share address decoders
@@ -32,7 +32,7 @@ static void pci_enable_rom(struct pci_dev *pdev) 


/**

 * pci_disable_rom - disable ROM decoding for a PCI device

 * @dev: PCI device to disable

 * @pdev: PCI device to disable

 *

 * Disable ROM decoding on a PCI device by turning off the last bit in the

 * ROM BAR.
@@ -47,7 +47,7 @@ static void pci_disable_rom(struct pci_dev *pdev) 


/**

 * pci_map_rom - map a PCI ROM to kernel space

 * @dev: pointer to pci device struct

 * @pdev: pointer to pci device struct

 * @size: pointer to receive size of pci window over ROM

 * @return: kernel virtual pointer to image of ROM

 *
@@ -132,7 +132,7 @@ void __iomem *pci_map_rom(struct pci_dev *pdev, size_t *size) 


/**

 * pci_map_rom_copy - map a PCI ROM to kernel space, create a copy

 * @dev: pointer to pci device struct

 * @pdev: pointer to pci device struct

 * @size: pointer to receive size of pci window over ROM

 * @return: kernel virtual pointer to image of ROM

 *
@@ -166,7 +166,7 @@ void __iomem *pci_map_rom_copy(struct pci_dev *pdev, size_t *size) 


/**

 * pci_unmap_rom - unmap the ROM from kernel space

 * @dev: pointer to pci device struct

 * @pdev: pointer to pci device struct

 * @rom: virtual address of the previous mapping

 *

 * Remove a mapping of a previously mapped ROM
@@ -187,7 +187,7 @@ void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom) 


/**

 * pci_remove_rom - disable the ROM and remove its sysfs attribute

 * @dev: pointer to pci device struct

 * @pdev: pointer to pci device struct

 *

 * Remove the rom file in sysfs and disable ROM decoding.

 */
@@ -206,7 +206,7 @@ void pci_remove_rom(struct pci_dev *pdev) 
/**

 * pci_cleanup_rom - internal routine for freeing the ROM copy created

 * by pci_map_rom_copy called from remove.c

 * @dev: pointer to pci device struct

 * @pdev: pointer to pci device struct

 *

 * Free the copied ROM if we allocated one.

 */

drivers/pnp/manager.c

+1 −1
Original line number Diff line number Diff line
@@ -253,7 +253,7 @@ void pnp_init_resource_table(struct pnp_resource_table *table) 


/**

 * pnp_clean_resources - clears resources that were not manually set

 * @res - the resources to clean

 * @res: the resources to clean

 *

 */

static void pnp_clean_resource_table(struct pnp_resource_table * res)