Commit a99cbf6b authored by Linus Torvalds's avatar Linus Torvalds

Merge branch 'kernel-doc' from Randy Dunlap

The usual kernel-doc fixups from Randy.  Some of them David acked as
merged in his tree, this is the random left-overs.

* kernel-doc:
  docbook: fix sched source file names in device-drivers book
  docbook: change iomap source filename in deviceiobook
  docbook: don't use serial_core.h in device-drivers book
  kernel-doc: fix kernel-doc warnings in sched
  kernel-doc: fix new warnings in cfg80211.h
  kernel-doc: fix new warning in usb.h
  kernel-doc: fix new warnings in device.h
  kernel-doc: fix new warnings in debugfs
  kernel-doc: fix new warning in regulator core
  kernel-doc: fix new warnings in pci
  kernel-doc: fix new warnings in driver-core
  kernel-doc: fix new warnings in auditsc.c
  scripts/kernel-doc: fix fatal error caused by cfg80211.h
parents 4f57d865 b4d20859
...@@ -50,7 +50,9 @@ ...@@ -50,7 +50,9 @@
<sect1><title>Delaying, scheduling, and timer routines</title> <sect1><title>Delaying, scheduling, and timer routines</title>
!Iinclude/linux/sched.h !Iinclude/linux/sched.h
!Ekernel/sched.c !Ekernel/sched/core.c
!Ikernel/sched/cpupri.c
!Ikernel/sched/fair.c
!Iinclude/linux/completion.h !Iinclude/linux/completion.h
!Ekernel/timer.c !Ekernel/timer.c
</sect1> </sect1>
...@@ -216,7 +218,6 @@ X!Isound/sound_firmware.c ...@@ -216,7 +218,6 @@ X!Isound/sound_firmware.c
<chapter id="uart16x50"> <chapter id="uart16x50">
<title>16x50 UART Driver</title> <title>16x50 UART Driver</title>
!Iinclude/linux/serial_core.h
!Edrivers/tty/serial/serial_core.c !Edrivers/tty/serial/serial_core.c
!Edrivers/tty/serial/8250.c !Edrivers/tty/serial/8250.c
</chapter> </chapter>
......
...@@ -317,7 +317,7 @@ CPU B: spin_unlock_irqrestore(&amp;dev_lock, flags) ...@@ -317,7 +317,7 @@ CPU B: spin_unlock_irqrestore(&amp;dev_lock, flags)
<chapter id="pubfunctions"> <chapter id="pubfunctions">
<title>Public Functions Provided</title> <title>Public Functions Provided</title>
!Iarch/x86/include/asm/io.h !Iarch/x86/include/asm/io.h
!Elib/iomap.c !Elib/pci_iomap.c
</chapter> </chapter>
</book> </book>
...@@ -915,9 +915,10 @@ static BUS_ATTR(uevent, S_IWUSR, NULL, bus_uevent_store); ...@@ -915,9 +915,10 @@ static BUS_ATTR(uevent, S_IWUSR, NULL, bus_uevent_store);
/** /**
* __bus_register - register a driver-core subsystem * __bus_register - register a driver-core subsystem
* @bus: bus. * @bus: bus to register
* @key: lockdep class key
* *
* Once we have that, we registered the bus with the kobject * Once we have that, we register the bus with the kobject
* infrastructure, then register the children subsystems it has: * infrastructure, then register the children subsystems it has:
* the devices and drivers that belong to the subsystem. * the devices and drivers that belong to the subsystem.
*/ */
...@@ -1220,8 +1221,8 @@ static void system_root_device_release(struct device *dev) ...@@ -1220,8 +1221,8 @@ static void system_root_device_release(struct device *dev)
} }
/** /**
* subsys_system_register - register a subsystem at /sys/devices/system/ * subsys_system_register - register a subsystem at /sys/devices/system/
* @subsys - system subsystem * @subsys: system subsystem
* @groups - default attributes for the root device * @groups: default attributes for the root device
* *
* All 'system' subsystems have a /sys/devices/system/<name> root device * All 'system' subsystems have a /sys/devices/system/<name> root device
* with the name of the subsystem. The root device can carry subsystem- * with the name of the subsystem. The root device can carry subsystem-
......
...@@ -2802,7 +2802,7 @@ pci_intx(struct pci_dev *pdev, int enable) ...@@ -2802,7 +2802,7 @@ pci_intx(struct pci_dev *pdev, int enable)
/** /**
* pci_intx_mask_supported - probe for INTx masking support * pci_intx_mask_supported - probe for INTx masking support
* @pdev: the PCI device to operate on * @dev: the PCI device to operate on
* *
* Check if the device dev support INTx masking via the config space * Check if the device dev support INTx masking via the config space
* command word. * command word.
...@@ -2884,7 +2884,7 @@ static bool pci_check_and_set_intx_mask(struct pci_dev *dev, bool mask) ...@@ -2884,7 +2884,7 @@ static bool pci_check_and_set_intx_mask(struct pci_dev *dev, bool mask)
/** /**
* pci_check_and_mask_intx - mask INTx on pending interrupt * pci_check_and_mask_intx - mask INTx on pending interrupt
* @pdev: the PCI device to operate on * @dev: the PCI device to operate on
* *
* Check if the device dev has its INTx line asserted, mask it and * Check if the device dev has its INTx line asserted, mask it and
* return true in that case. False is returned if not interrupt was * return true in that case. False is returned if not interrupt was
...@@ -2898,7 +2898,7 @@ EXPORT_SYMBOL_GPL(pci_check_and_mask_intx); ...@@ -2898,7 +2898,7 @@ EXPORT_SYMBOL_GPL(pci_check_and_mask_intx);
/** /**
* pci_check_and_mask_intx - unmask INTx of no interrupt is pending * pci_check_and_mask_intx - unmask INTx of no interrupt is pending
* @pdev: the PCI device to operate on * @dev: the PCI device to operate on
* *
* Check if the device dev has its INTx line asserted, unmask it if not * Check if the device dev has its INTx line asserted, unmask it if not
* and return true. False is returned and the mask remains active if * and return true. False is returned and the mask remains active if
......
...@@ -2731,6 +2731,7 @@ static void rdev_init_debugfs(struct regulator_dev *rdev) ...@@ -2731,6 +2731,7 @@ static void rdev_init_debugfs(struct regulator_dev *rdev)
* @dev: struct device for the regulator * @dev: struct device for the regulator
* @init_data: platform provided init data, passed through by driver * @init_data: platform provided init data, passed through by driver
* @driver_data: private regulator data * @driver_data: private regulator data
* @of_node: target open firmware device structure (may be NULL)
* *
* Called by regulator drivers to register a regulator. * Called by regulator drivers to register a regulator.
* Returns 0 on success. * Returns 0 on success.
......
...@@ -540,7 +540,7 @@ EXPORT_SYMBOL_GPL(debugfs_create_blob); ...@@ -540,7 +540,7 @@ EXPORT_SYMBOL_GPL(debugfs_create_blob);
* debugfs_print_regs32 - use seq_print to describe a set of registers * debugfs_print_regs32 - use seq_print to describe a set of registers
* @s: the seq_file structure being used to generate output * @s: the seq_file structure being used to generate output
* @regs: an array if struct debugfs_reg32 structures * @regs: an array if struct debugfs_reg32 structures
* @mregs: the length of the above array * @nregs: the length of the above array
* @base: the base address to be used in reading the registers * @base: the base address to be used in reading the registers
* @prefix: a string to be prefixed to every output line * @prefix: a string to be prefixed to every output line
* *
......
...@@ -279,11 +279,11 @@ struct device *driver_find_device(struct device_driver *drv, ...@@ -279,11 +279,11 @@ struct device *driver_find_device(struct device_driver *drv,
/** /**
* struct subsys_interface - interfaces to device functions * struct subsys_interface - interfaces to device functions
* @name name of the device function * @name: name of the device function
* @subsystem subsytem of the devices to attach to * @subsys: subsytem of the devices to attach to
* @node the list of functions registered at the subsystem * @node: the list of functions registered at the subsystem
* @add device hookup to device function handler * @add_dev: device hookup to device function handler
* @remove device hookup to device function handler * @remove_dev: device hookup to device function handler
* *
* Simple interfaces attached to a subsystem. Multiple interfaces can * Simple interfaces attached to a subsystem. Multiple interfaces can
* attach to a subsystem and its devices. Unlike drivers, they do not * attach to a subsystem and its devices. Unlike drivers, they do not
...@@ -612,6 +612,7 @@ struct device_dma_parameters { ...@@ -612,6 +612,7 @@ struct device_dma_parameters {
* @archdata: For arch-specific additions. * @archdata: For arch-specific additions.
* @of_node: Associated device tree node. * @of_node: Associated device tree node.
* @devt: For creating the sysfs "dev". * @devt: For creating the sysfs "dev".
* @id: device instance
* @devres_lock: Spinlock to protect the resource of the device. * @devres_lock: Spinlock to protect the resource of the device.
* @devres_head: The resources list of the device. * @devres_head: The resources list of the device.
* @knode_class: The node used to add the device to the class list. * @knode_class: The node used to add the device to the class list.
...@@ -1003,6 +1004,10 @@ extern long sysfs_deprecated; ...@@ -1003,6 +1004,10 @@ extern long sysfs_deprecated;
* Each module may only use this macro once, and calling it replaces * Each module may only use this macro once, and calling it replaces
* module_init() and module_exit(). * module_init() and module_exit().
* *
* @__driver: driver name
* @__register: register function for this driver type
* @__unregister: unregister function for this driver type
*
* Use this macro to construct bus specific macros for registering * Use this macro to construct bus specific macros for registering
* drivers, and do not use it on its own. * drivers, and do not use it on its own.
*/ */
......
...@@ -2088,7 +2088,7 @@ extern int sched_setscheduler_nocheck(struct task_struct *, int, ...@@ -2088,7 +2088,7 @@ extern int sched_setscheduler_nocheck(struct task_struct *, int,
extern struct task_struct *idle_task(int cpu); extern struct task_struct *idle_task(int cpu);
/** /**
* is_idle_task - is the specified task an idle task? * is_idle_task - is the specified task an idle task?
* @tsk: the task in question. * @p: the task in question.
*/ */
static inline bool is_idle_task(struct task_struct *p) static inline bool is_idle_task(struct task_struct *p)
{ {
......
...@@ -1073,6 +1073,7 @@ typedef void (*usb_complete_t)(struct urb *); ...@@ -1073,6 +1073,7 @@ typedef void (*usb_complete_t)(struct urb *);
* which the host controller driver should use in preference to the * which the host controller driver should use in preference to the
* transfer_buffer. * transfer_buffer.
* @sg: scatter gather buffer list * @sg: scatter gather buffer list
* @num_mapped_sgs: (internal) number of mapped sg entries
* @num_sgs: number of entries in the sg list * @num_sgs: number of entries in the sg list
* @transfer_buffer_length: How big is transfer_buffer. The transfer may * @transfer_buffer_length: How big is transfer_buffer. The transfer may
* be broken up into chunks according to the current maximum packet * be broken up into chunks according to the current maximum packet
......
...@@ -1140,6 +1140,7 @@ struct cfg80211_disassoc_request { ...@@ -1140,6 +1140,7 @@ struct cfg80211_disassoc_request {
* @bssid: Fixed BSSID requested, maybe be %NULL, if set do not * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
* search for IBSSs with a different BSSID. * search for IBSSs with a different BSSID.
* @channel: The channel to use if no IBSS can be found to join. * @channel: The channel to use if no IBSS can be found to join.
* @channel_type: channel type (HT mode)
* @channel_fixed: The channel should be fixed -- do not search for * @channel_fixed: The channel should be fixed -- do not search for
* IBSSs to join on other channels. * IBSSs to join on other channels.
* @ie: information element(s) to include in the beacon * @ie: information element(s) to include in the beacon
...@@ -1978,6 +1979,11 @@ struct wiphy_wowlan_support { ...@@ -1978,6 +1979,11 @@ struct wiphy_wowlan_support {
* configured as RX antennas. Antenna configuration commands will be * configured as RX antennas. Antenna configuration commands will be
* rejected unless this or @available_antennas_tx is set. * rejected unless this or @available_antennas_tx is set.
* *
* @probe_resp_offload:
* Bitmap of supported protocols for probe response offloading.
* See &enum nl80211_probe_resp_offload_support_attr. Only valid
* when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
*
* @max_remain_on_channel_duration: Maximum time a remain-on-channel operation * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
* may request, if implemented. * may request, if implemented.
* *
......
...@@ -1863,11 +1863,12 @@ void __audit_syscall_entry(int arch, int major, ...@@ -1863,11 +1863,12 @@ void __audit_syscall_entry(int arch, int major,
/** /**
* audit_syscall_exit - deallocate audit context after a system call * audit_syscall_exit - deallocate audit context after a system call
* @pt_regs: syscall registers * @success: success value of the syscall
* @return_code: return value of the syscall
* *
* Tear down after system call. If the audit context has been marked as * Tear down after system call. If the audit context has been marked as
* auditable (either because of the AUDIT_RECORD_CONTEXT state from * auditable (either because of the AUDIT_RECORD_CONTEXT state from
* filtering, or because some other part of the kernel write an audit * filtering, or because some other part of the kernel wrote an audit
* message), then write out the syscall information. In call cases, * message), then write out the syscall information. In call cases,
* free the names stored from getname(). * free the names stored from getname().
*/ */
......
...@@ -129,7 +129,7 @@ int cpupri_find(struct cpupri *cp, struct task_struct *p, ...@@ -129,7 +129,7 @@ int cpupri_find(struct cpupri *cp, struct task_struct *p,
* cpupri_set - update the cpu priority setting * cpupri_set - update the cpu priority setting
* @cp: The cpupri context * @cp: The cpupri context
* @cpu: The target cpu * @cpu: The target cpu
* @pri: The priority (INVALID-RT99) to assign to this CPU * @newpri: The priority (INVALID-RT99) to assign to this CPU
* *
* Note: Assumes cpu_rq(cpu)->lock is locked * Note: Assumes cpu_rq(cpu)->lock is locked
* *
...@@ -200,7 +200,6 @@ void cpupri_set(struct cpupri *cp, int cpu, int newpri) ...@@ -200,7 +200,6 @@ void cpupri_set(struct cpupri *cp, int cpu, int newpri)
/** /**
* cpupri_init - initialize the cpupri structure * cpupri_init - initialize the cpupri structure
* @cp: The cpupri context * @cp: The cpupri context
* @bootmem: true if allocations need to use bootmem
* *
* Returns: -ENOMEM if memory fails. * Returns: -ENOMEM if memory fails.
*/ */
......
...@@ -5,7 +5,7 @@ use strict; ...@@ -5,7 +5,7 @@ use strict;
## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
## Copyright (C) 2001 Simon Huggins ## ## Copyright (C) 2001 Simon Huggins ##
## Copyright (C) 2005-2010 Randy Dunlap ## ## Copyright (C) 2005-2012 Randy Dunlap ##
## ## ## ##
## #define enhancements by Armin Kuster <akuster@mvista.com> ## ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
## Copyright (c) 2000 MontaVista Software, Inc. ## ## Copyright (c) 2000 MontaVista Software, Inc. ##
...@@ -1785,6 +1785,7 @@ sub dump_function($$) { ...@@ -1785,6 +1785,7 @@ sub dump_function($$) {
$prototype =~ s/__devinit +//; $prototype =~ s/__devinit +//;
$prototype =~ s/__init +//; $prototype =~ s/__init +//;
$prototype =~ s/__init_or_module +//; $prototype =~ s/__init_or_module +//;
$prototype =~ s/__must_check +//;
$prototype =~ s/^#\s*define\s+//; #ak added $prototype =~ s/^#\s*define\s+//; #ak added
$prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//; $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment