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] Documentation/vm: Include kernel-doc from highmem-internal.h
Date: Mon, 18 Apr 2022 10:17:40 +0200 [thread overview]
Message-ID: <20220418081740.21001-1-fmdefrancesco@gmail.com> (raw)
In Documentation/vm/highmem.rst the kernel-doc comments are missing,
therefore kunmap_local() and kunmap_atomic() are yet undocumented.
Add a kernel-doc directive to include the above-mentioned kernel-doc
comments in highmem.rst.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ira Weiny <ira.weiny@intel.com>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
---
This patch must be applied and built on top of
"[PATCH v3 2/2] Documentation/vm: Include kernel-doc to highmem.rst"
https://lore.kernel.org/lkml/20220415231917.25962-3-fmdefrancesco@gmail.com/
Documentation/vm/highmem.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/vm/highmem.rst b/Documentation/vm/highmem.rst
index 5dcee6233cd5..1a3e6a8f5d3e 100644
--- a/Documentation/vm/highmem.rst
+++ b/Documentation/vm/highmem.rst
@@ -161,3 +161,4 @@ Functions
=========
.. kernel-doc:: include/linux/highmem.h
+.. kernel-doc:: include/linux/highmem-internal.h
--
2.34.1
next reply other threads:[~2022-04-18 8:17 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-18 8:17 Fabio M. De Francesco [this message]
2022-04-18 21:36 ` [PATCH] Documentation/vm: Include kernel-doc from highmem-internal.h Ira Weiny
2022-04-18 22:05 ` Fabio M. De Francesco
2022-04-19 12:35 ` Fabio M. De Francesco
2022-04-21 17:52 ` 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=20220418081740.21001-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;
as well as URLs for NNTP newsgroup(s).