Skip to content

Commit

Permalink
[PATCH] Fix kerneldoc comments in mm/vmalloc.c
Browse files Browse the repository at this point in the history
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]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>
  • Loading branch information
DerDakon authored and Linus Torvalds committed Sep 27, 2006
1 parent 423b41d commit ead0408
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions mm/vmalloc.c
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,6 @@ struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags,

/**
* get_vm_area - reserve a contingous kernel virtual area
*
* @size: size of the area
* @flags: %VM_IOREMAP for I/O mappings or VM_ALLOC
*
Expand Down Expand Up @@ -296,7 +295,6 @@ struct vm_struct *__remove_vm_area(void *addr)

/**
* 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.
Expand Down Expand Up @@ -355,7 +353,6 @@ void __vunmap(void *addr, int deallocate_pages)

/**
* vfree - release memory allocated by vmalloc()
*
* @addr: memory base address
*
* Free the virtually contiguous memory area starting at @addr, as
Expand All @@ -373,7 +370,6 @@ EXPORT_SYMBOL(vfree);

/**
* vunmap - release virtual mapping obtained by vmap()
*
* @addr: memory base address
*
* Free the virtually contiguous memory area starting at @addr,
Expand All @@ -390,7 +386,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
Expand Down Expand Up @@ -471,7 +466,6 @@ void *__vmalloc_area(struct vm_struct *area, gfp_t gfp_mask, pgprot_t prot)

/**
* __vmalloc_node - allocate virtually contiguous memory
*
* @size: allocation size
* @gfp_mask: flags for the page level allocator
* @prot: protection mask for the allocated pages
Expand Down Expand Up @@ -505,9 +499,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.
*
Expand All @@ -521,11 +513,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)
{
Expand All @@ -544,7 +536,6 @@ EXPORT_SYMBOL(vmalloc_user);

/**
* vmalloc_node - allocate memory on a specific node
*
* @size: allocation size
* @node: numa node
*
Expand All @@ -566,7 +557,6 @@ EXPORT_SYMBOL(vmalloc_node);

/**
* vmalloc_exec - allocate virtually contiguous, executable memory
*
* @size: allocation size
*
* Kernel-internal function to allocate enough pages to cover @size
Expand All @@ -584,7 +574,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
Expand All @@ -597,11 +586,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)
{
Expand Down Expand Up @@ -695,7 +684,6 @@ long vwrite(char *buf, char *addr, unsigned long count)

/**
* 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
Expand Down

0 comments on commit ead0408

Please sign in to comment.