slab: add kmalloc() to kernel API documentation
commite7efa615ccf78394338144ff0187be331240748a
authorMichael Opdenacker <michael.opdenacker@free-electrons.com>
Tue, 25 Jun 2013 16:16:55 +0000 (25 18:16 +0200)
committerPekka Enberg <penberg@kernel.org>
Sun, 7 Jul 2013 16:02:59 +0000 (7 19:02 +0300)
tree7daaf9b4106ec8fb9e8e946a07fcc2b7cf901547
parent0f8f8094d28eb53368ac09186ea6b3a324cc7d44
slab: add kmalloc() to kernel API documentation

At the moment, kmalloc() isn't even listed in the kernel API
documentation (DocBook/kernel-api.html after running "make htmldocs").

Another issue is that the documentation for kmalloc_node()
refers to kcalloc()'s documentation to describe its 'flags' parameter,
while kcalloc() refered to kmalloc()'s documentation, which doesn't exist!

This patch is a proposed fix for this. It also removes the documentation
for kmalloc() in include/linux/slob_def.h which isn't included to
generate the documentation anyway. This way, kmalloc() is described
in only one place.

Acked-by: Christoph Lameter <cl@linux.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Michael Opdenacker <michael.opdenacker@free-electrons.com>
Signed-off-by: Pekka Enberg <penberg@kernel.org>
include/linux/slab.h
include/linux/slob_def.h