Documentation: filesystems: Convert ufs.txt to reStructuredText format
authorShobhit Kukreti <shobhitkukreti@gmail.com>
Wed, 10 Jul 2019 15:31:23 +0000 (08:31 -0700)
committerJonathan Corbet <corbet@lwn.net>
Wed, 31 Jul 2019 19:09:55 +0000 (13:09 -0600)
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>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/admin-guide/index.rst
Documentation/admin-guide/ufs.rst [new file with mode: 0644]
Documentation/filesystems/ufs.txt [deleted file]

index 2376cb91b83cb5cea8ff180f404a225b0a9e53b9..592107a3295f111bfc6739d120944fc2a34d8776 100644 (file)
@@ -79,6 +79,7 @@ configure specific aspects of kernel behavior to your liking.
    binderfs
    xfs
    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 (file)
index 0000000..55d1529
--- /dev/null
@@ -0,0 +1,68 @@
+=========
+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 (file)
index 7a602ad..0000000
+++ /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).