Commit 8108ad51 authored by Mike Rapoport's avatar Mike Rapoport Committed by Jonathan Corbet
Browse files

docs/mm: nobootmem: fixup kernel-doc comments 



* add kernel-doc marking to free_bootmem_late() description
* add return value descriptions
* mention that address parameter of free_bootmem{_node} is a physical address

Signed-off-by: default avatarMike Rapoport <rppt@linux.vnet.ibm.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 04c45060

mm/nobootmem.c

+13 −5
Original line number Diff line number Diff line
@@ -72,7 +72,7 @@ static void * __init __alloc_memory_core_early(int nid, u64 size, u64 align, 
	return ptr;

}



/*

/**

 * free_bootmem_late - free bootmem pages directly to page allocator

 * @addr: starting address of the range

 * @size: size of the range in bytes
@@ -176,7 +176,7 @@ void __init reset_all_zones_managed_pages(void) 
/**

 * free_all_bootmem - release free pages to the buddy allocator

 *

 * Returns the number of pages actually released.

 * Return: the number of pages actually released.

 */

unsigned long __init free_all_bootmem(void)

{
@@ -193,7 +193,7 @@ unsigned long __init free_all_bootmem(void) 
/**

 * free_bootmem_node - mark a page range as usable

 * @pgdat: node the range resides on

 * @physaddr: starting address of the range

 * @physaddr: starting physical address of the range

 * @size: size of the range in bytes

 *

 * Partial pages will be considered reserved and left as they are.
@@ -208,7 +208,7 @@ void __init free_bootmem_node(pg_data_t *pgdat, unsigned long physaddr, 


/**

 * free_bootmem - mark a page range as usable

 * @addr: starting address of the range

 * @addr: starting physical address of the range

 * @size: size of the range in bytes

 *

 * Partial pages will be considered reserved and left as they are.
@@ -256,7 +256,7 @@ static void * __init ___alloc_bootmem_nopanic(unsigned long size, 
 *

 * Allocation may happen on any node in the system.

 *

 * Returns NULL on failure.

 * Return: address of the allocated region or %NULL on failure.

 */

void * __init __alloc_bootmem_nopanic(unsigned long size, unsigned long align,

					unsigned long goal)
@@ -293,6 +293,8 @@ static void * __init ___alloc_bootmem(unsigned long size, unsigned long align, 
 * Allocation may happen on any node in the system.

 *

 * The function panics if the request can not be satisfied.

 *

 * Return: address of the allocated region.

 */

void * __init __alloc_bootmem(unsigned long size, unsigned long align,

			      unsigned long goal)
@@ -367,6 +369,8 @@ static void * __init ___alloc_bootmem_node(pg_data_t *pgdat, unsigned long size, 
 * can not hold the requested memory.

 *

 * The function panics if the request can not be satisfied.

 *

 * Return: address of the allocated region.

 */

void * __init __alloc_bootmem_node(pg_data_t *pgdat, unsigned long size,

				   unsigned long align, unsigned long goal)
@@ -396,6 +400,8 @@ void * __init __alloc_bootmem_node_high(pg_data_t *pgdat, unsigned long size, 
 * Allocation may happen on any node in the system.

 *

 * The function panics if the request can not be satisfied.

 *

 * Return: address of the allocated region.

 */

void * __init __alloc_bootmem_low(unsigned long size, unsigned long align,

				  unsigned long goal)
@@ -425,6 +431,8 @@ void * __init __alloc_bootmem_low_nopanic(unsigned long size, 
 * can not hold the requested memory.

 *

 * The function panics if the request can not be satisfied.

 *

 * Return: address of the allocated region.

 */

void * __init __alloc_bootmem_low_node(pg_data_t *pgdat, unsigned long size,

				       unsigned long align, unsigned long goal)