linux-kernel - [PATCH v3 0/2] Documentation/vm: Rework and extend highmem.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220415231917.25962-1-fmdefrancesco@gmail.com>
Date:   Sat, 16 Apr 2022 01:19:15 +0200
From:   "Fabio M. De Francesco" <fmdefrancesco@...il.com>
To:     Jonathan Corbet <corbet@....net>,
        Andrew Morton <akpm@...ux-foundation.org>,
        SeongJae Park <sj@...nel.org>,
        Jiajian Ye <yejiajian2018@...il.szu.edu.cn>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ira Weiny <ira.weiny@...el.com>,
        Matthew Wilcox <willy@...radead.org>,
        Peter Zijlstra <peterz@...radead.org>,
        outreachy@...ts.linux.dev, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Cc:     "Fabio M. De Francesco" <fmdefrancesco@...il.com>
Subject: [PATCH v3 0/2] Documentation/vm: Rework and extend highmem.rst 

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