mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Andrew Morton <akpm@linux-foundation.org>,
	SeongJae Park <sj@kernel.org>,
	Jiajian Ye <yejiajian2018@email.szu.edu.cn>,
	Thomas Gleixner <tglx@linutronix.de>,
	Ira Weiny <ira.weiny@intel.com>,
	Matthew Wilcox <willy@infradead.org>,
	Peter Zijlstra <peterz@infradead.org>,
	outreachy@lists.linux.dev, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Cc: "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
Subject: [PATCH v3 0/2] Documentation/vm: Rework and extend highmem.rst
Date: Sat, 16 Apr 2022 01:19:15 +0200	[thread overview]
Message-ID: <20220415231917.25962-1-fmdefrancesco@gmail.com> (raw)

Extend and rework the "Temporary Virtual Mappings" section of the highmem.rst
documentation.

Do a partial rework of the paragraph related to kmap() and add a new paragraph
in order to document the set of kmap_local_*() functions. Re-order paragraphs
in decreasing order of preference of usage.

Include kerneldoc comments from include/linux/highmem.h and remove
redundant and obsolete section about kmap_atomic().

v1-v2:
	1/2 - According to comments on v1 by Matthew Wilcox and Ira Weiny,
	      correct a mistake in text, format paragraphs to stay within 
	      the 75 characters limit, re-order the flow of the same 
	      paragraphs in decreasing order of preference of usage.
	2/2 - No patch.

v2->v3:
	1/2 - No changes.
	2/2 - Added patch to include kernel-doc to highmem.rst and
	      remove the now redundant section about kmap_atomic().

Fabio M. De Francesco (2):
  Documentation/vm: Extend "Temporary Virtual Mappings" section in
    highmem.rst
  Documentation/vm: Include kernel-doc to highmem.rst

 Documentation/vm/highmem.rst | 96 +++++++++++++++++++++---------------
 1 file changed, 56 insertions(+), 40 deletions(-)

-- 
2.34.1


             reply	other threads:[~2022-04-15 23:19 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-15 23:19 Fabio M. De Francesco [this message]
2022-04-15 23:19 ` [PATCH v3 1/2] Documentation/vm: Extend "Temporary Virtual Mappings" section Fabio M. De Francesco
2022-04-18 21:30   ` Ira Weiny
2022-04-19 14:52     ` Fabio M. De Francesco
2022-04-15 23:19 ` [PATCH v3 2/2] Documentation/vm: Include kernel-doc to highmem.rst Fabio M. De Francesco
2022-04-18 21:32   ` Ira Weiny
2022-04-21 17:51 ` [PATCH v3 0/2] Documentation/vm: Rework and extend highmem.rst Fabio M. De Francesco

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=20220415231917.25962-1-fmdefrancesco@gmail.com \
    --to=fmdefrancesco@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=ira.weiny@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=outreachy@lists.linux.dev \
    --cc=peterz@infradead.org \
    --cc=sj@kernel.org \
    --cc=tglx@linutronix.de \
    --cc=willy@infradead.org \
    --cc=yejiajian2018@email.szu.edu.cn \
    /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

all inboxes | Powered by JetHome®