mirror of
https://github.com/torvalds/linux.git
synced 2024-12-04 18:13:04 +00:00
80a76c7261
Fix the mismatch between "Useful GFP flag combinations" section naming in
the DOC: section in include/linux/gfp.h and
Documentation/core-api/mm-api.rst. This brings in the documentation,
and eliminates one warning:
./include/linux/gfp.h:1: warning: no structured comments found
Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
[jc: tweaked changelog]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
95 lines
1.8 KiB
ReStructuredText
95 lines
1.8 KiB
ReStructuredText
======================
|
|
Memory Management APIs
|
|
======================
|
|
|
|
User Space Memory Access
|
|
========================
|
|
|
|
.. kernel-doc:: arch/x86/include/asm/uaccess.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: arch/x86/lib/usercopy_32.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/util.c
|
|
:functions: get_user_pages_fast
|
|
|
|
.. _mm-api-gfp-flags:
|
|
|
|
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
|
|
:doc: Page mobility and placement hints
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Watermark modifiers
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Reclaim modifiers
|
|
|
|
.. kernel-doc:: include/linux/gfp.h
|
|
:doc: Useful GFP flag combinations
|
|
|
|
The Slab Cache
|
|
==============
|
|
|
|
.. kernel-doc:: include/linux/slab.h
|
|
:internal:
|
|
|
|
.. kernel-doc:: mm/slab.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/slab_common.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/util.c
|
|
:functions: kfree_const kvmalloc_node kvfree
|
|
|
|
Virtually Contiguous Mappings
|
|
=============================
|
|
|
|
.. kernel-doc:: mm/vmalloc.c
|
|
:export:
|
|
|
|
File Mapping and Page Cache
|
|
===========================
|
|
|
|
.. kernel-doc:: mm/readahead.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/filemap.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/page-writeback.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/truncate.c
|
|
:export:
|
|
|
|
Memory pools
|
|
============
|
|
|
|
.. kernel-doc:: mm/mempool.c
|
|
:export:
|
|
|
|
DMA pools
|
|
=========
|
|
|
|
.. kernel-doc:: mm/dmapool.c
|
|
:export:
|
|
|
|
More Memory Management Functions
|
|
================================
|
|
|
|
.. kernel-doc:: mm/memory.c
|
|
:export:
|
|
|
|
.. kernel-doc:: mm/page_alloc.c
|