path: root/Documentation/core-api
diff options
authorMatthew Wilcox (Oracle) <>2021-02-24 12:06:35 -0800
committerLinus Torvalds <>2021-02-24 13:38:32 -0800
commit3b2ebeaf98a028d5dd4ec63095855ef507920276 (patch)
tree892936283828d3166ae1494b7dbfd87a39f38ed3 /Documentation/core-api
parenta0cd7a7c4bc004587d1f4785a320f58e72d880eb (diff)
mm/gfp: add kernel-doc for gfp_t
The generated html will link to the definition of the gfp_t automatically once we define it. Move the one-paragraph overview of GFP flags from the documentation directory into gfp.h and pull gfp.h into the documentation. This generates warnings with clang (, so use a #if 0 to hide it from the compiler for now. Link: Link: Signed-off-by: Matthew Wilcox (Oracle) <> Acked-by: Mike Rapoport <> Cc: Nathan Chancellor <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
Diffstat (limited to 'Documentation/core-api')
1 files changed, 2 insertions, 5 deletions
diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
index 2adffb3f7914..201b5423303b 100644
--- a/Documentation/core-api/mm-api.rst
+++ b/Documentation/core-api/mm-api.rst
@@ -19,11 +19,8 @@ User Space Memory Access
Memory Allocation Controls
-Functions which need to allocate memory often use GFP flags to express
-how that memory should be allocated. The GFP acronym stands for "get
-free pages", the underlying memory allocation function. Not every GFP
-flag is allowed to every function which may allocate memory. Most
-users will want to use a plain ``GFP_KERNEL``.
+.. kernel-doc:: include/linux/gfp.h
+ :internal:
.. kernel-doc:: include/linux/gfp.h
:doc: Page mobility and placement hints