Commit ead04089b138ed669658f80fafbe11fc7d97740b
Committed by
Linus Torvalds
1 parent
423b41d773
Exists in
master
and in
20 other branches
[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>
Showing 1 changed file with 8 additions and 20 deletions Side-by-side Diff
mm/vmalloc.c
... | ... | @@ -241,7 +241,6 @@ |
241 | 241 | |
242 | 242 | /** |
243 | 243 | * get_vm_area - reserve a contingous kernel virtual area |
244 | - * | |
245 | 244 | * @size: size of the area |
246 | 245 | * @flags: %VM_IOREMAP for I/O mappings or VM_ALLOC |
247 | 246 | * |
... | ... | @@ -296,7 +295,6 @@ |
296 | 295 | |
297 | 296 | /** |
298 | 297 | * remove_vm_area - find and remove a contingous kernel virtual area |
299 | - * | |
300 | 298 | * @addr: base address |
301 | 299 | * |
302 | 300 | * Search for the kernel VM area starting at @addr, and remove it. |
... | ... | @@ -355,7 +353,6 @@ |
355 | 353 | |
356 | 354 | /** |
357 | 355 | * vfree - release memory allocated by vmalloc() |
358 | - * | |
359 | 356 | * @addr: memory base address |
360 | 357 | * |
361 | 358 | * Free the virtually contiguous memory area starting at @addr, as |
... | ... | @@ -373,7 +370,6 @@ |
373 | 370 | |
374 | 371 | /** |
375 | 372 | * vunmap - release virtual mapping obtained by vmap() |
376 | - * | |
377 | 373 | * @addr: memory base address |
378 | 374 | * |
379 | 375 | * Free the virtually contiguous memory area starting at @addr, |
... | ... | @@ -390,7 +386,6 @@ |
390 | 386 | |
391 | 387 | /** |
392 | 388 | * vmap - map an array of pages into virtually contiguous space |
393 | - * | |
394 | 389 | * @pages: array of page pointers |
395 | 390 | * @count: number of pages to map |
396 | 391 | * @flags: vm_area->flags |
... | ... | @@ -471,7 +466,6 @@ |
471 | 466 | |
472 | 467 | /** |
473 | 468 | * __vmalloc_node - allocate virtually contiguous memory |
474 | - * | |
475 | 469 | * @size: allocation size |
476 | 470 | * @gfp_mask: flags for the page level allocator |
477 | 471 | * @prot: protection mask for the allocated pages |
478 | 472 | |
... | ... | @@ -505,9 +499,7 @@ |
505 | 499 | |
506 | 500 | /** |
507 | 501 | * vmalloc - allocate virtually contiguous memory |
508 | - * | |
509 | 502 | * @size: allocation size |
510 | - * | |
511 | 503 | * Allocate enough pages to cover @size from the page level |
512 | 504 | * allocator and map them into contiguous kernel virtual space. |
513 | 505 | * |
514 | 506 | |
... | ... | @@ -521,11 +513,11 @@ |
521 | 513 | EXPORT_SYMBOL(vmalloc); |
522 | 514 | |
523 | 515 | /** |
524 | - * vmalloc_user - allocate virtually contiguous memory which has | |
525 | - * been zeroed so it can be mapped to userspace without | |
526 | - * leaking data. | |
516 | + * vmalloc_user - allocate zeroed virtually contiguous memory for userspace | |
517 | + * @size: allocation size | |
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 | 522 | void *vmalloc_user(unsigned long size) |
531 | 523 | { |
... | ... | @@ -544,7 +536,6 @@ |
544 | 536 | |
545 | 537 | /** |
546 | 538 | * vmalloc_node - allocate memory on a specific node |
547 | - * | |
548 | 539 | * @size: allocation size |
549 | 540 | * @node: numa node |
550 | 541 | * |
... | ... | @@ -566,7 +557,6 @@ |
566 | 557 | |
567 | 558 | /** |
568 | 559 | * vmalloc_exec - allocate virtually contiguous, executable memory |
569 | - * | |
570 | 560 | * @size: allocation size |
571 | 561 | * |
572 | 562 | * Kernel-internal function to allocate enough pages to cover @size |
... | ... | @@ -584,7 +574,6 @@ |
584 | 574 | |
585 | 575 | /** |
586 | 576 | * vmalloc_32 - allocate virtually contiguous memory (32bit addressable) |
587 | - * | |
588 | 577 | * @size: allocation size |
589 | 578 | * |
590 | 579 | * Allocate enough 32bit PA addressable pages to cover @size from the |
591 | 580 | |
... | ... | @@ -597,11 +586,11 @@ |
597 | 586 | EXPORT_SYMBOL(vmalloc_32); |
598 | 587 | |
599 | 588 | /** |
600 | - * vmalloc_32_user - allocate virtually contiguous memory (32bit | |
601 | - * addressable) which is zeroed so it can be | |
602 | - * mapped to userspace without leaking data. | |
603 | - * | |
589 | + * vmalloc_32_user - allocate zeroed virtually contiguous 32bit memory | |
604 | 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 | 595 | void *vmalloc_32_user(unsigned long size) |
607 | 596 | { |
... | ... | @@ -695,7 +684,6 @@ |
695 | 684 | |
696 | 685 | /** |
697 | 686 | * remap_vmalloc_range - map vmalloc pages to userspace |
698 | - * | |
699 | 687 | * @vma: vma to cover (map full range of vma) |
700 | 688 | * @addr: vmalloc memory |
701 | 689 | * @pgoff: number of pages into addr before first page to map |