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 /mm | |
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>
Diffstat (limited to 'mm')
-rw-r--r-- | mm/filemap.c | 17 | ||||
-rw-r--r-- | mm/page-writeback.c | 6 | ||||
-rw-r--r-- | mm/truncate.c | 4 |
3 files changed, 14 insertions, 13 deletions
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. |