Re: [PATCH] mm/comments: kmalloc man page before 2.6.17 (the third attempt)

[Pekka Enberg]

Since no one else seems to have complained about this...

On 5/28/06, Paul Drynoff <pauldrynoff@xxxxxxxxx> wrote:
> +/**
> + * kmalloc - allocate memory
> + * @size: how many bytes of memory are required.
> + * @flags: the type of memory to allocate.
> + *
> + * kmalloc is the normal method of allocating memory
> + * in the kernel.
> + *
> + * The @flags argument may be one of:
> + *
> + * %GFP_USER - Allocate memory on behalf of user.  May sleep.
> + *
> + * %GFP_KERNEL - Allocate normal kernel ram.  May sleep.
> + *
> + * %GFP_ATOMIC - Allocation will not sleep.
> + *   For example: use inside interrupt handlers.
> + * %GFP_HIGHUSER - Allocate pages from high memory.
> + * %GFP_NOIO - Do not do any I/O at all while trying to get memory.
> + * %GFP_NOFS - Do not make any fs calls while trying to get memory.

Why are the last four formatted differently from the first two?  That
is, a newline seems to be missing.

> + *
> + *
> + * Also it is possible set different flags by OR'ing
> + * in one or more of the following:
> + * %__GFP_COLD
> + *  - Request cache-cold pages instead of trying to return cache-warm pages.
> + * %__GFP_DMA
> + *  - Request memory from the DMA-capable zone.
> + * %__GFP_HIGH
> + *  - This allocation has high priority and may use emergency pools.
> + * %__GFP_HIGHMEM
> + *   - Allocated memory may be from highmem.
> + * %__GFP_NOFAIL
> + *  - Indicate that this allocation is in no way allowed to fail
> + * (think twice before using).
> + * %__GFP_NORETRY
> + * - If memory is not immediately available, then give up at once.
> + * %__GFP_NOWARN
> + * - If allocation fails, don't issue any warnings.
> + * %__GFP_REPEAT
> + * - If allocation fails initially, try once more before failing.

And why do these have completely different formatting?  Please pick
one and use that consistently.

                                Pekka
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/