From: Changbin Du <changbin.du@gmail.com>
To: Eric Van Hensbergen <ericvh@gmail.com>,
Latchesar Ionkov <lucho@ionkov.net>,
Dominique Martinet <asmadeus@codewreck.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
v9fs-developer@lists.sourceforge.net, "Enrico Weigelt,
metux IT consult" <lkml@metux.net>,
Changbin Du <changbin.du@gmail.com>
Subject: [PATCH v3 3/3] 9p: doc: add v9fsroot description
Date: Mon, 7 Jun 2021 07:09:22 +0800 [thread overview]
Message-ID: <20210606230922.77268-4-changbin.du@gmail.com> (raw)
In-Reply-To: <20210606230922.77268-1-changbin.du@gmail.com>
This documentation is modified from cifs/cifsroot.rst.
Signed-off-by: Changbin Du <changbin.du@gmail.com>
---
Documentation/filesystems/v9fs/index.rst | 1 +
Documentation/filesystems/v9fs/v9fsroot.rst | 52 +++++++++++++++++++++
MAINTAINERS | 1 +
3 files changed, 54 insertions(+)
create mode 100644 Documentation/filesystems/v9fs/v9fsroot.rst
diff --git a/Documentation/filesystems/v9fs/index.rst b/Documentation/filesystems/v9fs/index.rst
index a1e45b89e2a2..65e1ceb04c9c 100644
--- a/Documentation/filesystems/v9fs/index.rst
+++ b/Documentation/filesystems/v9fs/index.rst
@@ -9,3 +9,4 @@ v9fs
:numbered:
9p
+ v9fsroot
diff --git a/Documentation/filesystems/v9fs/v9fsroot.rst b/Documentation/filesystems/v9fs/v9fsroot.rst
new file mode 100644
index 000000000000..ce6b3c85e301
--- /dev/null
+++ b/Documentation/filesystems/v9fs/v9fsroot.rst
@@ -0,0 +1,52 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================================
+Mounting root file system via v9fs (9p.ko)
+==========================================
+
+:Author: Changbin Du <changbin.du@gmail.com>
+
+The CONFIG_9P_FS_ROOT option enables experimental root file system
+support for v9fs.
+
+It introduces a new kernel command-line option called 'v9fsroot='
+which will tell the kernel to mount the root file system by
+utilizing the 9p protocol.
+
+
+Kernel command line
+===================
+
+::
+
+ root=/dev/v9fs
+
+This is just a virtual device that basically tells the kernel to mount
+the root file system via 9p protocol.
+
+::
+
+ v9fsroot=<path>[,options]
+
+Enables the kernel to mount the root file system via 9p specified in this
+option.
+
+path
+ Could be a remote file server, Plan 9 From User Space applications
+ or mount tag of virtio transport.
+
+options
+ Optional mount options.
+
+Examples
+========
+Test it under QEMU on a kernel built with CONFIG_9P_FS_ROOT and
+CONFIG_IP_PNP options enabled::
+
+ # qemu-system-x86_64 -enable-kvm -cpu host -m 1024 \
+ -virtfs local,path=$rootfs_dir,mount_tag=r,security_model=passthrough,id=r \
+ -kernel /path/to/linux/arch/x86/boot/bzImage -nographic \
+ -append "root=/dev/v9fs v9fsroot=r,trans=virtio rw console=ttyS0 3"
+
+The above example mounts v9fs with tag 'r' as rootfs in qemu guest via
+virtio transport.
diff --git a/MAINTAINERS b/MAINTAINERS
index 3da44eef1471..dfcee6dfe182 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -243,6 +243,7 @@ F: net/9p/
R: Changbin Du <changbin.du@gmail.com>
S: Supported
F: fs/9p/v9fsroot.c
+F: Documentation/filesystems/v9fs/v9fsroot.rst
A8293 MEDIA DRIVER
M: Antti Palosaari <crope@iki.fi>
--
2.30.2
next prev parent reply other threads:[~2021-06-06 23:11 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-06 23:09 [PATCH v3 0/3] 9p: add support for root file systems Changbin Du
2021-06-06 23:09 ` [PATCH v3 1/3] " Changbin Du
2021-06-07 1:06 ` kernel test robot
2021-06-07 1:06 ` kernel test robot
2021-06-14 1:09 ` Changbin Du
2021-06-14 1:09 ` Changbin Du
2021-06-06 23:09 ` [PATCH v3 2/3] 9p: doc: move to a new dedicated folder Changbin Du
2021-06-06 23:09 ` Changbin Du [this message]
2021-06-06 23:45 ` [PATCH v3 0/3] 9p: add support for root file systems Dominique Martinet
2021-06-14 8:57 ` Josh Triplett
2021-06-14 9:01 ` Dominique Martinet
2021-06-14 9:19 ` Josh Triplett
2021-06-20 3:36 ` Changbin Du
2021-06-20 4:16 ` Dominique Martinet
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=20210606230922.77268-4-changbin.du@gmail.com \
--to=changbin.du@gmail.com \
--cc=asmadeus@codewreck.org \
--cc=corbet@lwn.net \
--cc=ericvh@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkml@metux.net \
--cc=lucho@ionkov.net \
--cc=v9fs-developer@lists.sourceforge.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.