Messages in this thread Patch in this message | | | Date | Fri, 26 May 2006 13:42:04 +0400 | Subject | Re: [PATCH] kmalloc man page before 2.6.17 | From | Andrey Panin <> |
| |
On 146, 05 26, 2006 at 12:20:56PM +0400, Paul Drynoff wrote: > Currently kernel-doc doesn't produce the man page for "kmalloc",
Of course it doesn't. You need to add line
!Iinclude/linux/slab.h
into Documentation/DocBook/kernel-api.tmpl. And BTW you can add comment for kzalloc() too. Something like this:
/** * kzalloc - allocate memory. The memory is set to zero. * @size: how many bytes of memory are required. * @flags: the type of memory to allocate. */
> I think that is a big lack of documentation. This patch should help. > Now > scripts/kernel-doc -man -function kmalloc include/linux/slab.h | > nroff -man | less > creates suitable "man page". > > Signed-off-by: Paul Drynoff <pauldrynoff@gmail.com> > > --- > > Index: linux-2.6.17-rc4/mm/slab.c > =================================================================== > --- linux-2.6.17-rc4.orig/mm/slab.c > +++ linux-2.6.17-rc4/mm/slab.c > @@ -3244,26 +3244,10 @@ EXPORT_SYMBOL(kmalloc_node); > #endif > > /** > - * kmalloc - allocate memory > + * __do_kmalloc - allocate memory > * @size: how many bytes of memory are required. > - * @flags: the type of memory to allocate. > + * @flags: the type of memory to allocate(see kmalloc). > * @caller: function caller for debug tracking of the caller > - * > - * 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. Use inside interrupt handlers. > - * > - * Additionally, the %GFP_DMA flag may be set to indicate the memory > - * must be suitable for DMA. This can mean different things on different > - * platforms. For example, on i386, it means that the memory must come > - * from the first 16MB. > */ > static __always_inline void *__do_kmalloc(size_t size, gfp_t flags, > void *caller) > Index: linux-2.6.17-rc4/include/linux/slab.h > =================================================================== > --- linux-2.6.17-rc4.orig/include/linux/slab.h > +++ linux-2.6.17-rc4/include/linux/slab.h > @@ -87,6 +87,27 @@ extern void *__kmalloc_track_caller(size > __kmalloc_track_caller(size, flags, __builtin_return_address(0)) > #endif > > +/** > + * kmalloc - allocate memory > + * @size: how many bytes of memory are required. > + * @gfp: the type of memory to allocate. > + * > + * kmalloc is the normal method of allocating memory > + * in the kernel. > + * > + * The @gfp 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. Use inside interrupt handlers. > + * > + * Additionally, the %GFP_DMA flag may be set to indicate the memory > + * must be suitable for DMA. This can mean different things on different > + * platforms. For example, on i386, it means that the memory must come > + * from the first 16MB. > + */ > static inline void *kmalloc(size_t size, gfp_t flags) > { > if (__builtin_constant_p(size)) { > - > To unsubscribe from this list: send the line "unsubscribe linux-kernel" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html > Please read the FAQ at http://www.tux.org/lkml/ >
-- Andrey Panin | Linux and UNIX system administrator pazke@donpac.ru | PGP key: wwwkeys.pgp.net [unhandled content-type:application/pgp-signature] | |