Documentation: filesystems: Convert ufs.txt to reStructuredText format
PATCH 1/1 Documentation: filesystems: Convert ufs.txt to reStructuredText format
This converts the plain text documentation of ufs.txt to reStructuredText format. Added to documentation build process and verified with make htmldocs
--- 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
Documentation/filesystems/index.rst +1 -0
@@ -42,3 +42,4 @@ Documentation for individual filesystem types can be found here. binderfs.rst jfs + ufs
Documentation/filesystems/ufs.rst new file +65 -0
65 lines not on this page · raw message
Documentation/filesystems/ufs.txt deleted +0 -60
60 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH v2 1/1 Documentation: filesystems: Convert ufs.txt to reStructuredText format
This converts the plain text documentation of ufs.txt to reStructuredText format. Added to documentation build process and verified with make htmldocs
---
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
Documentation/admin-guide/index.rst +1 -0
@@ -71,6 +71,7 @@ configure specific aspects of kernel behavior to your liking. bcache ext4 jfs + ufs pm/index thunderbolt LSM/index
Documentation/admin-guide/ufs.rst new file +48 -0
48 lines not on this page · raw message
Documentation/filesystems/ufs.txt deleted +0 -60
60 lines not on this page · raw message
Signature · 1 line
2.7.4
Em Tue, 9 Jul 2019 20:42:42 -0700
Shobhit Kukreti <shobhitkukreti at gmail.com> escreveu:
Quoted 9 lines
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 at gmail.com>---
Changes in v2:
1. Removed flat-table
2. Movedufs.rstto admin-guide
Quoted 6 lines
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.
Quoted 19 lines
Documentation/admin-guide/index.rst +1
-0@@ -71,6 +71,7 @@ configure specific aspects of kernel behavior to your liking. bcache ext4 jfs + ufs pm/index thunderbolt LSM/indexDocumentation/admin-guide/ufs.rst new file +0
-0
Documentation/admin-guide/ufs.rst line 3
Quoted 3 lines
Documentation/admin-guide/ufs.rst new file +3
-0@@ -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 =========
Documentation/admin-guide/ufs.rst line 8
Quoted 5 lines
Documentation/admin-guide/ufs.rst new file +5
-0+ +mount -t ufs -o ufstype=type_of_ufs device dir + +UFS OPTIONS +===========
Same here:
UFS Options ===========
and so on.
Documentation/admin-guide/ufs.rst line 17
Quoted 9 lines
Documentation/admin-guide/ufs.rst new file +9
-0+ +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
Quoted 87 lines
Documentation/admin-guide/ufs.rst new file +31
-0+ + **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 at email.cz or +to dushistov at mail.ru (do not send partition tables bug reports).Documentation/filesystems/ufs.txt deleted +0
-50@@ -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
Documentation/filesystems/ufs.txt line 60
Quoted 10 lines
Documentation/filesystems/ufs.txt deleted +0
-10-================= - -See next section, if you have any. - - -BUG REPORTS -=========== - -Any ufs bug report you can send to daniel.pirkl at email.cz or -to dushistov at mail.ru (do not send partition tables bug reports).
Thanks,
Mauro
PATCH v3 1/1 Documentation: filesystems: Convert ufs.txt to reStructuredText format
This converts the plain text documentation of ufs.txt to reStructuredText format. Added to documentation build process and verified with make htmldocs
---
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%)Documentation/admin-guide/index.rst +1 -0
@@ -71,6 +71,7 @@ configure specific aspects of kernel behavior to your liking. bcache ext4 jfs + ufs pm/index thunderbolt LSM/index
Documentation/admin-guide/ufs.rst renamed from Documentation/filesystems/ufs.txt +22 -14
@@ -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 daniel.pirkl at email.cz or to dushistov at mail.ru (do not send partition tables bug reports).
Signature · 1 line
2.7.4
Em Wed, 10 Jul 2019 08:31:23 -0700
Shobhit Kukreti <shobhitkukreti at gmail.com> escreveu:
Quoted 5 lines
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 at gmail.com>
Quoted 98 lines
---
Changes in v3:
1. Reverted to minimally changedufs.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. Movedufs.rstto admin-guideDocumentation/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%)Documentation/admin-guide/index.rst +1
-0@@ -71,6 +71,7 @@ configure specific aspects of kernel behavior to your liking. bcache ext4 jfs + ufs pm/index thunderbolt LSM/indexDocumentation/admin-guide/ufs.rst renamed from Documentation/filesystems/ufs.txt +20
-12@@ -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 +-----------------
Documentation/admin-guide/ufs.rst ufstype=type_of_ufs · line 68
Quoted 10 lines
Documentation/admin-guide/ufs.rst renamed from Documentation/filesystems/ufs.txt +2
-2See next section, if you have any. -BUG REPORTS -=========== +Bug Reports +----------- Any ufs bug report you can send to daniel.pirkl at email.cz or to dushistov at mail.ru (do not send partition tables bug reports).
Thanks,
Mauro
Jonathan Corbet
maintainerQuoted 5 lines · On Wed, 10 Jul 2019 08:31:23 -0700 Shobhit Kukreti <shobhitkukreti at…
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 at gmail.com>
I've applied this one as well; apologies for the delay.
jon