Re: [PATCH -mm 03/14] bootmem: add documentation to API functions

Chris Malley
2008-06-02T12:44:04Z

On Fri, 2008-05-30 at 21:42 +0200, Johannes Weiner wrote:

> Signed-off-by: Johannes Weiner <hannes@saeurebad.de>
> ---
>
> mm/bootmem.c | 147 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
> 1 file changed, 146 insertions(+), 1 deletion(-)
>
> --- a/mm/bootmem.c
> +++ b/mm/bootmem.c

[snip]

>
> +/**
> + * reserve_bootmem_node - mark a page range as reserved
> + * @addr: starting address of the range
> + * @size: size of the range in bytes

kerneldoc arguments don't match the actual function definition.

> + *
> + * Partial pages will be reserved.
> + *
> + * Only physical pages that actually reside on @pgdat are marked.
> + */
> void __init reserve_bootmem_node(pg_data_t *pgdat, unsigned long physaddr,
> unsigned long size, int flags)
> {
> @@ -331,6 +390,16 @@ void __init reserve_bootmem_node(pg_data
> }
>
> #ifndef CONFIG_HAVE_ARCH_BOOTMEM_NODE
> +/**
> + * reserve_bootmem - mark a page range as usable
> + * @addr: starting address of the range
> + * @size: size of the range in bytes

and here (missing @flags)

> i>>?i>>?+ *
> + * Partial pages will be reserved.
> + *
> + * All physical pages within the range are marked, no matter what
> + * node they reside on.
> + */
> int __init reserve_bootmem(unsigned long addr, unsigned long size,
> int flags)
> {
> @@ -499,6 +568,19 @@ found:
> return ret;
> }
>

cheers
Chris