From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
To: linux-doc@vger.kernel.org,
Alexander Viro <viro@zeniv.linux.org.uk>,
Christoph Hellwig <hch@lst.de>
Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>,
linux-fsdevel@vger.kernel.org
Subject: [PATCH 1/3] iov_iter: Add skeleton documentation
Date: Mon, 6 Dec 2021 14:52:18 +0000 [thread overview]
Message-ID: <20211206145220.1175209-2-willy@infradead.org> (raw)
In-Reply-To: <20211206145220.1175209-1-willy@infradead.org>
This is just somewhere to include the kernel-doc from for now.
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
Documentation/core-api/index.rst | 1 +
Documentation/core-api/iov_iter.rst | 21 +++++++++++++++++++++
2 files changed, 22 insertions(+)
create mode 100644 Documentation/core-api/iov_iter.rst
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index 5de2c7a4b1b3..082143baa983 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -43,6 +43,7 @@ Library functionality that is used throughout the kernel.
this_cpu_ops
timekeeping
errseq
+ iov_iter
Concurrency primitives
======================
diff --git a/Documentation/core-api/iov_iter.rst b/Documentation/core-api/iov_iter.rst
new file mode 100644
index 000000000000..541c16caf958
--- /dev/null
+++ b/Documentation/core-api/iov_iter.rst
@@ -0,0 +1,21 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+========
+iov_iter
+========
+
+:Author: Matthew Wilcox
+
+Overview
+========
+
+The iov_iter is used to represent the source or destination for a read or
+write. It can point to many different kinds of memory, including user
+memory, kernel memory, pipes and biovecs.
+
+Functions and structures
+========================
+
+.. kernel-doc:: include/linux/uio.h
+.. kernel-doc:: lib/iov_iter.c
+ :export:
--
2.33.0
next prev parent reply other threads:[~2021-12-06 14:52 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-06 14:52 [PATCH 0/3] iov_iter documentation Matthew Wilcox (Oracle)
2021-12-06 14:52 ` Matthew Wilcox (Oracle) [this message]
2021-12-06 14:55 ` [PATCH 1/3] iov_iter: Add skeleton documentation Christoph Hellwig
2021-12-06 14:52 ` [PATCH 2/3] iov_iter: Add kernel-doc Matthew Wilcox (Oracle)
2021-12-06 14:54 ` Christoph Hellwig
2021-12-06 14:52 ` [PATCH 3/3] iov_iter: Move internal documentation Matthew Wilcox (Oracle)
2021-12-06 14:55 ` Christoph Hellwig
2021-12-06 15:00 ` Matthew Wilcox
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=20211206145220.1175209-2-willy@infradead.org \
--to=willy@infradead.org \
--cc=hch@lst.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=viro@zeniv.linux.org.uk \
/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).