diff options
author | Rolf Eike Beer <eike-kernel@sf-tec.de> | 2006-09-27 04:50:13 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-09-27 11:26:13 -0400 |
commit | ead04089b138ed669658f80fafbe11fc7d97740b (patch) | |
tree | 35c623c292d569e9d8f99559836075ab8ec9be13 | |
parent | 423b41d773abe443bb546ce91361192073b96f88 (diff) |
[PATCH] Fix kerneldoc comments in mm/vmalloc.c
The empty line between the short description and the first argument
description causes a section to appear twice in the generated manpage.
Also the short description should really be short: the script can't handle
multiple lines.
Signed-off-by: Rolf Eike Beer <eike-kernel@sf-tec.de>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
-rw-r--r-- | mm/vmalloc.c | 28 |
1 files changed, 8 insertions, 20 deletions
diff --git a/mm/vmalloc.c b/mm/vmalloc.c index 9aad8b0cc6ee..659ec634856a 100644 --- a/mm/vmalloc.c +++ b/mm/vmalloc.c | |||
@@ -241,7 +241,6 @@ struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags, | |||
241 | 241 | ||
242 | /** | 242 | /** |
243 | * get_vm_area - reserve a contingous kernel virtual area | 243 | * get_vm_area - reserve a contingous kernel virtual area |
244 | * | ||
245 | * @size: size of the area | 244 | * @size: size of the area |
246 | * @flags: %VM_IOREMAP for I/O mappings or VM_ALLOC | 245 | * @flags: %VM_IOREMAP for I/O mappings or VM_ALLOC |
247 | * | 246 | * |
@@ -296,7 +295,6 @@ found: | |||
296 | 295 | ||
297 | /** | 296 | /** |
298 | * remove_vm_area - find and remove a contingous kernel virtual area | 297 | * remove_vm_area - find and remove a contingous kernel virtual area |
299 | * | ||
300 | * @addr: base address | 298 | * @addr: base address |
301 | * | 299 | * |
302 | * Search for the kernel VM area starting at @addr, and remove it. | 300 | * Search for the kernel VM area starting at @addr, and remove it. |
@@ -355,7 +353,6 @@ void __vunmap(void *addr, int deallocate_pages) | |||
355 | 353 | ||
356 | /** | 354 | /** |
357 | * vfree - release memory allocated by vmalloc() | 355 | * vfree - release memory allocated by vmalloc() |
358 | * | ||
359 | * @addr: memory base address | 356 | * @addr: memory base address |
360 | * | 357 | * |
361 | * Free the virtually contiguous memory area starting at @addr, as | 358 | * Free the virtually contiguous memory area starting at @addr, as |
@@ -373,7 +370,6 @@ EXPORT_SYMBOL(vfree); | |||
373 | 370 | ||
374 | /** | 371 | /** |
375 | * vunmap - release virtual mapping obtained by vmap() | 372 | * vunmap - release virtual mapping obtained by vmap() |
376 | * | ||
377 | * @addr: memory base address | 373 | * @addr: memory base address |
378 | * | 374 | * |
379 | * Free the virtually contiguous memory area starting at @addr, | 375 | * Free the virtually contiguous memory area starting at @addr, |
@@ -390,7 +386,6 @@ EXPORT_SYMBOL(vunmap); | |||
390 | 386 | ||
391 | /** | 387 | /** |
392 | * vmap - map an array of pages into virtually contiguous space | 388 | * vmap - map an array of pages into virtually contiguous space |
393 | * | ||
394 | * @pages: array of page pointers | 389 | * @pages: array of page pointers |
395 | * @count: number of pages to map | 390 | * @count: number of pages to map |
396 | * @flags: vm_area->flags | 391 | * @flags: vm_area->flags |
@@ -471,7 +466,6 @@ void *__vmalloc_area(struct vm_struct *area, gfp_t gfp_mask, pgprot_t prot) | |||
471 | 466 | ||
472 | /** | 467 | /** |
473 | * __vmalloc_node - allocate virtually contiguous memory | 468 | * __vmalloc_node - allocate virtually contiguous memory |
474 | * | ||
475 | * @size: allocation size | 469 | * @size: allocation size |
476 | * @gfp_mask: flags for the page level allocator | 470 | * @gfp_mask: flags for the page level allocator |
477 | * @prot: protection mask for the allocated pages | 471 | * @prot: protection mask for the allocated pages |
@@ -505,9 +499,7 @@ EXPORT_SYMBOL(__vmalloc); | |||
505 | 499 | ||
506 | /** | 500 | /** |
507 | * vmalloc - allocate virtually contiguous memory | 501 | * vmalloc - allocate virtually contiguous memory |
508 | * | ||
509 | * @size: allocation size | 502 | * @size: allocation size |
510 | * | ||
511 | * Allocate enough pages to cover @size from the page level | 503 | * Allocate enough pages to cover @size from the page level |
512 | * allocator and map them into contiguous kernel virtual space. | 504 | * allocator and map them into contiguous kernel virtual space. |
513 | * | 505 | * |
@@ -521,11 +513,11 @@ void *vmalloc(unsigned long size) | |||
521 | EXPORT_SYMBOL(vmalloc); | 513 | EXPORT_SYMBOL(vmalloc); |
522 | 514 | ||
523 | /** | 515 | /** |
524 | * vmalloc_user - allocate virtually contiguous memory which has | 516 | * vmalloc_user - allocate zeroed virtually contiguous memory for userspace |
525 | * been zeroed so it can be mapped to userspace without | 517 | * @size: allocation size |
526 | * leaking data. | ||
527 | * | 518 | * |
528 | * @size: allocation size | 519 | * The resulting memory area is zeroed so it can be mapped to userspace |
520 | * without leaking data. | ||
529 | */ | 521 | */ |
530 | void *vmalloc_user(unsigned long size) | 522 | void *vmalloc_user(unsigned long size) |
531 | { | 523 | { |
@@ -544,7 +536,6 @@ EXPORT_SYMBOL(vmalloc_user); | |||
544 | 536 | ||
545 | /** | 537 | /** |
546 | * vmalloc_node - allocate memory on a specific node | 538 | * vmalloc_node - allocate memory on a specific node |
547 | * | ||
548 | * @size: allocation size | 539 | * @size: allocation size |
549 | * @node: numa node | 540 | * @node: numa node |
550 | * | 541 | * |
@@ -566,7 +557,6 @@ EXPORT_SYMBOL(vmalloc_node); | |||
566 | 557 | ||
567 | /** | 558 | /** |
568 | * vmalloc_exec - allocate virtually contiguous, executable memory | 559 | * vmalloc_exec - allocate virtually contiguous, executable memory |
569 | * | ||
570 | * @size: allocation size | 560 | * @size: allocation size |
571 | * | 561 | * |
572 | * Kernel-internal function to allocate enough pages to cover @size | 562 | * Kernel-internal function to allocate enough pages to cover @size |
@@ -584,7 +574,6 @@ void *vmalloc_exec(unsigned long size) | |||
584 | 574 | ||
585 | /** | 575 | /** |
586 | * vmalloc_32 - allocate virtually contiguous memory (32bit addressable) | 576 | * vmalloc_32 - allocate virtually contiguous memory (32bit addressable) |
587 | * | ||
588 | * @size: allocation size | 577 | * @size: allocation size |
589 | * | 578 | * |
590 | * Allocate enough 32bit PA addressable pages to cover @size from the | 579 | * Allocate enough 32bit PA addressable pages to cover @size from the |
@@ -597,11 +586,11 @@ void *vmalloc_32(unsigned long size) | |||
597 | EXPORT_SYMBOL(vmalloc_32); | 586 | EXPORT_SYMBOL(vmalloc_32); |
598 | 587 | ||
599 | /** | 588 | /** |
600 | * vmalloc_32_user - allocate virtually contiguous memory (32bit | 589 | * vmalloc_32_user - allocate zeroed virtually contiguous 32bit memory |
601 | * addressable) which is zeroed so it can be | ||
602 | * mapped to userspace without leaking data. | ||
603 | * | ||
604 | * @size: allocation size | 590 | * @size: allocation size |
591 | * | ||
592 | * The resulting memory area is 32bit addressable and zeroed so it can be | ||
593 | * mapped to userspace without leaking data. | ||
605 | */ | 594 | */ |
606 | void *vmalloc_32_user(unsigned long size) | 595 | void *vmalloc_32_user(unsigned long size) |
607 | { | 596 | { |
@@ -695,7 +684,6 @@ finished: | |||
695 | 684 | ||
696 | /** | 685 | /** |
697 | * remap_vmalloc_range - map vmalloc pages to userspace | 686 | * remap_vmalloc_range - map vmalloc pages to userspace |
698 | * | ||
699 | * @vma: vma to cover (map full range of vma) | 687 | * @vma: vma to cover (map full range of vma) |
700 | * @addr: vmalloc memory | 688 | * @addr: vmalloc memory |
701 | * @pgoff: number of pages into addr before first page to map | 689 | * @pgoff: number of pages into addr before first page to map |