* [Patch] Documentation tweaks to remove build errors
@ 2003-10-03 0:32 Michael Still
2003-10-03 2:20 ` Michael Still
0 siblings, 1 reply; 2+ messages in thread
From: Michael Still @ 2003-10-03 0:32 UTC (permalink / raw)
To: akpm; +Cc: linux-kernel
[-- Attachment #1: Type: text/plain, Size: 402 bytes --]
Hello.
This is a forward port of my previous patch to cset-20031002_1507.
Please apply.
Cheers,
Mikal
--
Michael Still (mikal@stillhq.com) | "All my life I've had one dream,
http://www.stillhq.com | to achieve my many goals"
UTC + 10 | -- Homer Simpson
-------------------------------------------------
This mail sent through IMP: http://horde.org/imp/
[-- Attachment #2: mandocs_tweaks-mega-001-002-f005 --]
[-- Type: application/octet-stream, Size: 14312 bytes --]
diff -Nur linux-2.6.0-test6-cset-20031002_1507/arch/i386/kernel/mca.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/arch/i386/kernel/mca.c
--- linux-2.6.0-test6-cset-20031002_1507/arch/i386/kernel/mca.c 2003-10-03 09:30:38.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/arch/i386/kernel/mca.c 2003-10-03 09:40:10.000000000 +1000
@@ -132,7 +132,9 @@
#define MCA_STANDARD_RESOURCES (sizeof(mca_standard_resources)/sizeof(struct resource))
/**
- * mca_read_pos - read the POS registers into a memory buffer
+ * mca_read_and_store_pos - read the POS registers into a memory buffer
+ * @pos: a char pointer to 8 bytes, contains the POS register value on
+ * successful return
*
* Returns 1 if a card actually exists (i.e. the pos isn't
* all 0xff) or 0 otherwise
diff -Nur linux-2.6.0-test6-cset-20031002_1507/drivers/block/ll_rw_blk.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/block/ll_rw_blk.c
--- linux-2.6.0-test6-cset-20031002_1507/drivers/block/ll_rw_blk.c 2003-10-03 09:32:06.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/block/ll_rw_blk.c 2003-10-03 09:40:10.000000000 +1000
@@ -119,7 +119,7 @@
/**
* blk_get_backing_dev_info - get the address of a queue's backing_dev_info
- * @dev: device
+ * @bdev: device
*
* Locates the passed device's request queue and returns the address of its
* backing_dev_info
@@ -414,8 +414,8 @@
/**
* blk_queue_dma_alignment - set dma length and memory alignment
- * @q: the request queue for the device
- * @dma_mask: alignment mask
+ * @q: the request queue for the device
+ * @mask: alignment mask
*
* description:
* set required memory and length aligment for direct dma transactions.
@@ -1152,7 +1152,7 @@
/**
* blk_run_queue - run a single device queue
- * @q The queue to run
+ * @q: The queue to run
*/
void blk_run_queue(struct request_queue *q)
{
diff -Nur linux-2.6.0-test6-cset-20031002_1507/drivers/pci/pci.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/pci/pci.c
--- linux-2.6.0-test6-cset-20031002_1507/drivers/pci/pci.c 2003-10-03 09:30:10.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/pci/pci.c 2003-10-03 09:40:10.000000000 +1000
@@ -126,11 +126,13 @@
/**
* pci_bus_find_capability - query for devices' capabilities
- * @dev: PCI device to query
- * @cap: capability code
+ * @bus: the PCI bus to query
+ * @devfn: PCI device to query
+ * @cap: capability code
*
* Like pci_find_capability() but works for pci devices that do not have a
* pci_dev structure set up yet.
+ *
* Returns the address of the requested capability structure within the
* device's PCI configuration space or 0 in case the device does not
* support it.
diff -Nur linux-2.6.0-test6-cset-20031002_1507/drivers/serial/8250.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/serial/8250.c
--- linux-2.6.0-test6-cset-20031002_1507/drivers/serial/8250.c 2003-10-03 09:32:08.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/serial/8250.c 2003-10-03 09:40:10.000000000 +1000
@@ -2111,7 +2111,8 @@
/**
* serial8250_suspend_port - suspend one serial port
- * @line: serial line number
+ * @line: serial line number
+ * @level: the level of port suspension, as per uart_suspend_port
*
* Suspend one serial port.
*/
@@ -2122,7 +2123,8 @@
/**
* serial8250_resume_port - resume one serial port
- * @line: serial line number
+ * @line: serial line number
+ * @level: the level of port resumption, as per uart_resume_port
*
* Resume one serial port.
*/
diff -Nur linux-2.6.0-test6-cset-20031002_1507/drivers/serial/serial_core.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/serial/serial_core.c
--- linux-2.6.0-test6-cset-20031002_1507/drivers/serial/serial_core.c 2003-10-03 09:30:17.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/drivers/serial/serial_core.c 2003-10-03 09:40:10.000000000 +1000
@@ -263,9 +263,9 @@
/**
* uart_update_timeout - update per-port FIFO timeout.
- * @port: uart_port structure describing the port.
+ * @port: uart_port structure describing the port
* @cflag: termios cflag value
- * @quot: uart clock divisor quotient
+ * @baud: speed of the port
*
* Set the port FIFO timeout value. The @cflag value should
* reflect the actual hardware settings.
diff -Nur linux-2.6.0-test6-cset-20031002_1507/fs/devfs/base.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/devfs/base.c
--- linux-2.6.0-test6-cset-20031002_1507/fs/devfs/base.c 2003-10-03 09:31:21.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/devfs/base.c 2003-10-03 09:40:10.000000000 +1000
@@ -973,8 +973,9 @@
/**
* _devfs_alloc_entry - Allocate a devfs entry.
- * @name: The name of the entry.
- * @namelen: The number of characters in @name.
+ * @name: the name of the entry
+ * @namelen: the number of characters in @name
+ * @mode: the mode for the entry
*
* Allocate a devfs entry and returns a pointer to the entry on success, else
* %NULL.
diff -Nur linux-2.6.0-test6-cset-20031002_1507/fs/inode.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/inode.c
--- linux-2.6.0-test6-cset-20031002_1507/fs/inode.c 2003-10-03 09:32:11.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/inode.c 2003-10-03 09:40:10.000000000 +1000
@@ -255,6 +255,9 @@
EXPORT_SYMBOL(clear_inode);
/*
+ * dispose_list - dispose of the contents of a local list
+ * @head: the head of the list to free
+ *
* Dispose-list gets a local list with local inodes in it, so it doesn't
* need to worry about list corruption and SMP locks.
*/
@@ -739,11 +742,11 @@
/**
* ifind - internal function, you want ilookup5() or iget5().
* @sb: super block of file system to search
- * @hashval: hash value (usually inode number) to search for
+ * @head: the head of the list to search
* @test: callback used for comparisons between inodes
* @data: opaque data pointer to pass to @test
*
- * ifind() searches for the inode specified by @hashval and @data in the inode
+ * ifind() searches for the inode specified by @data in the inode
* cache. This is a generalized version of ifind_fast() for file systems where
* the inode number is not sufficient for unique identification of an inode.
*
@@ -775,6 +778,7 @@
/**
* ifind_fast - internal function, you want ilookup() or iget().
* @sb: super block of file system to search
+ * @head: head of the list to search
* @ino: inode number to search for
*
* ifind_fast() searches for the inode @ino in the inode cache. This is for
diff -Nur linux-2.6.0-test6-cset-20031002_1507/fs/locks.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/locks.c
--- linux-2.6.0-test6-cset-20031002_1507/fs/locks.c 2003-10-03 09:31:23.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/locks.c 2003-10-03 09:40:10.000000000 +1000
@@ -928,10 +928,10 @@
* locks_mandatory_area - Check for a conflicting lock
* @read_write: %FLOCK_VERIFY_WRITE for exclusive access, %FLOCK_VERIFY_READ
* for shared
- * @inode: the file to check
- * @file: how the file was opened (if it was)
- * @offset: start of area to check
- * @count: length of area to check
+ * @inode: the file to check
+ * @filp: how the file was opened (if it was)
+ * @offset: start of area to check
+ * @count: length of area to check
*
* Searches the inode's list of locks to find any POSIX locks which conflict.
* This function is called from locks_verify_area() and
@@ -1119,6 +1119,7 @@
/**
* lease_get_mtime
* @inode: the inode
+ * @time: pointer to a timespec which will contain the last modified time
*
* This is to force NFS clients to flush their caches for files with
* exclusive leases. The justification is that if someone has an
@@ -1726,6 +1727,7 @@
/**
* posix_unblock_lock - stop waiting for a file lock
+ * @filp: how the file was opened
* @waiter: the lock which was waiting
*
* lockd needs to block waiting for locks.
diff -Nur linux-2.6.0-test6-cset-20031002_1507/fs/super.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/super.c
--- linux-2.6.0-test6-cset-20031002_1507/fs/super.c 2003-10-03 09:32:11.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/fs/super.c 2003-10-03 09:40:10.000000000 +1000
@@ -138,8 +138,8 @@
EXPORT_SYMBOL(deactivate_super);
/**
- * grab_super - acquire an active reference
- * @s - reference we are trying to make active
+ * grab_super - acquire an active reference
+ * @s: reference we are trying to make active
*
* Tries to acquire an active reference. grab_super() is used when we
* had just found a superblock in super_blocks or fs_type->fs_supers
@@ -368,8 +368,8 @@
}
/**
- * get_super - get the superblock of a device
- * @dev: device to get the superblock for
+ * get_super - get the superblock of a device
+ * @bdev: device to get the superblock for
*
* Scans the superblock list and finds the superblock of the file system
* mounted on the device given. %NULL is returned if no match is found.
@@ -461,10 +461,11 @@
}
/**
- * do_remount_sb - asks filesystem to change mount options.
+ * do_remount_sb - asks filesystem to change mount options.
* @sb: superblock in question
* @flags: numeric part of options
* @data: the rest of options
+ * @force: whether or not to force the change
*
* Alters the mount options of a mounted file system.
*/
diff -Nur linux-2.6.0-test6-cset-20031002_1507/include/linux/list.h linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/include/linux/list.h
--- linux-2.6.0-test6-cset-20031002_1507/include/linux/list.h 2003-10-03 09:32:12.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/include/linux/list.h 2003-10-03 09:40:10.000000000 +1000
@@ -449,7 +449,7 @@
/**
* hlist_del_rcu - deletes entry from hash list without re-initialization
- * @entry: the element to delete from the hash list.
+ * @n: the element to delete from the hash list.
*
* Note: list_unhashed() on entry does not return true after this,
* the entry is in an undefined state. It is useful for RCU based
diff -Nur linux-2.6.0-test6-cset-20031002_1507/include/linux/skbuff.h linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/include/linux/skbuff.h
--- linux-2.6.0-test6-cset-20031002_1507/include/linux/skbuff.h 2003-10-03 09:31:26.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/include/linux/skbuff.h 2003-10-03 09:40:10.000000000 +1000
@@ -152,6 +152,7 @@
* @sk: Socket we are owned by
* @stamp: Time we arrived
* @dev: Device we arrived on/are leaving by
+ * @real_dev: The real device we are using
* @h: Transport layer header
* @nh: Network layer header
* @mac: Link layer header
@@ -179,6 +180,7 @@
* @nfct: Associated connection, if any
* @nf_debug: Netfilter debugging
* @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
+ * @private: Data which is private to the HIPPI implementation
* @tc_index: Traffic control index
*/
diff -Nur linux-2.6.0-test6-cset-20031002_1507/kernel/kmod.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/kernel/kmod.c
--- linux-2.6.0-test6-cset-20031002_1507/kernel/kmod.c 2003-10-03 09:31:59.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/kernel/kmod.c 2003-10-03 09:40:10.000000000 +1000
@@ -47,7 +47,8 @@
/**
* request_module - try to load a kernel module
- * @module_name: Name of module
+ * @fmt: printf style format string for the name of the module
+ * @varargs: arguements as specified in the format string
*
* Load a module using the user mode module loader. The function returns
* zero on success or a negative errno code on failure. Note that a
diff -Nur linux-2.6.0-test6-cset-20031002_1507/mm/slab.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/mm/slab.c
--- linux-2.6.0-test6-cset-20031002_1507/mm/slab.c 2003-10-03 09:32:04.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/mm/slab.c 2003-10-03 09:40:10.000000000 +1000
@@ -2675,8 +2675,8 @@
* slabinfo_write - Tuning for the slab allocator
* @file: unused
* @buffer: user buffer
- * @count: data len
- * @data: unused
+ * @count: data length
+ * @ppos: unused
*/
ssize_t slabinfo_write(struct file *file, const char __user *buffer,
size_t count, loff_t *ppos)
diff -Nur linux-2.6.0-test6-cset-20031002_1507/net/core/dev.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/net/core/dev.c
--- linux-2.6.0-test6-cset-20031002_1507/net/core/dev.c 2003-10-03 09:32:12.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/net/core/dev.c 2003-10-03 09:40:10.000000000 +1000
@@ -915,6 +915,8 @@
/**
* call_netdevice_notifiers - call all network notifier blocks
+ * @val: value passed unmodified to notifier function
+ * @v: pointer passed unmodified to notifier function
*
* Call all network notifier blocks. Parameters and return value
* are as for notifier_call_chain().
diff -Nur linux-2.6.0-test6-cset-20031002_1507/sound/oss/via82cxxx_audio.c linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/sound/oss/via82cxxx_audio.c
--- linux-2.6.0-test6-cset-20031002_1507/sound/oss/via82cxxx_audio.c 2003-10-03 09:31:56.000000000 +1000
+++ linux-2.6.0-test6-cset-20031002_1507-mandocs_tweaks-mega-001-002-f005/sound/oss/via82cxxx_audio.c 2003-10-03 09:40:10.000000000 +1000
@@ -1844,6 +1844,7 @@
/**
* via_intr_channel - handle an interrupt for a single channel
+ * @card: unused
* @chan: handle interrupt for this channel
*
* This is the "meat" of the interrupt handler,
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [Patch] Documentation tweaks to remove build errors
2003-10-03 0:32 [Patch] Documentation tweaks to remove build errors Michael Still
@ 2003-10-03 2:20 ` Michael Still
0 siblings, 0 replies; 2+ messages in thread
From: Michael Still @ 2003-10-03 2:20 UTC (permalink / raw)
To: Michael Still; +Cc: akpm, linux-kernel
Quoting Michael Still <mikal@stillhq.com>:
> This is a forward port of my previous patch to cset-20031002_1507.
To clarify, the patch is a forward port from test5 of patches already submitted.
The files patched are:
# arch/i386/kernel/mca.c
# drivers/block/ll_rw_blk.c
# drivers/pci/pci.c
# drivers/serial/8250.c
# drivers/serial/serial_core.c
# fs/devfs/base.c
# fs/inode.c
# fs/locks.c
# fs/super.c
# include/linux/list.h
# include/linux/skbuff.h
# kernel/kmod.c
# mm/slab.c
# net/core/dev.c
# sound/oss/via82cxxx_audio.c
The patch squelches build errors in the kernel-doc make targets by adding
documentation to arguements previously not documented, and updating the argument
names where they have changed.
Cheers,
Mikal
--
Michael Still (mikal@stillhq.com) | "All my life I've had one dream,
http://www.stillhq.com | to achieve my many goals"
UTC + 10 | -- Homer Simpson
-------------------------------------------------
This mail sent through IMP: http://horde.org/imp/
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2003-10-03 2:19 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2003-10-03 0:32 [Patch] Documentation tweaks to remove build errors Michael Still
2003-10-03 2:20 ` Michael Still
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®