[PATCH 00/11] docs/mm: add boot time memory management docs

From: Mike Rapoport
Date: Mon Jun 18 2018 - 13:00:14 EST


Hi,

Both bootmem and memblock have pretty good documentation coverage. With
some fixups and additions we get a nice overall description.

The last commit in the series that creates the boot-time-mm.rst depends on
the 'nodoc' sphix directive patch [1] I've sent earlier

While working on the docs, I've noticed that both bootmem and nobootmem
implement some one-line wrappers for the core allocation methods as a
global functions rather than 'static inline'. I wonder whether I miss
something important here is it just a historic thing?

[1] https://marc.info/?l=linux-doc&m=152932901214922&w=2

Mike Rapoport (11):
mm/bootmem: drop duplicated kernel-doc comments
docs/mm: nobootmem: fixup kernel-doc comments
docs/mm: bootmem: fix kernel-doc warnings
docs/mm: bootmem: add kernel-doc description of 'struct bootmem_data'
docs/mm: bootmem: add overview documentation
mm/memblock: add a name for memblock flags enumeration
docs/mm: memblock: update kernel-doc comments
docs/mm: memblock: add kernel-doc comments for memblock_add[_node]
docs/mm: memblock: add kernel-doc description for memblock types
docs/mm: memblock: add overview documentation
docs/mm: add description of boot time memory management

Documentation/core-api/boot-time-mm.rst | 92 +++++++++++++++
Documentation/core-api/index.rst | 1 +
include/linux/bootmem.h | 17 ++-
include/linux/memblock.h | 76 ++++++++----
mm/bootmem.c | 159 +++++++++----------------
mm/memblock.c | 203 +++++++++++++++++++++++---------
mm/nobootmem.c | 20 +++-
7 files changed, 380 insertions(+), 188 deletions(-)
create mode 100644 Documentation/core-api/boot-time-mm.rst

--
2.7.4