Skip to content

Commit

Permalink
docs/core-api: make mm-api.rst more structured
Browse files Browse the repository at this point in the history
The mm-api.rst covers variety of memory management APIs under "More Memory
Management Functions" section. The descriptions included there are in a
random order there are quite a few of them which makes the section too
long.

Regrouping the documentation by subject and splitting the long "More Memory
Management Functions" section into several smaller sections makes the
generated html more usable.

Signed-off-by: Mike Rapoport <rppt@linux.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
rppt authored and Jonathan Corbet committed Dec 6, 2018
1 parent c5ed311 commit 2f7e6f6
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions Documentation/core-api/mm-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,32 +49,43 @@ The Slab Cache
.. kernel-doc:: mm/util.c
:functions: kfree_const kvmalloc_node kvfree

More Memory Management Functions
================================
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/memory.c
.. kernel-doc:: mm/page-writeback.c
:export:

.. kernel-doc:: mm/vmalloc.c
.. kernel-doc:: mm/truncate.c
:export:

.. kernel-doc:: mm/page_alloc.c
:internal:
Memory pools
============

.. kernel-doc:: mm/mempool.c
:export:

DMA pools
=========

.. kernel-doc:: mm/dmapool.c
:export:

.. kernel-doc:: mm/page-writeback.c
:export:
More Memory Management Functions
================================

.. kernel-doc:: mm/truncate.c
.. kernel-doc:: mm/memory.c
:export:

.. kernel-doc:: mm/page_alloc.c

0 comments on commit 2f7e6f6

Please sign in to comment.