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 <[email protected]>
---
Documentation/filesystems/index.rst | 1 +
Documentation/filesystems/ufs.rst | 65 +++++++++++++++++++++++++++++++++++++
Documentation/filesystems/ufs.txt | 60 ----------------------------------
3 files changed, 66 insertions(+), 60 deletions(-)
create mode 100644 Documentation/filesystems/ufs.rst
delete mode 100644 Documentation/filesystems/ufs.txt
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index d700330..2b4f870 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -42,3 +42,4 @@ Documentation for individual filesystem types can be found here.
binderfs.rst
jfs
+ ufs
diff --git a/Documentation/filesystems/ufs.rst b/Documentation/filesystems/ufs.rst
new file mode 100644
index 0000000..d6aeef0
--- /dev/null
+++ b/Documentation/filesystems/ufs.rst
@@ -0,0 +1,65 @@
+=========
+USING UFS
+=========
+
+mount -t ufs -o ufstype=type_of_ufs device dir
+
+UFS OPTIONS
+===========
+
+.. tabularcolumns:: |p{0.5cm}|p{0.5cm}|p{8.0cm}|
+
+.. cssclass:: longtable
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+ * - :rspan:`10` 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 below.
+
+ * - 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 [email protected] or
+to [email protected] (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 [email protected] or
-to [email protected] (do not send partition tables bug reports).
--
2.7.4
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 <[email protected]>
---
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 [email protected] or
+to [email protected] (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 [email protected] or
-to [email protected] (do not send partition tables bug reports).
--
2.7.4
Em Tue, 9 Jul 2019 20:42:42 -0700
Shobhit Kukreti <[email protected]> escreveu:
> 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 <[email protected]>
> ---
> 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
please use -M1 when producing the diff, in order to show it as as a change
and not as a delete/create.
>
> 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
> +=========
In order to make it more coherent with the other documents, please
capitalize the titles, e. g.:
=========
Using UFS
=========
> +
> +mount -t ufs -o ufstype=type_of_ufs device dir
> +
> +UFS OPTIONS
> +===========
Same here:
UFS Options
===========
and so on.
> +
> +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
Please avoid adding markups where not needed. In this specific case,
the best would be, instead, to use:
old
old format of ufs
default value, supported as read-only
...
openstep
used in OpenStep
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 [email protected] or
> +to [email protected] (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 [email protected] or
> -to [email protected] (do not send partition tables bug reports).
Thanks,
Mauro
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 <[email protected]>
---
Changes in v3:
1. Reverted to minimally changed ufs.rst
2. Fix Minor Space Issues
3. Used -M1 in git format-patch to show files as renamed
Changes in v2:
1. Removed flat-table
2. Moved ufs.rst to admin-guide
Documentation/admin-guide/index.rst | 1 +
.../{filesystems/ufs.txt => admin-guide/ufs.rst} | 36 +++++++++++++---------
2 files changed, 23 insertions(+), 14 deletions(-)
rename Documentation/{filesystems/ufs.txt => admin-guide/ufs.rst} (69%)
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/filesystems/ufs.txt b/Documentation/admin-guide/ufs.rst
similarity index 69%
rename from Documentation/filesystems/ufs.txt
rename to Documentation/admin-guide/ufs.rst
index 7a602ad..55d1529 100644
--- a/Documentation/filesystems/ufs.txt
+++ b/Documentation/admin-guide/ufs.rst
@@ -1,37 +1,45 @@
-USING UFS
+=========
+Using UFS
=========
mount -t ufs -o ufstype=type_of_ufs device dir
-UFS OPTIONS
+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
+ 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
+ old
+ old format of ufs
default value, supported as read-only
- 44bsd used in FreeBSD, NetBSD, OpenBSD
+ 44bsd
+ used in FreeBSD, NetBSD, OpenBSD
supported as read-write
- ufs2 used in FreeBSD 5.x
+ ufs2
+ used in FreeBSD 5.x
supported as read-write
- 5xbsd synonym for ufs2
+ 5xbsd
+ synonym for ufs2
- sun used in SunOS (Solaris)
+ sun
+ used in SunOS (Solaris)
supported as read-write
- sunx86 used in SunOS for Intel (Solarisx86)
+ sunx86
+ used in SunOS for Intel (Solarisx86)
supported as read-write
- hp used in HP-UX
+ hp
+ used in HP-UX
supported as read-only
nextstep
@@ -47,14 +55,14 @@ ufstype=type_of_ufs
supported as read-only
-POSSIBLE PROBLEMS
-=================
+Possible Problems
+-----------------
See next section, if you have any.
-BUG REPORTS
-===========
+Bug Reports
+-----------
Any ufs bug report you can send to [email protected] or
to [email protected] (do not send partition tables bug reports).
--
2.7.4
Em Wed, 10 Jul 2019 08:31:23 -0700
Shobhit Kukreti <[email protected]> escreveu:
> 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 <[email protected]>
Reviewed-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Changes in v3:
> 1. Reverted to minimally changed ufs.rst
> 2. Fix Minor Space Issues
> 3. Used -M1 in git format-patch to show files as renamed
> Changes in v2:
> 1. Removed flat-table
> 2. Moved ufs.rst to admin-guide
>
> Documentation/admin-guide/index.rst | 1 +
> .../{filesystems/ufs.txt => admin-guide/ufs.rst} | 36 +++++++++++++---------
> 2 files changed, 23 insertions(+), 14 deletions(-)
> rename Documentation/{filesystems/ufs.txt => admin-guide/ufs.rst} (69%)
>
> 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/filesystems/ufs.txt b/Documentation/admin-guide/ufs.rst
> similarity index 69%
> rename from Documentation/filesystems/ufs.txt
> rename to Documentation/admin-guide/ufs.rst
> index 7a602ad..55d1529 100644
> --- a/Documentation/filesystems/ufs.txt
> +++ b/Documentation/admin-guide/ufs.rst
> @@ -1,37 +1,45 @@
> -USING UFS
> +=========
> +Using UFS
> =========
>
> mount -t ufs -o ufstype=type_of_ufs device dir
>
>
> -UFS OPTIONS
> +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
> + 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
> + old
> + old format of ufs
> default value, supported as read-only
>
> - 44bsd used in FreeBSD, NetBSD, OpenBSD
> + 44bsd
> + used in FreeBSD, NetBSD, OpenBSD
> supported as read-write
>
> - ufs2 used in FreeBSD 5.x
> + ufs2
> + used in FreeBSD 5.x
> supported as read-write
>
> - 5xbsd synonym for ufs2
> + 5xbsd
> + synonym for ufs2
>
> - sun used in SunOS (Solaris)
> + sun
> + used in SunOS (Solaris)
> supported as read-write
>
> - sunx86 used in SunOS for Intel (Solarisx86)
> + sunx86
> + used in SunOS for Intel (Solarisx86)
> supported as read-write
>
> - hp used in HP-UX
> + hp
> + used in HP-UX
> supported as read-only
>
> nextstep
> @@ -47,14 +55,14 @@ ufstype=type_of_ufs
> supported as read-only
>
>
> -POSSIBLE PROBLEMS
> -=================
> +Possible Problems
> +-----------------
>
> See next section, if you have any.
>
>
> -BUG REPORTS
> -===========
> +Bug Reports
> +-----------
>
> Any ufs bug report you can send to [email protected] or
> to [email protected] (do not send partition tables bug reports).
Thanks,
Mauro
On Wed, 10 Jul 2019 08:31:23 -0700
Shobhit Kukreti <[email protected]> wrote:
> 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 <[email protected]>
I've applied this one as well; apologies for the delay.
jon