diff options
author | Martin Waitz <tali@admingilde.org> | 2005-05-01 11:59:26 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@ppc970.osdl.org> | 2005-05-01 11:59:26 -0400 |
commit | 67be2dd1bace0ec7ce2dbc1bba3f8df3d7be597e (patch) | |
tree | 317d114a0288d3b19ef9902f94b536a5a8731dbd | |
parent | 6013d5445f9a6d0b28090027868f455c5012d1cc (diff) |
[PATCH] DocBook: fix some descriptions
Some KernelDoc descriptions are updated to match the current code.
No code changes.
Signed-off-by: Martin Waitz <tali@admingilde.org>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
-rw-r--r-- | drivers/acpi/scan.c | 4 | ||||
-rw-r--r-- | drivers/base/platform.c | 4 | ||||
-rw-r--r-- | drivers/pci/hotplug.c | 4 | ||||
-rw-r--r-- | drivers/pci/rom.c | 14 | ||||
-rw-r--r-- | drivers/pnp/manager.c | 2 | ||||
-rw-r--r-- | fs/bio.c | 2 | ||||
-rw-r--r-- | fs/buffer.c | 11 | ||||
-rw-r--r-- | fs/fs-writeback.c | 4 | ||||
-rw-r--r-- | fs/mpage.c | 92 | ||||
-rw-r--r-- | fs/proc/base.c | 2 | ||||
-rw-r--r-- | fs/seq_file.c | 9 | ||||
-rw-r--r-- | fs/sysfs/file.c | 4 | ||||
-rw-r--r-- | include/linux/fs.h | 100 | ||||
-rw-r--r-- | include/linux/skbuff.h | 5 | ||||
-rw-r--r-- | include/net/sock.h | 1 | ||||
-rw-r--r-- | kernel/sched.c | 3 | ||||
-rw-r--r-- | kernel/sysctl.c | 2 | ||||
-rw-r--r-- | lib/kobject.c | 3 | ||||
-rw-r--r-- | mm/filemap.c | 17 | ||||
-rw-r--r-- | mm/page-writeback.c | 6 | ||||
-rw-r--r-- | mm/truncate.c | 4 | ||||
-rw-r--r-- | net/core/datagram.c | 4 |
22 files changed, 160 insertions, 137 deletions
diff --git a/drivers/acpi/scan.c b/drivers/acpi/scan.c index e7ca06626566..119c94093a13 100644 --- a/drivers/acpi/scan.c +++ b/drivers/acpi/scan.c | |||
@@ -379,8 +379,8 @@ ACPI_DEVICE_ATTR(eject, 0200, NULL, acpi_eject_store); | |||
379 | 379 | ||
380 | /** | 380 | /** |
381 | * setup_sys_fs_device_files - sets up the device files under device namespace | 381 | * setup_sys_fs_device_files - sets up the device files under device namespace |
382 | * @@dev: acpi_device object | 382 | * @dev: acpi_device object |
383 | * @@func: function pointer to create or destroy the device file | 383 | * @func: function pointer to create or destroy the device file |
384 | */ | 384 | */ |
385 | static void | 385 | static void |
386 | setup_sys_fs_device_files ( | 386 | setup_sys_fs_device_files ( |
diff --git a/drivers/base/platform.c b/drivers/base/platform.c index cd6453905a9b..3a5f4c991797 100644 --- a/drivers/base/platform.c +++ b/drivers/base/platform.c | |||
@@ -115,7 +115,7 @@ int platform_add_devices(struct platform_device **devs, int num) | |||
115 | 115 | ||
116 | /** | 116 | /** |
117 | * platform_device_register - add a platform-level device | 117 | * platform_device_register - add a platform-level device |
118 | * @dev: platform device we're adding | 118 | * @pdev: platform device we're adding |
119 | * | 119 | * |
120 | */ | 120 | */ |
121 | int platform_device_register(struct platform_device * pdev) | 121 | int platform_device_register(struct platform_device * pdev) |
@@ -174,7 +174,7 @@ int platform_device_register(struct platform_device * pdev) | |||
174 | 174 | ||
175 | /** | 175 | /** |
176 | * platform_device_unregister - remove a platform-level device | 176 | * platform_device_unregister - remove a platform-level device |
177 | * @dev: platform device we're removing | 177 | * @pdev: platform device we're removing |
178 | * | 178 | * |
179 | * Note that this function will also release all memory- and port-based | 179 | * Note that this function will also release all memory- and port-based |
180 | * resources owned by the device (@dev->resource). | 180 | * resources owned by the device (@dev->resource). |
diff --git a/drivers/pci/hotplug.c b/drivers/pci/hotplug.c index d471b3ea5d12..021d0f76bc4c 100644 --- a/drivers/pci/hotplug.c +++ b/drivers/pci/hotplug.c | |||
@@ -120,6 +120,10 @@ static int pci_visit_bridge (struct pci_visit * fn, | |||
120 | 120 | ||
121 | /** | 121 | /** |
122 | * pci_visit_dev - scans the pci buses. | 122 | * pci_visit_dev - scans the pci buses. |
123 | * @fn: callback functions that are called while visiting | ||
124 | * @wrapped_dev: the device to scan | ||
125 | * @wrapped_parent: the bus where @wrapped_dev is connected to | ||
126 | * | ||
123 | * Every bus and every function is presented to a custom | 127 | * Every bus and every function is presented to a custom |
124 | * function that can act upon it. | 128 | * function that can act upon it. |
125 | */ | 129 | */ |
diff --git a/drivers/pci/rom.c b/drivers/pci/rom.c index 3e64ff64b38c..838575e3fac6 100644 --- a/drivers/pci/rom.c +++ b/drivers/pci/rom.c | |||
@@ -14,7 +14,7 @@ | |||
14 | 14 | ||
15 | /** | 15 | /** |
16 | * pci_enable_rom - enable ROM decoding for a PCI device | 16 | * pci_enable_rom - enable ROM decoding for a PCI device |
17 | * @dev: PCI device to enable | 17 | * @pdev: PCI device to enable |
18 | * | 18 | * |
19 | * Enable ROM decoding on @dev. This involves simply turning on the last | 19 | * Enable ROM decoding on @dev. This involves simply turning on the last |
20 | * bit of the PCI ROM BAR. Note that some cards may share address decoders | 20 | * 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) | |||
32 | 32 | ||
33 | /** | 33 | /** |
34 | * pci_disable_rom - disable ROM decoding for a PCI device | 34 | * pci_disable_rom - disable ROM decoding for a PCI device |
35 | * @dev: PCI device to disable | 35 | * @pdev: PCI device to disable |
36 | * | 36 | * |
37 | * Disable ROM decoding on a PCI device by turning off the last bit in the | 37 | * Disable ROM decoding on a PCI device by turning off the last bit in the |
38 | * ROM BAR. | 38 | * ROM BAR. |
@@ -47,7 +47,7 @@ static void pci_disable_rom(struct pci_dev *pdev) | |||
47 | 47 | ||
48 | /** | 48 | /** |
49 | * pci_map_rom - map a PCI ROM to kernel space | 49 | * pci_map_rom - map a PCI ROM to kernel space |
50 | * @dev: pointer to pci device struct | 50 | * @pdev: pointer to pci device struct |
51 | * @size: pointer to receive size of pci window over ROM | 51 | * @size: pointer to receive size of pci window over ROM |
52 | * @return: kernel virtual pointer to image of ROM | 52 | * @return: kernel virtual pointer to image of ROM |
53 | * | 53 | * |
@@ -132,7 +132,7 @@ void __iomem *pci_map_rom(struct pci_dev *pdev, size_t *size) | |||
132 | 132 | ||
133 | /** | 133 | /** |
134 | * pci_map_rom_copy - map a PCI ROM to kernel space, create a copy | 134 | * pci_map_rom_copy - map a PCI ROM to kernel space, create a copy |
135 | * @dev: pointer to pci device struct | 135 | * @pdev: pointer to pci device struct |
136 | * @size: pointer to receive size of pci window over ROM | 136 | * @size: pointer to receive size of pci window over ROM |
137 | * @return: kernel virtual pointer to image of ROM | 137 | * @return: kernel virtual pointer to image of ROM |
138 | * | 138 | * |
@@ -166,7 +166,7 @@ void __iomem *pci_map_rom_copy(struct pci_dev *pdev, size_t *size) | |||
166 | 166 | ||
167 | /** | 167 | /** |
168 | * pci_unmap_rom - unmap the ROM from kernel space | 168 | * pci_unmap_rom - unmap the ROM from kernel space |
169 | * @dev: pointer to pci device struct | 169 | * @pdev: pointer to pci device struct |
170 | * @rom: virtual address of the previous mapping | 170 | * @rom: virtual address of the previous mapping |
171 | * | 171 | * |
172 | * Remove a mapping of a previously mapped ROM | 172 | * Remove a mapping of a previously mapped ROM |
@@ -187,7 +187,7 @@ void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom) | |||
187 | 187 | ||
188 | /** | 188 | /** |
189 | * pci_remove_rom - disable the ROM and remove its sysfs attribute | 189 | * pci_remove_rom - disable the ROM and remove its sysfs attribute |
190 | * @dev: pointer to pci device struct | 190 | * @pdev: pointer to pci device struct |
191 | * | 191 | * |
192 | * Remove the rom file in sysfs and disable ROM decoding. | 192 | * Remove the rom file in sysfs and disable ROM decoding. |
193 | */ | 193 | */ |
@@ -206,7 +206,7 @@ void pci_remove_rom(struct pci_dev *pdev) | |||
206 | /** | 206 | /** |
207 | * pci_cleanup_rom - internal routine for freeing the ROM copy created | 207 | * pci_cleanup_rom - internal routine for freeing the ROM copy created |
208 | * by pci_map_rom_copy called from remove.c | 208 | * by pci_map_rom_copy called from remove.c |
209 | * @dev: pointer to pci device struct | 209 | * @pdev: pointer to pci device struct |
210 | * | 210 | * |
211 | * Free the copied ROM if we allocated one. | 211 | * Free the copied ROM if we allocated one. |
212 | */ | 212 | */ |
diff --git a/drivers/pnp/manager.c b/drivers/pnp/manager.c index 639e04253482..65ecef738537 100644 --- a/drivers/pnp/manager.c +++ b/drivers/pnp/manager.c | |||
@@ -253,7 +253,7 @@ void pnp_init_resource_table(struct pnp_resource_table *table) | |||
253 | 253 | ||
254 | /** | 254 | /** |
255 | * pnp_clean_resources - clears resources that were not manually set | 255 | * pnp_clean_resources - clears resources that were not manually set |
256 | * @res - the resources to clean | 256 | * @res: the resources to clean |
257 | * | 257 | * |
258 | */ | 258 | */ |
259 | static void pnp_clean_resource_table(struct pnp_resource_table * res) | 259 | static void pnp_clean_resource_table(struct pnp_resource_table * res) |
@@ -140,6 +140,7 @@ inline void bio_init(struct bio *bio) | |||
140 | * bio_alloc_bioset - allocate a bio for I/O | 140 | * bio_alloc_bioset - allocate a bio for I/O |
141 | * @gfp_mask: the GFP_ mask given to the slab allocator | 141 | * @gfp_mask: the GFP_ mask given to the slab allocator |
142 | * @nr_iovecs: number of iovecs to pre-allocate | 142 | * @nr_iovecs: number of iovecs to pre-allocate |
143 | * @bs: the bio_set to allocate from | ||
143 | * | 144 | * |
144 | * Description: | 145 | * Description: |
145 | * bio_alloc_bioset will first try it's on mempool to satisfy the allocation. | 146 | * bio_alloc_bioset will first try it's on mempool to satisfy the allocation. |
@@ -629,6 +630,7 @@ out: | |||
629 | 630 | ||
630 | /** | 631 | /** |
631 | * bio_map_user - map user address into bio | 632 | * bio_map_user - map user address into bio |
633 | * @q: the request_queue_t for the bio | ||
632 | * @bdev: destination block device | 634 | * @bdev: destination block device |
633 | * @uaddr: start of user address | 635 | * @uaddr: start of user address |
634 | * @len: length in bytes | 636 | * @len: length in bytes |
diff --git a/fs/buffer.c b/fs/buffer.c index 792cbacbbf41..5f525b3c6d9f 100644 --- a/fs/buffer.c +++ b/fs/buffer.c | |||
@@ -774,15 +774,14 @@ repeat: | |||
774 | /** | 774 | /** |
775 | * sync_mapping_buffers - write out and wait upon a mapping's "associated" | 775 | * sync_mapping_buffers - write out and wait upon a mapping's "associated" |
776 | * buffers | 776 | * buffers |
777 | * @buffer_mapping - the mapping which backs the buffers' data | 777 | * @mapping: the mapping which wants those buffers written |
778 | * @mapping - the mapping which wants those buffers written | ||
779 | * | 778 | * |
780 | * Starts I/O against the buffers at mapping->private_list, and waits upon | 779 | * Starts I/O against the buffers at mapping->private_list, and waits upon |
781 | * that I/O. | 780 | * that I/O. |
782 | * | 781 | * |
783 | * Basically, this is a convenience function for fsync(). @buffer_mapping is | 782 | * Basically, this is a convenience function for fsync(). |
784 | * the blockdev which "owns" the buffers and @mapping is a file or directory | 783 | * @mapping is a file or directory which needs those buffers to be written for |
785 | * which needs those buffers to be written for a successful fsync(). | 784 | * a successful fsync(). |
786 | */ | 785 | */ |
787 | int sync_mapping_buffers(struct address_space *mapping) | 786 | int sync_mapping_buffers(struct address_space *mapping) |
788 | { | 787 | { |
@@ -1263,6 +1262,7 @@ __getblk_slow(struct block_device *bdev, sector_t block, int size) | |||
1263 | 1262 | ||
1264 | /** | 1263 | /** |
1265 | * mark_buffer_dirty - mark a buffer_head as needing writeout | 1264 | * mark_buffer_dirty - mark a buffer_head as needing writeout |
1265 | * @bh: the buffer_head to mark dirty | ||
1266 | * | 1266 | * |
1267 | * mark_buffer_dirty() will set the dirty bit against the buffer, then set its | 1267 | * mark_buffer_dirty() will set the dirty bit against the buffer, then set its |
1268 | * backing page dirty, then tag the page as dirty in its address_space's radix | 1268 | * backing page dirty, then tag the page as dirty in its address_space's radix |
@@ -1501,6 +1501,7 @@ EXPORT_SYMBOL(__breadahead); | |||
1501 | 1501 | ||
1502 | /** | 1502 | /** |
1503 | * __bread() - reads a specified block and returns the bh | 1503 | * __bread() - reads a specified block and returns the bh |
1504 | * @bdev: the block_device to read from | ||
1504 | * @block: number of block | 1505 | * @block: number of block |
1505 | * @size: size (in bytes) to read | 1506 | * @size: size (in bytes) to read |
1506 | * | 1507 | * |
diff --git a/fs/fs-writeback.c b/fs/fs-writeback.c index d6efb36cab2a..8e050fa58218 100644 --- a/fs/fs-writeback.c +++ b/fs/fs-writeback.c | |||
@@ -512,7 +512,8 @@ restart: | |||
512 | } | 512 | } |
513 | 513 | ||
514 | /** | 514 | /** |
515 | * sync_inodes | 515 | * sync_inodes - writes all inodes to disk |
516 | * @wait: wait for completion | ||
516 | * | 517 | * |
517 | * sync_inodes() goes through each super block's dirty inode list, writes the | 518 | * sync_inodes() goes through each super block's dirty inode list, writes the |
518 | * inodes out, waits on the writeout and puts the inodes back on the normal | 519 | * inodes out, waits on the writeout and puts the inodes back on the normal |
@@ -604,6 +605,7 @@ EXPORT_SYMBOL(sync_inode); | |||
604 | /** | 605 | /** |
605 | * generic_osync_inode - flush all dirty data for a given inode to disk | 606 | * generic_osync_inode - flush all dirty data for a given inode to disk |
606 | * @inode: inode to write | 607 | * @inode: inode to write |
608 | * @mapping: the address_space that should be flushed | ||
607 | * @what: what to write and wait upon | 609 | * @what: what to write and wait upon |
608 | * | 610 | * |
609 | * This can be called by file_write functions for files which have the | 611 | * This can be called by file_write functions for files which have the |
diff --git a/fs/mpage.c b/fs/mpage.c index 3923facf94eb..32c7c8fcfce7 100644 --- a/fs/mpage.c +++ b/fs/mpage.c | |||
@@ -160,52 +160,6 @@ map_buffer_to_page(struct page *page, struct buffer_head *bh, int page_block) | |||
160 | } while (page_bh != head); | 160 | } while (page_bh != head); |
161 | } | 161 | } |
162 | 162 | ||
163 | /** | ||
164 | * mpage_readpages - populate an address space with some pages, and | ||
165 | * start reads against them. | ||
166 | * | ||
167 | * @mapping: the address_space | ||
168 | * @pages: The address of a list_head which contains the target pages. These | ||
169 | * pages have their ->index populated and are otherwise uninitialised. | ||
170 | * | ||
171 | * The page at @pages->prev has the lowest file offset, and reads should be | ||
172 | * issued in @pages->prev to @pages->next order. | ||
173 | * | ||
174 | * @nr_pages: The number of pages at *@pages | ||
175 | * @get_block: The filesystem's block mapper function. | ||
176 | * | ||
177 | * This function walks the pages and the blocks within each page, building and | ||
178 | * emitting large BIOs. | ||
179 | * | ||
180 | * If anything unusual happens, such as: | ||
181 | * | ||
182 | * - encountering a page which has buffers | ||
183 | * - encountering a page which has a non-hole after a hole | ||
184 | * - encountering a page with non-contiguous blocks | ||
185 | * | ||
186 | * then this code just gives up and calls the buffer_head-based read function. | ||
187 | * It does handle a page which has holes at the end - that is a common case: | ||
188 | * the end-of-file on blocksize < PAGE_CACHE_SIZE setups. | ||
189 | * | ||
190 | * BH_Boundary explanation: | ||
191 | * | ||
192 | * There is a problem. The mpage read code assembles several pages, gets all | ||
193 | * their disk mappings, and then submits them all. That's fine, but obtaining | ||
194 | * the disk mappings may require I/O. Reads of indirect blocks, for example. | ||
195 | * | ||
196 | * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be | ||
197 | * submitted in the following order: | ||
198 | * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 | ||
199 | * because the indirect block has to be read to get the mappings of blocks | ||
200 | * 13,14,15,16. Obviously, this impacts performance. | ||
201 | * | ||
202 | * So what we do it to allow the filesystem's get_block() function to set | ||
203 | * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block | ||
204 | * after this one will require I/O against a block which is probably close to | ||
205 | * this one. So you should push what I/O you have currently accumulated. | ||
206 | * | ||
207 | * This all causes the disk requests to be issued in the correct order. | ||
208 | */ | ||
209 | static struct bio * | 163 | static struct bio * |
210 | do_mpage_readpage(struct bio *bio, struct page *page, unsigned nr_pages, | 164 | do_mpage_readpage(struct bio *bio, struct page *page, unsigned nr_pages, |
211 | sector_t *last_block_in_bio, get_block_t get_block) | 165 | sector_t *last_block_in_bio, get_block_t get_block) |
@@ -320,6 +274,52 @@ confused: | |||
320 | goto out; | 274 | goto out; |
321 | } | 275 | } |
322 | 276 | ||
277 | /** | ||
278 | * mpage_readpages - populate an address space with some pages, and | ||
279 | * start reads against them. | ||
280 | * | ||
281 | * @mapping: the address_space | ||
282 | * @pages: The address of a list_head which contains the target pages. These | ||
283 | * pages have their ->index populated and are otherwise uninitialised. | ||
284 | * | ||
285 | * The page at @pages->prev has the lowest file offset, and reads should be | ||
286 | * issued in @pages->prev to @pages->next order. | ||
287 | * | ||
288 | * @nr_pages: The number of pages at *@pages | ||
289 | * @get_block: The filesystem's block mapper function. | ||
290 | * | ||
291 | * This function walks the pages and the blocks within each page, building and | ||
292 | * emitting large BIOs. | ||
293 | * | ||
294 | * If anything unusual happens, such as: | ||
295 | * | ||
296 | * - encountering a page which has buffers | ||
297 | * - encountering a page which has a non-hole after a hole | ||
298 | * - encountering a page with non-contiguous blocks | ||
299 | * | ||
300 | * then this code just gives up and calls the buffer_head-based read function. | ||
301 | * It does handle a page which has holes at the end - that is a common case: | ||
302 | * the end-of-file on blocksize < PAGE_CACHE_SIZE setups. | ||
303 | * | ||
304 | * BH_Boundary explanation: | ||
305 | * | ||
306 | * There is a problem. The mpage read code assembles several pages, gets all | ||
307 | * their disk mappings, and then submits them all. That's fine, but obtaining | ||
308 | * the disk mappings may require I/O. Reads of indirect blocks, for example. | ||
309 | * | ||
310 | * So an mpage read of the first 16 blocks of an ext2 file will cause I/O to be | ||
311 | * submitted in the following order: | ||
312 | * 12 0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 16 | ||
313 | * because the indirect block has to be read to get the mappings of blocks | ||
314 | * 13,14,15,16. Obviously, this impacts performance. | ||
315 | * | ||
316 | * So what we do it to allow the filesystem's get_block() function to set | ||
317 | * BH_Boundary when it maps block 11. BH_Boundary says: mapping of the block | ||
318 | * after this one will require I/O against a block which is probably close to | ||
319 | * this one. So you should push what I/O you have currently accumulated. | ||
320 | * | ||
321 | * This all causes the disk requests to be issued in the correct order. | ||
322 | */ | ||
323 | int | 323 | int |
324 | mpage_readpages(struct address_space *mapping, struct list_head *pages, | 324 | mpage_readpages(struct address_space *mapping, struct list_head *pages, |
325 | unsigned nr_pages, get_block_t get_block) | 325 | unsigned nr_pages, get_block_t get_block) |
diff --git a/fs/proc/base.c b/fs/proc/base.c index 2b8cd045111c..07cafdf74ef2 100644 --- a/fs/proc/base.c +++ b/fs/proc/base.c | |||
@@ -1742,7 +1742,7 @@ struct dentry *proc_pid_unhash(struct task_struct *p) | |||
1742 | 1742 | ||
1743 | /** | 1743 | /** |
1744 | * proc_pid_flush - recover memory used by stale /proc/@pid/x entries | 1744 | * proc_pid_flush - recover memory used by stale /proc/@pid/x entries |
1745 | * @proc_entry: directoy to prune. | 1745 | * @proc_dentry: directoy to prune. |
1746 | * | 1746 | * |
1747 | * Shrink the /proc directory that was used by the just killed thread. | 1747 | * Shrink the /proc directory that was used by the just killed thread. |
1748 | */ | 1748 | */ |
diff --git a/fs/seq_file.c b/fs/seq_file.c index 650c43ba86c4..38ef913767ff 100644 --- a/fs/seq_file.c +++ b/fs/seq_file.c | |||
@@ -51,7 +51,10 @@ EXPORT_SYMBOL(seq_open); | |||
51 | 51 | ||
52 | /** | 52 | /** |
53 | * seq_read - ->read() method for sequential files. | 53 | * seq_read - ->read() method for sequential files. |
54 | * @file, @buf, @size, @ppos: see file_operations method | 54 | * @file: the file to read from |
55 | * @buf: the buffer to read to | ||
56 | * @size: the maximum number of bytes to read | ||
57 | * @ppos: the current position in the file | ||
55 | * | 58 | * |
56 | * Ready-made ->f_op->read() | 59 | * Ready-made ->f_op->read() |
57 | */ | 60 | */ |
@@ -219,7 +222,9 @@ Eoverflow: | |||
219 | 222 | ||
220 | /** | 223 | /** |
221 | * seq_lseek - ->llseek() method for sequential files. | 224 | * seq_lseek - ->llseek() method for sequential files. |
222 | * @file, @offset, @origin: see file_operations method | 225 | * @file: the file in question |
226 | * @offset: new position | ||
227 | * @origin: 0 for absolute, 1 for relative position | ||
223 | * | 228 | * |
224 | * Ready-made ->f_op->llseek() | 229 | * Ready-made ->f_op->llseek() |
225 | */ | 230 | */ |
diff --git a/fs/sysfs/file.c b/fs/sysfs/file.c index da25aeb0e062..364208071e17 100644 --- a/fs/sysfs/file.c +++ b/fs/sysfs/file.c | |||
@@ -96,7 +96,7 @@ static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer | |||
96 | /** | 96 | /** |
97 | * flush_read_buffer - push buffer to userspace. | 97 | * flush_read_buffer - push buffer to userspace. |
98 | * @buffer: data buffer for file. | 98 | * @buffer: data buffer for file. |
99 | * @userbuf: user-passed buffer. | 99 | * @buf: user-passed buffer. |
100 | * @count: number of bytes requested. | 100 | * @count: number of bytes requested. |
101 | * @ppos: file position. | 101 | * @ppos: file position. |
102 | * | 102 | * |
@@ -164,7 +164,7 @@ out: | |||
164 | /** | 164 | /** |
165 | * fill_write_buffer - copy buffer from userspace. | 165 | * fill_write_buffer - copy buffer from userspace. |
166 | * @buffer: data buffer for file. | 166 | * @buffer: data buffer for file. |
167 | * @userbuf: data from user. | 167 | * @buf: data from user. |
168 | * @count: number of bytes in @userbuf. | 168 | * @count: number of bytes in @userbuf. |
169 | * | 169 | * |
170 | * Allocate @buffer->page if it hasn't been already, then | 170 | * Allocate @buffer->page if it hasn't been already, then |
diff --git a/include/linux/fs.h b/include/linux/fs.h index 3f825b085c8d..4edba067a717 100644 --- a/include/linux/fs.h +++ b/include/linux/fs.h | |||
@@ -1065,71 +1065,75 @@ int sync_inode(struct inode *inode, struct writeback_control *wbc); | |||
1065 | * with a particular exported file system - particularly enabling nfsd and | 1065 | * with a particular exported file system - particularly enabling nfsd and |
1066 | * the filesystem to co-operate when dealing with file handles. | 1066 | * the filesystem to co-operate when dealing with file handles. |
1067 | * | 1067 | * |
1068 | * export_operations contains two basic operation for dealing with file handles, | 1068 | * export_operations contains two basic operation for dealing with file |
1069 | * decode_fh() and encode_fh(), and allows for some other operations to be defined | 1069 | * handles, decode_fh() and encode_fh(), and allows for some other |
1070 | * which standard helper routines use to get specific information from the | 1070 | * operations to be defined which standard helper routines use to get |
1071 | * filesystem. | 1071 | * specific information from the filesystem. |
1072 | * | 1072 | * |
1073 | * nfsd encodes information use to determine which filesystem a filehandle | 1073 | * nfsd encodes information use to determine which filesystem a filehandle |
1074 | * applies to in the initial part of the file handle. The remainder, termed a | 1074 | * applies to in the initial part of the file handle. The remainder, termed |
1075 | * file handle fragment, is controlled completely by the filesystem. | 1075 | * a file handle fragment, is controlled completely by the filesystem. The |
1076 | * The standard helper routines assume that this fragment will contain one or two | 1076 | * standard helper routines assume that this fragment will contain one or |
1077 | * sub-fragments, one which identifies the file, and one which may be used to | 1077 | * two sub-fragments, one which identifies the file, and one which may be |
1078 | * identify the (a) directory containing the file. | 1078 | * used to identify the (a) directory containing the file. |
1079 | * | 1079 | * |
1080 | * In some situations, nfsd needs to get a dentry which is connected into a | 1080 | * In some situations, nfsd needs to get a dentry which is connected into a |
1081 | * specific part of the file tree. To allow for this, it passes the function | 1081 | * specific part of the file tree. To allow for this, it passes the |
1082 | * acceptable() together with a @context which can be used to see if the dentry | 1082 | * function acceptable() together with a @context which can be used to see |
1083 | * is acceptable. As there can be multiple dentrys for a given file, the filesystem | 1083 | * if the dentry is acceptable. As there can be multiple dentrys for a |
1084 | * should check each one for acceptability before looking for the next. As soon | 1084 | * given file, the filesystem should check each one for acceptability before |
1085 | * as an acceptable one is found, it should be returned. | 1085 | * looking for the next. As soon as an acceptable one is found, it should |
1086 | * be returned. | ||
1086 | * | 1087 | * |
1087 | * decode_fh: | 1088 | * decode_fh: |
1088 | * @decode_fh is given a &struct super_block (@sb), a file handle fragment (@fh, @fh_len) | 1089 | * @decode_fh is given a &struct super_block (@sb), a file handle fragment |
1089 | * and an acceptability testing function (@acceptable, @context). It should return | 1090 | * (@fh, @fh_len) and an acceptability testing function (@acceptable, |
1090 | * a &struct dentry which refers to the same file that the file handle fragment refers | 1091 | * @context). It should return a &struct dentry which refers to the same |
1091 | * to, and which passes the acceptability test. If it cannot, it should return | 1092 | * file that the file handle fragment refers to, and which passes the |
1092 | * a %NULL pointer if the file was found but no acceptable &dentries were available, or | 1093 | * acceptability test. If it cannot, it should return a %NULL pointer if |
1093 | * a %ERR_PTR error code indicating why it couldn't be found (e.g. %ENOENT or %ENOMEM). | 1094 | * the file was found but no acceptable &dentries were available, or a |
1095 | * %ERR_PTR error code indicating why it couldn't be found (e.g. %ENOENT or | ||
1096 | * %ENOMEM). | ||
1094 | * | 1097 | * |
1095 | * encode_fh: | 1098 | * encode_fh: |
1096 | * @encode_fh should store in the file handle fragment @fh (using at most @max_len bytes) | 1099 | * @encode_fh should store in the file handle fragment @fh (using at most |
1097 | * information that can be used by @decode_fh to recover the file refered to by the | 1100 | * @max_len bytes) information that can be used by @decode_fh to recover the |
1098 | * &struct dentry @de. If the @connectable flag is set, the encode_fh() should store | 1101 | * file refered to by the &struct dentry @de. If the @connectable flag is |
1099 | * sufficient information so that a good attempt can be made to find not only | 1102 | * set, the encode_fh() should store sufficient information so that a good |
1100 | * the file but also it's place in the filesystem. This typically means storing | 1103 | * attempt can be made to find not only the file but also it's place in the |
1101 | * a reference to de->d_parent in the filehandle fragment. | 1104 | * filesystem. This typically means storing a reference to de->d_parent in |
1102 | * encode_fh() should return the number of bytes stored or a negative error code | 1105 | * the filehandle fragment. encode_fh() should return the number of bytes |
1103 | * such as %-ENOSPC | 1106 | * stored or a negative error code such as %-ENOSPC |
1104 | * | 1107 | * |
1105 | * get_name: | 1108 | * get_name: |
1106 | * @get_name should find a name for the given @child in the given @parent directory. | 1109 | * @get_name should find a name for the given @child in the given @parent |
1107 | * The name should be stored in the @name (with the understanding that it is already | 1110 | * directory. The name should be stored in the @name (with the |
1108 | * pointing to a a %NAME_MAX+1 sized buffer. get_name() should return %0 on success, | 1111 | * understanding that it is already pointing to a a %NAME_MAX+1 sized |
1109 | * a negative error code or error. | 1112 | * buffer. get_name() should return %0 on success, a negative error code |
1110 | * @get_name will be called without @parent->i_sem held. | 1113 | * or error. @get_name will be called without @parent->i_sem held. |
1111 | * | 1114 | * |
1112 | * get_parent: | 1115 | * get_parent: |
1113 | * @get_parent should find the parent directory for the given @child which is also | 1116 | * @get_parent should find the parent directory for the given @child which |
1114 | * a directory. In the event that it cannot be found, or storage space cannot be | 1117 | * is also a directory. In the event that it cannot be found, or storage |
1115 | * allocated, a %ERR_PTR should be returned. | 1118 | * space cannot be allocated, a %ERR_PTR should be returned. |
1116 | * | 1119 | * |
1117 | * get_dentry: | 1120 | * get_dentry: |
1118 | * Given a &super_block (@sb) and a pointer to a file-system specific inode identifier, | 1121 | * Given a &super_block (@sb) and a pointer to a file-system specific inode |
1119 | * possibly an inode number, (@inump) get_dentry() should find the identified inode and | 1122 | * identifier, possibly an inode number, (@inump) get_dentry() should find |
1120 | * return a dentry for that inode. | 1123 | * the identified inode and return a dentry for that inode. Any suitable |
1121 | * Any suitable dentry can be returned including, if necessary, a new dentry created | 1124 | * dentry can be returned including, if necessary, a new dentry created with |
1122 | * with d_alloc_root. The caller can then find any other extant dentrys by following the | 1125 | * d_alloc_root. The caller can then find any other extant dentrys by |
1123 | * d_alias links. If a new dentry was created using d_alloc_root, DCACHE_NFSD_DISCONNECTED | 1126 | * following the d_alias links. If a new dentry was created using |
1124 | * should be set, and the dentry should be d_rehash()ed. | 1127 | * d_alloc_root, DCACHE_NFSD_DISCONNECTED should be set, and the dentry |
1128 | * should be d_rehash()ed. | ||
1125 | * | 1129 | * |
1126 | * If the inode cannot be found, either a %NULL pointer or an %ERR_PTR code can be returned. | 1130 | * If the inode cannot be found, either a %NULL pointer or an %ERR_PTR code |
1127 | * The @inump will be whatever was passed to nfsd_find_fh_dentry() in either the | 1131 | * can be returned. The @inump will be whatever was passed to |
1128 | * @obj or @parent parameters. | 1132 | * nfsd_find_fh_dentry() in either the @obj or @parent parameters. |
1129 | * | 1133 | * |
1130 | * Locking rules: | 1134 | * Locking rules: |
1131 | * get_parent is called with child->d_inode->i_sem down | 1135 | * get_parent is called with child->d_inode->i_sem down |
1132 | * get_name is not (which is possibly inconsistent) | 1136 | * get_name is not (which is possibly inconsistent) |
1133 | */ | 1137 | */ |
1134 | 1138 | ||
1135 | struct export_operations { | 1139 | struct export_operations { |
diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h index c77d745cbd3f..cc04f5cd2286 100644 --- a/include/linux/skbuff.h +++ b/include/linux/skbuff.h | |||
@@ -167,13 +167,14 @@ struct skb_shared_info { | |||
167 | * @h: Transport layer header | 167 | * @h: Transport layer header |
168 | * @nh: Network layer header | 168 | * @nh: Network layer header |
169 | * @mac: Link layer header | 169 | * @mac: Link layer header |
170 | * @dst: FIXME: Describe this field | 170 | * @dst: destination entry |
171 | * @sp: the security path, used for xfrm | ||
171 | * @cb: Control buffer. Free for use by every layer. Put private vars here | 172 | * @cb: Control buffer. Free for use by every layer. Put private vars here |
172 | * @len: Length of actual data | 173 | * @len: Length of actual data |
173 | * @data_len: Data length | 174 | * @data_len: Data length |
174 | * @mac_len: Length of link layer header | 175 | * @mac_len: Length of link layer header |
175 | * @csum: Checksum | 176 | * @csum: Checksum |
176 | * @__unused: Dead field, may be reused | 177 | * @local_df: allow local fragmentation |
177 | * @cloned: Head may be cloned (check refcnt to be sure) | 178 | * @cloned: Head may be cloned (check refcnt to be sure) |
178 | * @nohdr: Payload reference only, must not modify header | 179 | * @nohdr: Payload reference only, must not modify header |
179 | * @pkt_type: Packet class | 180 | * @pkt_type: Packet class |
diff --git a/include/net/sock.h b/include/net/sock.h index 5bc180adfb14..cc4c9190b7fd 100644 --- a/include/net/sock.h +++ b/include/net/sock.h | |||
@@ -161,6 +161,7 @@ struct sock_common { | |||
161 | * @sk_sndmsg_page: cached page for sendmsg | 161 | * @sk_sndmsg_page: cached page for sendmsg |
162 | * @sk_sndmsg_off: cached offset for sendmsg | 162 | * @sk_sndmsg_off: cached offset for sendmsg |
163 | * @sk_send_head: front of stuff to transmit | 163 | * @sk_send_head: front of stuff to transmit |
164 | * @sk_security: used by security modules | ||
164 | * @sk_write_pending: a write to stream socket waits to start | 165 | * @sk_write_pending: a write to stream socket waits to start |
165 | * @sk_state_change: callback to indicate change in the state of the sock | 166 | * @sk_state_change: callback to indicate change in the state of the sock |
166 | * @sk_data_ready: callback to indicate there is data to be processed | 167 | * @sk_data_ready: callback to indicate there is data to be processed |
diff --git a/kernel/sched.c b/kernel/sched.c index 5dadcc6df7dd..0dc3158667a2 100644 --- a/kernel/sched.c +++ b/kernel/sched.c | |||
@@ -2906,6 +2906,7 @@ static void __wake_up_common(wait_queue_head_t *q, unsigned int mode, | |||
2906 | * @q: the waitqueue | 2906 | * @q: the waitqueue |
2907 | * @mode: which threads | 2907 | * @mode: which threads |
2908 | * @nr_exclusive: how many wake-one or wake-many threads to wake up | 2908 | * @nr_exclusive: how many wake-one or wake-many threads to wake up |
2909 | * @key: is directly passed to the wakeup function | ||
2909 | */ | 2910 | */ |
2910 | void fastcall __wake_up(wait_queue_head_t *q, unsigned int mode, | 2911 | void fastcall __wake_up(wait_queue_head_t *q, unsigned int mode, |
2911 | int nr_exclusive, void *key) | 2912 | int nr_exclusive, void *key) |
@@ -2928,7 +2929,7 @@ void fastcall __wake_up_locked(wait_queue_head_t *q, unsigned int mode) | |||
2928 | } | 2929 | } |
2929 | 2930 | ||
2930 | /** | 2931 | /** |
2931 | * __wake_up - sync- wake up threads blocked on a waitqueue. | 2932 | * __wake_up_sync - wake up threads blocked on a waitqueue. |
2932 | * @q: the waitqueue | 2933 | * @q: the waitqueue |
2933 | * @mode: which threads | 2934 | * @mode: which threads |
2934 | * @nr_exclusive: how many wake-one or wake-many threads to wake up | 2935 | * @nr_exclusive: how many wake-one or wake-many threads to wake up |
diff --git a/kernel/sysctl.c b/kernel/sysctl.c index 79dbd93bd697..701d12c63068 100644 --- a/kernel/sysctl.c +++ b/kernel/sysctl.c | |||
@@ -1991,6 +1991,8 @@ int proc_dointvec_userhz_jiffies(ctl_table *table, int write, struct file *filp, | |||
1991 | * @filp: the file structure | 1991 | * @filp: the file structure |
1992 | * @buffer: the user buffer | 1992 | * @buffer: the user buffer |
1993 | * @lenp: the size of the user buffer | 1993 | * @lenp: the size of the user buffer |
1994 | * @ppos: file position | ||
1995 | * @ppos: the current position in the file | ||
1994 | * | 1996 | * |
1995 | * Reads/writes up to table->maxlen/sizeof(unsigned int) integer | 1997 | * Reads/writes up to table->maxlen/sizeof(unsigned int) integer |
1996 | * values from/to the user buffer, treated as an ASCII string. | 1998 | * values from/to the user buffer, treated as an ASCII string. |
diff --git a/lib/kobject.c b/lib/kobject.c index 5df8441c44e7..94048826624c 100644 --- a/lib/kobject.c +++ b/lib/kobject.c | |||
@@ -216,13 +216,12 @@ int kobject_register(struct kobject * kobj) | |||
216 | /** | 216 | /** |
217 | * kobject_set_name - Set the name of an object | 217 | * kobject_set_name - Set the name of an object |
218 | * @kobj: object. | 218 | * @kobj: object. |
219 | * @name: name. | 219 | * @fmt: format string used to build the name |
220 | * | 220 | * |
221 | * If strlen(name) >= KOBJ_NAME_LEN, then use a dynamically allocated | 221 | * If strlen(name) >= KOBJ_NAME_LEN, then use a dynamically allocated |
222 | * string that @kobj->k_name points to. Otherwise, use the static | 222 | * string that @kobj->k_name points to. Otherwise, use the static |
223 | * @kobj->name array. | 223 | * @kobj->name array. |
224 | */ | 224 | */ |
225 | |||
226 | int kobject_set_name(struct kobject * kobj, const char * fmt, ...) | 225 | int kobject_set_name(struct kobject * kobj, const char * fmt, ...) |
227 | { | 226 | { |
228 | int error = 0; | 227 | int error = 0; |
diff --git a/mm/filemap.c b/mm/filemap.c index c085af2332d8..d5fdae2eb183 100644 --- a/mm/filemap.c +++ b/mm/filemap.c | |||
@@ -169,9 +169,10 @@ static int sync_page(void *word) | |||
169 | /** | 169 | /** |
170 | * filemap_fdatawrite_range - start writeback against all of a mapping's | 170 | * filemap_fdatawrite_range - start writeback against all of a mapping's |
171 | * dirty pages that lie within the byte offsets <start, end> | 171 | * dirty pages that lie within the byte offsets <start, end> |
172 | * @mapping: address space structure to write | 172 | * @mapping: address space structure to write |
173 | * @start: offset in bytes where the range starts | 173 | * @start: offset in bytes where the range starts |
174 | * @end : offset in bytes where the range ends | 174 | * @end: offset in bytes where the range ends |
175 | * @sync_mode: enable synchronous operation | ||
175 | * | 176 | * |
176 | * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as | 177 | * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as |
177 | * opposed to a regular memory * cleansing writeback. The difference between | 178 | * opposed to a regular memory * cleansing writeback. The difference between |
@@ -535,8 +536,8 @@ EXPORT_SYMBOL(find_trylock_page); | |||
535 | /** | 536 | /** |
536 | * find_lock_page - locate, pin and lock a pagecache page | 537 | * find_lock_page - locate, pin and lock a pagecache page |
537 | * | 538 | * |
538 | * @mapping - the address_space to search | 539 | * @mapping: the address_space to search |
539 | * @offset - the page index | 540 | * @offset: the page index |
540 | * | 541 | * |
541 | * Locates the desired pagecache page, locks it, increments its reference | 542 | * Locates the desired pagecache page, locks it, increments its reference |
542 | * count and returns its address. | 543 | * count and returns its address. |
@@ -575,9 +576,9 @@ EXPORT_SYMBOL(find_lock_page); | |||
575 | /** | 576 | /** |
576 | * find_or_create_page - locate or add a pagecache page | 577 | * find_or_create_page - locate or add a pagecache page |
577 | * | 578 | * |
578 | * @mapping - the page's address_space | 579 | * @mapping: the page's address_space |
579 | * @index - the page's index into the mapping | 580 | * @index: the page's index into the mapping |
580 | * @gfp_mask - page allocation mode | 581 | * @gfp_mask: page allocation mode |
581 | * | 582 | * |
582 | * Locates a page in the pagecache. If the page is not present, a new page | 583 | * Locates a page in the pagecache. If the page is not present, a new page |
583 | * is allocated using @gfp_mask and is added to the pagecache and to the VM's | 584 | * is allocated using @gfp_mask and is added to the pagecache and to the VM's |
diff --git a/mm/page-writeback.c b/mm/page-writeback.c index 6ddd6a29c73b..613b99a55917 100644 --- a/mm/page-writeback.c +++ b/mm/page-writeback.c | |||
@@ -255,7 +255,7 @@ static void balance_dirty_pages(struct address_space *mapping) | |||
255 | 255 | ||
256 | /** | 256 | /** |
257 | * balance_dirty_pages_ratelimited - balance dirty memory state | 257 | * balance_dirty_pages_ratelimited - balance dirty memory state |
258 | * @mapping - address_space which was dirtied | 258 | * @mapping: address_space which was dirtied |
259 | * | 259 | * |
260 | * Processes which are dirtying memory should call in here once for each page | 260 | * Processes which are dirtying memory should call in here once for each page |
261 | * which was newly dirtied. The function will periodically check the system's | 261 | * which was newly dirtied. The function will periodically check the system's |
@@ -562,8 +562,8 @@ int do_writepages(struct address_space *mapping, struct writeback_control *wbc) | |||
562 | /** | 562 | /** |
563 | * write_one_page - write out a single page and optionally wait on I/O | 563 | * write_one_page - write out a single page and optionally wait on I/O |
564 | * | 564 | * |
565 | * @page - the page to write | 565 | * @page: the page to write |
566 | * @wait - if true, wait on writeout | 566 | * @wait: if true, wait on writeout |
567 | * | 567 | * |
568 | * The page must be locked by the caller and will be unlocked upon return. | 568 | * The page must be locked by the caller and will be unlocked upon return. |
569 | * | 569 | * |
diff --git a/mm/truncate.c b/mm/truncate.c index c9a63f0b69a2..60c8764bfac2 100644 --- a/mm/truncate.c +++ b/mm/truncate.c | |||
@@ -242,7 +242,7 @@ EXPORT_SYMBOL(invalidate_inode_pages); | |||
242 | 242 | ||
243 | /** | 243 | /** |
244 | * invalidate_inode_pages2_range - remove range of pages from an address_space | 244 | * invalidate_inode_pages2_range - remove range of pages from an address_space |
245 | * @mapping - the address_space | 245 | * @mapping: the address_space |
246 | * @start: the page offset 'from' which to invalidate | 246 | * @start: the page offset 'from' which to invalidate |
247 | * @end: the page offset 'to' which to invalidate (inclusive) | 247 | * @end: the page offset 'to' which to invalidate (inclusive) |
248 | * | 248 | * |
@@ -322,7 +322,7 @@ EXPORT_SYMBOL_GPL(invalidate_inode_pages2_range); | |||
322 | 322 | ||
323 | /** | 323 | /** |
324 | * invalidate_inode_pages2 - remove all pages from an address_space | 324 | * invalidate_inode_pages2 - remove all pages from an address_space |
325 | * @mapping - the address_space | 325 | * @mapping: the address_space |
326 | * | 326 | * |
327 | * Any pages which are found to be mapped into pagetables are unmapped prior to | 327 | * Any pages which are found to be mapped into pagetables are unmapped prior to |
328 | * invalidation. | 328 | * invalidation. |
diff --git a/net/core/datagram.c b/net/core/datagram.c index 27c5cd942820..fcee054b6f75 100644 --- a/net/core/datagram.c +++ b/net/core/datagram.c | |||
@@ -203,7 +203,7 @@ void skb_free_datagram(struct sock *sk, struct sk_buff *skb) | |||
203 | * skb_copy_datagram_iovec - Copy a datagram to an iovec. | 203 | * skb_copy_datagram_iovec - Copy a datagram to an iovec. |
204 | * @skb: buffer to copy | 204 | * @skb: buffer to copy |
205 | * @offset: offset in the buffer to start copying from | 205 | * @offset: offset in the buffer to start copying from |
206 | * @iovec: io vector to copy to | 206 | * @to: io vector to copy to |
207 | * @len: amount of data to copy from buffer to iovec | 207 | * @len: amount of data to copy from buffer to iovec |
208 | * | 208 | * |
209 | * Note: the iovec is modified during the copy. | 209 | * Note: the iovec is modified during the copy. |
@@ -379,7 +379,7 @@ fault: | |||
379 | * skb_copy_and_csum_datagram_iovec - Copy and checkum skb to user iovec. | 379 | * skb_copy_and_csum_datagram_iovec - Copy and checkum skb to user iovec. |
380 | * @skb: skbuff | 380 | * @skb: skbuff |
381 | * @hlen: hardware length | 381 | * @hlen: hardware length |
382 | * @iovec: io vector | 382 | * @iov: io vector |
383 | * | 383 | * |
384 | * Caller _must_ check that skb will fit to this iovec. | 384 | * Caller _must_ check that skb will fit to this iovec. |
385 | * | 385 | * |