From: ira.weiny@intel.com
To: "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
Cc: Andrew Morton <akpm@linux-foundation.org>,
Catalin Marinas <catalin.marinas@arm.com>,
"Matthew Wilcox (Oracle)" <willy@infradead.org>,
Will Deacon <will@kernel.org>,
Peter Collingbourne <pcc@google.com>,
Vlastimil Babka <vbabka@suse.cz>,
Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
outreachy@lists.linux.dev
Subject: Re: [PATCH v4 0/4] Extend and reorganize Highmem's documentation
Date: Sat, 30 Apr 2022 22:11:43 -0700 [thread overview]
Message-ID: <Ym4WSstEQI7yYU0n@iweiny-server> (raw)
In-Reply-To: <20220428212455.892-1-fmdefrancesco@gmail.com>
On Thu, Apr 28, 2022 at 11:24:51PM +0200, Fabio M. De Francesco wrote:
> This series has the purpose to extend and reorganize Highmem's
> documentation.
>
> This is a work in progress because some information should still be moved
> from highmem.rst to highmem.h and highmem-internal.h. Specifically I'm
> talking about moving the "how to" information to the relevant headers, as
> it as been suggested by Ira Weiny (Intel).
>
> Also, this is a work in progress because some kdocs in highmem.h and
> highmem-internal.h should be improved.
>
> However, I think (and hope that my thoughts are also shared by Maintainers
> and Reviewers) that this series constitues a sensible step forward
> improving Highmem's documentation, despite some important issues are not
> yet addressed.
For the series:
Reviewed-by: Ira Weiny <ira.weiny@intel.com>
>
> Changes from v1 to v2:
>
> 1/4 - Fix typos (Mike Rapoport); re-write the description of @page
> because the original was wrong (Ira Weiny); add Ira's and
> Mike's tags in the commit message.
> 2/4 - Add Ira's and Mike's tags in the commit message.
> 3/4 - Rework the subject to better summarize what this patch
> changes; merge the section which was removed from highmem.rst
> with the kdocs of highmem.h (suggested by Ira Weiny); add
> Ira's tag in the commit message.
> 4/4 - Reformulate a sentence that was incomprehensible due to my
> own mistakes in copying and pasting the text of another
> paragraph (problem noted by Ira Weiny); refer to the kdocs
> of kmap_local_page () to show how nested mappings should be
> handled; fix grammar error; add Ira's tag in the commit
> message.
>
> Changes from v2 to v3:
>
> 1/4 - Add a deprecation notice to kunmap_atomic() for consistency
> with the same notice in kmap_atomic() (Sebastian Andrzej
> Siewior); shorten subject and extend commit message.
> 2/4 - No changes.
> 3/4 - No changes.
> 4/4 - Correct a technical inaccuracy about preemption disabling /
> re-enabling in kmap_atomic() / kunmap_atomic() (Sebastian
> Andrzej Siewior).
>
> Changes from v3 to v4:
>
> 1/4 - Correct some techinal inaccuracies about the side effects
> of calling kmap_atomic() and kmap_local_page() (Sebastian
> Andrzej Siewior); drop "Acked-by:" and "Reviewed-by:" tags
> because relevant parts of this patch have changed.
> 2/4 - No changes.
> 3/4 - No changes.
> 4/4 - Shorten a couple of paragraphs by removing redundant
> information (Sebastian Andrzej Siewior).
>
> Fabio M. De Francesco (4):
> mm/highmem: Fix kernel-doc warnings in highmem*.h
> Documentation/vm: Include kdocs from highmem*.h into highmem.rst
> Documentation/vm: Move "Using kmap-atomic" from highmem.rst to
> highmem.h
> Documentation/vm: Rework "Temporary Virtual Mappings" section
>
> Documentation/vm/highmem.rst | 100 ++++++++++++++++++-------------
> include/linux/highmem-internal.h | 18 +++++-
> include/linux/highmem.h | 51 ++++++++++++----
> 3 files changed, 113 insertions(+), 56 deletions(-)
>
> --
> 2.34.1
>
prev parent reply other threads:[~2022-05-01 5:11 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-28 21:24 [PATCH v4 0/4] Extend and reorganize Highmem's documentation Fabio M. De Francesco
2022-04-28 21:24 ` [PATCH v4 1/4] mm/highmem: Fix kernel-doc warnings in highmem*.h Fabio M. De Francesco
2022-04-28 21:24 ` [PATCH v4 2/4] Documentation/vm: Include kdocs from highmem*.h into highmem.rst Fabio M. De Francesco
2022-04-28 21:24 ` [PATCH v4 3/4] Documentation/vm: Move "Using kmap-atomic" to highmem.h Fabio M. De Francesco
2022-04-28 21:24 ` [PATCH v4 4/4] Documentation/vm: Rework "Temporary Virtual Mappings" section Fabio M. De Francesco
2022-04-29 6:51 ` [PATCH v4 0/4] Extend and reorganize Highmem's documentation Sebastian Andrzej Siewior
2022-05-01 5:11 ` ira.weiny [this message]
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=Ym4WSstEQI7yYU0n@iweiny-server \
--to=ira.weiny@intel.com \
--cc=akpm@linux-foundation.org \
--cc=bigeasy@linutronix.de \
--cc=catalin.marinas@arm.com \
--cc=fmdefrancesco@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=outreachy@lists.linux.dev \
--cc=pcc@google.com \
--cc=vbabka@suse.cz \
--cc=will@kernel.org \
--cc=willy@infradead.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;
as well as URLs for NNTP newsgroup(s).