Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750936AbWE2O3W (ORCPT ); Mon, 29 May 2006 10:29:22 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1750937AbWE2O3W (ORCPT ); Mon, 29 May 2006 10:29:22 -0400 Received: from ug-out-1314.google.com ([66.249.92.172]:39729 "EHLO ug-out-1314.google.com") by vger.kernel.org with ESMTP id S1750922AbWE2O3V (ORCPT ); Mon, 29 May 2006 10:29:21 -0400 DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:date:from:to:cc:subject:message-id:in-reply-to:references:x-mailer:mime-version:content-type:content-transfer-encoding; b=otU6HTyEOm6MnazzgLyhDzi0IxpyRVrSnIP1miIu2XryXidp3stN6ndCub+RfPzmlrx39l3vnyNr5qzUAELPsnSLQofyzGekhSBFRBfAbCLMgqAX9wHgFzsRa8gLAQ9Gzh4xKrZqyFABj9PZ6gtp2rKgcLFAjks0xOiE/6B9Ebw= Date: Mon, 29 May 2006 18:33:25 +0400 From: Paul Drynoff To: "Pekka Enberg" Cc: akpm@osdl.org, linux-kernel@vger.kernel.org Subject: [PATCH] mm/comments: kmalloc man page before 2.6.17 (the fifth attempt) Message-Id: <20060529183325.937cea13.pauldrynoff@gmail.com> In-Reply-To: <84144f020605281029q1fa6ed59jb415ffb9a7daeef9@mail.gmail.com> References: <20060528111446.55572c6f.pauldrynoff@gmail.com> <84144f020605281029q1fa6ed59jb415ffb9a7daeef9@mail.gmail.com> X-Mailer: Sylpheed version 2.2.4 (GTK+ 2.8.12; i686-pc-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 4313 Lines: 115 This bugfix patch is added comments to right places and give possibility generate man pages for kmalloc(9) and kzalloc(9). Changelog: * fix formatting issue Signed-off-by: Paul Drynoff --- 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,39 @@ 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. + * @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. + * + * Also it is possible to 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. + */ static inline void *kmalloc(size_t size, gfp_t flags) { if (__builtin_constant_p(size)) { @@ -112,6 +145,11 @@ found: extern void *__kzalloc(size_t, gfp_t); +/** + * kzalloc - allocate memory. The memory is set to zero. + * @size: how many bytes of memory are required. + * @flags: the type of memory to allocate (see kmalloc). + */ static inline void *kzalloc(size_t size, gfp_t flags) { if (__builtin_constant_p(size)) { Index: linux-2.6.17-rc4/Documentation/DocBook/kernel-api.tmpl =================================================================== --- linux-2.6.17-rc4.orig/Documentation/DocBook/kernel-api.tmpl +++ linux-2.6.17-rc4/Documentation/DocBook/kernel-api.tmpl @@ -124,6 +124,7 @@ X!Ilib/string.c !Earch/i386/lib/usercopy.c More Memory Management Functions +!Iinclude/linux/slab.h !Iinclude/linux/rmap.h !Emm/readahead.c !Emm/filemap.c - 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/