From: Shobhit Kukreti <shobhitkukreti@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, skhan@linuxfoundation.org
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Shobhit Kukreti <shobhitkukreti@gmail.com>
Subject: [PATCH v2] Documentation: filesystems: Convert ufs.txt to reStructuredText format
Date: Tue, 9 Jul 2019 20:42:42 -0700 [thread overview]
Message-ID: <1562730162-2116-1-git-send-email-shobhitkukreti@gmail.com> (raw)
In-Reply-To: <20190707013947.GA10663@t-1000>
This converts the plain text documentation of ufs.txt to reStructuredText format.
Added to documentation build process and verified with make htmldocs
Signed-off-by: Shobhit Kukreti <shobhitkukreti@gmail.com>
---
Changes in v2:
1. Removed flat-table
2. Moved ufs.rst to admin-guide
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/ufs.rst | 48 +++++++++++++++++++++++++++++
Documentation/filesystems/ufs.txt | 60 -------------------------------------
3 files changed, 49 insertions(+), 60 deletions(-)
create mode 100644 Documentation/admin-guide/ufs.rst
delete mode 100644 Documentation/filesystems/ufs.txt
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 2871b79..9bfb076 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -71,6 +71,7 @@ configure specific aspects of kernel behavior to your liking.
bcache
ext4
jfs
+ ufs
pm/index
thunderbolt
LSM/index
diff --git a/Documentation/admin-guide/ufs.rst b/Documentation/admin-guide/ufs.rst
new file mode 100644
index 0000000..20b9c56
--- /dev/null
+++ b/Documentation/admin-guide/ufs.rst
@@ -0,0 +1,48 @@
+=========
+USING UFS
+=========
+
+mount -t ufs -o ufstype=type_of_ufs device dir
+
+UFS OPTIONS
+===========
+
+ufstype=type_of_ufs
+ UFS is a file system widely used in different operating systems.
+ The problem are differences among implementations. Features of
+ some implementations are undocumented, so its hard to recognize
+ type of ufs automatically. That's why user must specify type of
+ ufs manually by mount option ufstype. Possible values are:
+
+ **old** old format of ufs default value, supported as read-only
+
+ **44bsd** used in FreeBSD, NetBSD, OpenBSD supported as read-write
+
+ **ufs2** used in FreeBSD 5.x supported as read-write
+
+ **5xbsd** synonym for ufs2
+
+ **sun** used in SunOS (Solaris) supported as read-write
+
+ **sunx86** used in SunOS for Intel (Solarisx86) supported as read-write
+
+ **hp** used in HP-UX supported as read-only
+
+ **nextstep** used in NextStep supported as read-only
+
+ **nextstep-cd** used for NextStep CDROMs (block_size == 2048) supported as read-only
+
+ **openstep** used in OpenStep supported as read-only
+
+
+POSSIBLE PROBLEMS
+-----------------
+
+See next section, if you have any.
+
+
+BUG REPORTS
+-----------
+
+Any ufs bug report you can send to daniel.pirkl@email.cz or
+to dushistov@mail.ru (do not send partition tables bug reports).
diff --git a/Documentation/filesystems/ufs.txt b/Documentation/filesystems/ufs.txt
deleted file mode 100644
index 7a602ad..0000000
--- a/Documentation/filesystems/ufs.txt
+++ /dev/null
@@ -1,60 +0,0 @@
-USING UFS
-=========
-
-mount -t ufs -o ufstype=type_of_ufs device dir
-
-
-UFS OPTIONS
-===========
-
-ufstype=type_of_ufs
- UFS is a file system widely used in different operating systems.
- The problem are differences among implementations. Features of
- some implementations are undocumented, so its hard to recognize
- type of ufs automatically. That's why user must specify type of
- ufs manually by mount option ufstype. Possible values are:
-
- old old format of ufs
- default value, supported as read-only
-
- 44bsd used in FreeBSD, NetBSD, OpenBSD
- supported as read-write
-
- ufs2 used in FreeBSD 5.x
- supported as read-write
-
- 5xbsd synonym for ufs2
-
- sun used in SunOS (Solaris)
- supported as read-write
-
- sunx86 used in SunOS for Intel (Solarisx86)
- supported as read-write
-
- hp used in HP-UX
- supported as read-only
-
- nextstep
- used in NextStep
- supported as read-only
-
- nextstep-cd
- used for NextStep CDROMs (block_size == 2048)
- supported as read-only
-
- openstep
- used in OpenStep
- supported as read-only
-
-
-POSSIBLE PROBLEMS
-=================
-
-See next section, if you have any.
-
-
-BUG REPORTS
-===========
-
-Any ufs bug report you can send to daniel.pirkl@email.cz or
-to dushistov@mail.ru (do not send partition tables bug reports).
--
2.7.4
next prev parent reply other threads:[~2019-07-10 3:45 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-07 1:39 [Linux-kernel-mentees] [PATCH] Documentation: filesystems: Convert ufs.txt to reStructuredText format Shobhit Kukreti
2019-07-10 3:42 ` Shobhit Kukreti [this message]
2019-07-10 12:26 ` [PATCH v2] " Mauro Carvalho Chehab
2019-07-10 15:31 ` [PATCH v3] " Shobhit Kukreti
2019-07-10 15:58 ` Mauro Carvalho Chehab
2019-07-31 19:10 ` Jonathan Corbet
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=1562730162-2116-1-git-send-email-shobhitkukreti@gmail.com \
--to=shobhitkukreti@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.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).