From: Mike Rapoport <rppt@linux.vnet.ibm.com> To: Jonathan Corbet <corbet@lwn.net> Cc: Randy Dunlap <rdunlap@infradead.org>, linux-doc <linux-doc@vger.kernel.org>, linux-mm <linux-mm@kvack.org>, lkml <linux-kernel@vger.kernel.org>, Mike Rapoport <rppt@linux.vnet.ibm.com> Subject: [PATCH v2 02/11] docs/mm: nobootmem: fixup kernel-doc comments Date: Sat, 30 Jun 2018 17:54:57 +0300 [thread overview] Message-ID: <1530370506-21751-3-git-send-email-rppt@linux.vnet.ibm.com> (raw) In-Reply-To: <1530370506-21751-1-git-send-email-rppt@linux.vnet.ibm.com> * 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: Mike Rapoport <rppt@linux.vnet.ibm.com> --- mm/nobootmem.c | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/mm/nobootmem.c b/mm/nobootmem.c index 9b02fda..c2cfa04 100644 --- a/mm/nobootmem.c +++ b/mm/nobootmem.c @@ -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) -- 2.7.4
WARNING: multiple messages have this Message-ID (diff)
From: Mike Rapoport <rppt@linux.vnet.ibm.com> To: Jonathan Corbet <corbet@lwn.net> Cc: Randy Dunlap <rdunlap@infradead.org>, linux-doc <linux-doc@vger.kernel.org>, linux-mm <linux-mm@kvack.org>, lkml <linux-kernel@vger.kernel.org>, Mike Rapoport <rppt@linux.vnet.ibm.com> Subject: [PATCH v2 02/11] docs/mm: nobootmem: fixup kernel-doc comments Date: Sat, 30 Jun 2018 17:54:57 +0300 [thread overview] Message-ID: <1530370506-21751-3-git-send-email-rppt@linux.vnet.ibm.com> (raw) In-Reply-To: <1530370506-21751-1-git-send-email-rppt@linux.vnet.ibm.com> * 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: Mike Rapoport <rppt@linux.vnet.ibm.com> --- mm/nobootmem.c | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/mm/nobootmem.c b/mm/nobootmem.c index 9b02fda..c2cfa04 100644 --- a/mm/nobootmem.c +++ b/mm/nobootmem.c @@ -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) -- 2.7.4 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2018-06-30 14:55 UTC|newest] Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-06-30 14:54 [PATCH v2 00/11] docs/mm: add boot time memory management docs Mike Rapoport 2018-06-30 14:54 ` Mike Rapoport 2018-06-30 14:54 ` [PATCH v2 01/11] mm/bootmem: drop duplicated kernel-doc comments Mike Rapoport 2018-06-30 14:54 ` Mike Rapoport 2018-06-30 14:54 ` Mike Rapoport [this message] 2018-06-30 14:54 ` [PATCH v2 02/11] docs/mm: nobootmem: fixup " Mike Rapoport 2018-06-30 14:54 ` [PATCH v2 03/11] docs/mm: bootmem: fix kernel-doc warnings Mike Rapoport 2018-06-30 14:54 ` Mike Rapoport 2018-06-30 14:54 ` [PATCH v2 04/11] docs/mm: bootmem: add kernel-doc description of 'struct bootmem_data' Mike Rapoport 2018-06-30 14:54 ` Mike Rapoport 2018-06-30 14:55 ` [PATCH v2 05/11] docs/mm: bootmem: add overview documentation Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-06-30 14:55 ` [PATCH v2 06/11] mm/memblock: add a name for memblock flags enumeration Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-07-12 8:00 ` Michal Hocko 2018-07-12 8:00 ` Michal Hocko 2018-06-30 14:55 ` [PATCH v2 07/11] docs/mm: memblock: update kernel-doc comments Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-06-30 14:55 ` [PATCH v2 08/11] docs/mm: memblock: add kernel-doc comments for memblock_add[_node] Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-06-30 14:55 ` [PATCH v2 09/11] docs/mm: memblock: add kernel-doc description for memblock types Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-06-30 14:55 ` [PATCH v2 10/11] docs/mm: memblock: add overview documentation Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-06-30 14:55 ` [PATCH v2 11/11] docs/mm: add description of boot time memory management Mike Rapoport 2018-06-30 14:55 ` Mike Rapoport 2018-07-03 12:23 ` Michal Hocko 2018-07-03 12:23 ` Michal Hocko 2018-07-12 7:26 ` Mike Rapoport 2018-07-12 7:26 ` Mike Rapoport 2018-07-01 15:26 ` [PATCH v2 00/11] docs/mm: add boot time memory management docs Randy Dunlap 2018-07-01 15:26 ` Randy Dunlap 2018-07-02 17:32 ` Jonathan Corbet 2018-07-02 17:32 ` Jonathan Corbet 2018-07-18 11:47 ` Mike Rapoport 2018-07-18 11:47 ` Mike Rapoport 2018-07-18 12:02 ` Jonathan Corbet 2018-07-18 12:02 ` Jonathan Corbet 2018-07-18 17:00 ` Mike Rapoport 2018-07-18 17:00 ` Mike Rapoport 2018-07-26 21:45 ` Jonathan Corbet 2018-07-26 21:45 ` Jonathan Corbet 2018-08-02 18:36 ` Jonathan Corbet 2018-08-02 18:36 ` Jonathan Corbet
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1530370506-21751-3-git-send-email-rppt@linux.vnet.ibm.com \ --to=rppt@linux.vnet.ibm.com \ --cc=corbet@lwn.net \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-mm@kvack.org \ --cc=rdunlap@infradead.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.