linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Mike Rapoport <rppt@linux.vnet.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Andrew Morton <akpm@linux-foundation.org>,
	linux-doc <linux-doc@vger.kernel.org>,
	linux-mm <linux-mm@kvack.org>,
	lkml <linux-kernel@vger.kernel.org>,
	Mike Rapoport <rppt@linux.vnet.ibm.com>
Subject: [PATCH 00/11] docs/mm: add boot time memory management docs
Date: Mon, 18 Jun 2018 19:59:48 +0300	[thread overview]
Message-ID: <1529341199-17682-1-git-send-email-rppt@linux.vnet.ibm.com> (raw)

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

             reply	other threads:[~2018-06-18 17:00 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-18 16:59 Mike Rapoport [this message]
2018-06-18 16:59 ` [PATCH 01/11] mm/bootmem: drop duplicated kernel-doc comments Mike Rapoport
2018-06-18 16:59 ` [PATCH 02/11] docs/mm: nobootmem: fixup " Mike Rapoport
2018-06-18 16:59 ` [PATCH 03/11] docs/mm: bootmem: fix kernel-doc warnings Mike Rapoport
2018-06-18 16:59 ` [PATCH 04/11] docs/mm: bootmem: add kernel-doc description of 'struct bootmem_data' Mike Rapoport
2018-06-18 17:25   ` Randy Dunlap
2018-06-18 16:59 ` [PATCH 05/11] docs/mm: bootmem: add overview documentation Mike Rapoport
2018-06-18 17:15   ` Randy Dunlap
2018-06-18 16:59 ` [PATCH 06/11] mm/memblock: add a name for memblock flags enumeration Mike Rapoport
2018-06-18 16:59 ` [PATCH 07/11] docs/mm: memblock: update kernel-doc comments Mike Rapoport
2018-06-18 16:59 ` [PATCH 08/11] docs/mm: memblock: add kernel-doc comments for memblock_add[_node] Mike Rapoport
2018-06-18 16:59 ` [PATCH 09/11] docs/mm: memblock: add kernel-doc description for memblock types Mike Rapoport
2018-06-18 16:59 ` [PATCH 10/11] docs/mm: memblock: add overview documentation Mike Rapoport
2018-06-18 17:21   ` Randy Dunlap
2018-06-18 16:59 ` [PATCH 11/11] docs/mm: add description of boot time memory management Mike Rapoport
2018-06-18 17:32   ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1529341199-17682-1-git-send-email-rppt@linux.vnet.ibm.com \
    --to=rppt@linux.vnet.ibm.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox