Fix kerneldoc comments in mm/vmalloc.c
Subsystems (2)
PATCH 1/1 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.
---
commit 8322f0cb8a117fe42e993d48f5ae0fbc006f8ef0
tree 22ddb2aa90e3a1392abcdc99fa675995a347c068
parent da27ef8999723a92f4ac778d4196acc9383197eb
author Rolf Eike Beer <[email protected]> Tue, 26 Sep 2006 11:35:42 +0200 committer Rolf Eike Beer <[email protected]> Tue, 26 Sep 2006 11:35:42 +0200
mm/vmalloc.c | 28 ++++++++-------------------- 1 files changed, 8 insertions(+), 20 deletions(-)
mm/vmalloc.c +8 -20
@@ -238,7 +238,6 @@ struct vm_struct *__get_vm_area(unsigned/** * get_vm_area - reserve a contingous kernel virtual area -* * @size: size of the area * @flags: %VM_IOREMAP for I/O mappings or VM_ALLOC *
@@ -293,7 +292,6 @@ found:/** * remove_vm_area - find and remove a contingous kernel virtual area -* * @addr: base address * * Search for the kernel VM area starting at @addr, and remove it.
@@ -352,7 +350,6 @@ void __vunmap(void *addr, int deallocate/** * vfree - release memory allocated by vmalloc() -* * @addr: memory base address * * Free the virtually contiguous memory area starting at @addr, as
@@ -370,7 +367,6 @@ EXPORT_SYMBOL(vfree);/** * vunmap - release virtual mapping obtained by vmap() -* * @addr: memory base address * * Free the virtually contiguous memory area starting at @addr,
@@ -387,7 +383,6 @@ EXPORT_SYMBOL(vunmap);/** * vmap - map an array of pages into virtually contiguous space -* * @pages: array of page pointers * @count: number of pages to map * @flags: vm_area->flags
@@ -468,7 +463,6 @@ void *__vmalloc_area(struct vm_struct *a/** * __vmalloc_node - allocate virtually contiguous memory -* * @size: allocation size * @gfp_mask: flags for the page level allocator * @prot: protection mask for the allocated pages
@@ -503,9 +497,7 @@ EXPORT_SYMBOL(__vmalloc);/** * vmalloc - allocate virtually contiguous memory -* * @size: allocation size -* * Allocate enough pages to cover @size from the page level * allocator and map them into contiguous kernel virtual space. *
@@ -519,11 +511,11 @@ void *vmalloc(unsigned long size)EXPORT_SYMBOL (vmalloc);/** -* vmalloc_user - allocate virtually contiguous memory which has -* been zeroed so it can be mapped to userspace without -* leaking data. +* vmalloc_user - allocate zeroed virtually contiguous memory for userspace +* @size: allocation size * -* @size: allocation size +* The resulting memory area is zeroed so it can be mapped to userspace +* without leaking data. */ void *vmalloc_user (unsigned long size) {
@@ -542,7 +534,6 @@ EXPORT_SYMBOL(vmalloc_user);/** * vmalloc_node - allocate memory on a specific node -* * @size: allocation size * @node: numa node *
@@ -564,7 +555,6 @@ #endif/** * vmalloc_exec - allocate virtually contiguous, executable memory -* * @size: allocation size * * Kernel-internal function to allocate enough pages to cover @size
@@ -582,7 +572,6 @@ void *vmalloc_exec(unsigned long size)/** * vmalloc_32 - allocate virtually contiguous memory (32bit addressable) -* * @size: allocation size * * Allocate enough 32bit PA addressable pages to cover @size from the
@@ -595,11 +584,11 @@ void *vmalloc_32(unsigned long size)EXPORT_SYMBOL (vmalloc_32);/** -* vmalloc_32_user - allocate virtually contiguous memory (32bit -* addressable) which is zeroed so it can be -* mapped to userspace without leaking data. -* +* vmalloc_32_user - allocate zeroed virtually contiguous 32bit memory * @size: allocation size +* +* The resulting memory area is 32bit addressable and zeroed so it can be +* mapped to userspace without leaking data. */ void *vmalloc_32_user (unsigned long size) {
@@ -693,7 +682,6 @@ finished:/** * remap_vmalloc_range - map vmalloc pages to userspace -* * @vma: vma to cover (map full range of vma) * @addr: vmalloc memory * @pgoff: number of pages into addr before first page to map
Quoted 6 lines · On Tue, 26 Sep 2006 11:37:55 +0200 Rolf Eike Beer wrote:
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 <[email protected]>
Quoted 130 lines
---
commit8322f0cb8a117fe42e993d48f5ae0fbc006f8ef0
tree22ddb2aa90e3a1392abcdc99fa675995a347c068
parentda27ef8999723a92f4ac778d4196acc9383197eb
author Rolf Eike Beer <[email protected]> Tue, 26 Sep 2006 11:35:42 +0200 committer Rolf Eike Beer <[email protected]> Tue, 26 Sep 2006 11:35:42 +0200mm/vmalloc.c | 28 ++++++++-------------------- 1 files changed, 8 insertions(+), 20 deletions(-)mm/vmalloc.c +8
-19@@ -238,7 +238,6 @@ struct vm_struct *__get_vm_area(unsigned/** * get_vm_area - reserve a contingous kernel virtual area -* * @size: size of the area * @flags: %VM_IOREMAP for I/O mappings or VM_ALLOC * @@ -293,7 +292,6 @@ found:/** * remove_vm_area - find and remove a contingous kernel virtual area -* * @addr: base address * * Search for the kernel VM area starting at @addr, and remove it. @@ -352,7 +350,6 @@ void __vunmap(void *addr, int deallocate/** * vfree - release memory allocated by vmalloc() -* * @addr: memory base address * * Free the virtually contiguous memory area starting at @addr, as @@ -370,7 +367,6 @@ EXPORT_SYMBOL(vfree);/** * vunmap - release virtual mapping obtained by vmap() -* * @addr: memory base address * * Free the virtually contiguous memory area starting at @addr, @@ -387,7 +383,6 @@ EXPORT_SYMBOL(vunmap);/** * vmap - map an array of pages into virtually contiguous space -* * @pages: array of page pointers * @count: number of pages to map * @flags: vm_area->flags @@ -468,7 +463,6 @@ void *__vmalloc_area(struct vm_struct *a/** * __vmalloc_node - allocate virtually contiguous memory -* * @size: allocation size * @gfp_mask: flags for the page level allocator * @prot: protection mask for the allocated pages @@ -503,9 +497,7 @@ EXPORT_SYMBOL(__vmalloc);/** * vmalloc - allocate virtually contiguous memory -* * @size: allocation size -* * Allocate enough pages to cover @size from the page level * allocator and map them into contiguous kernel virtual space. * @@ -519,11 +511,11 @@ void *vmalloc(unsigned long size)EXPORT_SYMBOL (vmalloc);/** -* vmalloc_user - allocate virtually contiguous memory which has -* been zeroed so it can be mapped to userspace without -* leaking data. +* vmalloc_user - allocate zeroed virtually contiguous memory for userspace +* @size: allocation size * -* @size: allocation size +* The resulting memory area is zeroed so it can be mapped to userspace +* without leaking data. */ void *vmalloc_user (unsigned long size) {@@ -542,7 +534,6 @@ EXPORT_SYMBOL(vmalloc_user);/** * vmalloc_node - allocate memory on a specific node -* * @size: allocation size * @node: numa node * @@ -564,7 +555,6 @@ #endif/** * vmalloc_exec - allocate virtually contiguous, executable memory -* * @size: allocation size * * Kernel-internal function to allocate enough pages to cover @size @@ -582,7 +572,6 @@ void *vmalloc_exec(unsigned long size)/** * vmalloc_32 - allocate virtually contiguous memory (32bit addressable) -* * @size: allocation size * * Allocate enough 32bit PA addressable pages to cover @size from the @@ -595,11 +584,11 @@ void *vmalloc_32(unsigned long size)EXPORT_SYMBOL (vmalloc_32);/** -* vmalloc_32_user - allocate virtually contiguous memory (32bit -* addressable) which is zeroed so it can be -* mapped to userspace without leaking data. -* +* vmalloc_32_user - allocate zeroed virtually contiguous 32bit memory * @size: allocation size +* +* The resulting memory area is 32bit addressable and zeroed so it can be +* mapped to userspace without leaking data. */ void *vmalloc_32_user (unsigned long size) {
mm/vmalloc.c finished: · line 687
Quoted 7 lines
mm/vmalloc.c +0
-1@@ -693,7 +682,6 @@ finished:/** * remap_vmalloc_range - map vmalloc pages to userspace -* * @vma: vma to cover (map full range of vma) * @addr: vmalloc memory * @pgoff: number of pages into addr before first page to map
---
~Randy