diff options
| author |   Mike Rapoport <rppt@linux.vnet.ibm.com> | 2018-06-30 17:54:58 +0300 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2018-08-02 12:17:27 -0600 |
| commit | 7c757207faf4526acfa18b25c6e9fe75a7e0d922 (patch) | |
| tree | 6b2991d5812a9b8585ff779755eee6260d227e01 /mm | |
| parent | docs/mm: nobootmem: fixup kernel-doc comments (diff) | |
| download | linux-dev-7c757207faf4526acfa18b25c6e9fe75a7e0d922.tar.xz linux-dev-7c757207faf4526acfa18b25c6e9fe75a7e0d922.zip | |
docs/mm: bootmem: fix kernel-doc warnings
Add descriptions of the return value where they were missing and fixup the
syntax for present ones.
Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'mm')
| -rw-r--r-- | mm/bootmem.c | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/mm/bootmem.c b/mm/bootmem.c index 42ab0da3a34a..76fc17eb78ae 100644 --- a/mm/bootmem.c +++ b/mm/bootmem.c @@ -62,6 +62,8 @@ static unsigned long __init bootmap_bytes(unsigned long pages) /** * bootmem_bootmap_pages - calculate bitmap size in pages * @pages: number of pages the bitmap has to represent + * + * Return: the number of pages needed to hold the bitmap. */ unsigned long __init bootmem_bootmap_pages(unsigned long pages) { @@ -121,7 +123,7 @@ static unsigned long __init init_bootmem_core(bootmem_data_t *bdata, * @startpfn: first pfn on the node * @endpfn: first pfn after the node * - * Returns the number of bytes needed to hold the bitmap for this node. + * Return: the number of bytes needed to hold the bitmap for this node. */ unsigned long __init init_bootmem_node(pg_data_t *pgdat, unsigned long freepfn, unsigned long startpfn, unsigned long endpfn) @@ -134,7 +136,7 @@ unsigned long __init init_bootmem_node(pg_data_t *pgdat, unsigned long freepfn, * @start: pfn where the bitmap is to be placed * @pages: number of available physical pages * - * Returns the number of bytes needed to hold the bitmap. + * Return: the number of bytes needed to hold the bitmap. */ unsigned long __init init_bootmem(unsigned long start, unsigned long pages) { @@ -406,6 +408,8 @@ void __init free_bootmem(unsigned long physaddr, unsigned long size) * Partial pages will be reserved. * * The range must reside completely on the specified node. + * + * Return: 0 on success, -errno on failure. */ int __init reserve_bootmem_node(pg_data_t *pgdat, unsigned long physaddr, unsigned long size, int flags) @@ -427,6 +431,8 @@ int __init reserve_bootmem_node(pg_data_t *pgdat, unsigned long physaddr, * Partial pages will be reserved. * * The range must be contiguous but may span node boundaries. + * + * Return: 0 on success, -errno on failure. */ int __init reserve_bootmem(unsigned long addr, unsigned long size, int flags) |