Skip to contentSkip to conversation

Doc : fs : convert xfs.txt to ReST

PATCH Superseded Sheriff Esseson 4 participants 7 messages Jul 9, 2019 Documentation

lore
Share & tools
lore

Sheriff Esseson

author
#0 lore raw

Convert xfs.txt to ReST, rename and fix broken references, consequently.

Signed-off-by Sheriff Esseson <sheriffesseson at gmail.com>

---

Changes in v6:
- undo text reflow from v5.
- fix a typo.
- change indication of defaults , as suggested by Darrick J. Wong, to keep the read simple.
- change delimiter of boolean option from a newline to an "or" (clue from something like "<option> and <another option>" in the text) because the former does not render well in html.

 Documentation/filesystems/dax.txt             |   2 +-
 Documentation/filesystems/index.rst           |   1 +
 .../filesystems/{xfs.txt => xfs.rst}          | 123 +++++++++---------
 MAINTAINERS                                   |   2 +-
 4 files changed, 61 insertions(+), 67 deletions(-)
 rename Documentation/filesystems/{xfs.txt => xfs.rst} (81%)
Documentation/filesystems/dax.txt +1 -1
index 6d2c0d340..c333285b8 100644
@@ -76,7 +76,7 @@ exposure of uninitialized data through mmap.
 These filesystems may be used for inspiration:
 - ext2: see Documentation/filesystems/ext2.txt
 - ext4: see Documentation/filesystems/ext4/
-- xfs:  see Documentation/filesystems/xfs.txt
+- xfs:  see Documentation/filesystems/xfs.rst
 
 
 Handling Media Errors
Documentation/filesystems/index.rst +1 -0
index 18da00e75..93e6b8495 100644
@@ -40,3 +40,4 @@ Documentation for individual filesystem types can be found here.
 .. toctree::
    :maxdepth: 2
 
+   xfs
Documentation/filesystems/xfs.rst renamed from Documentation/filesystems/xfs.txt +58 -65

278 lines not on this page · raw message

MAINTAINERS +1 -1
index 558acf24e..0b9c075ca 100644
@@ -17403,7 +17403,7 @@ L:	linux-xfs at vger.kernel.org
 W:	http://xfs.org/
 T:	git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
 S:	Supported
-F:	Documentation/filesystems/xfs.txt
+F:	Documentation/filesystems/xfs.rst
 F:	fs/xfs/
 
 XILINX AXI ETHERNET DRIVER
Signature · 1 line
2.22.0
#1 lore raw
Quoted 1 line · Sheriff Esseson

Convert xfs.txt to ReST, rename and fix broken references, consequently.

The subject line still uses completely b0rked naming conventions.

#2 lore raw

PATCH v6 1/1 Doc : fs : convert xfs.txt to ReST

Quoted 4 lines · Christoph Hellwig
Quoted 1 line · Sheriff Esseson

Convert xfs.txt to ReST, rename and fix broken references, consequently.

The subject line still uses completely b0rked naming conventions.

Sorry, Christoph, for repeating the mistake. I did not know the mailing list auto-inserts the "...mentees..." header in my subject line - I did it manually.

#3 lore raw

PATCH v6 1/1 Doc : fs : convert xfs.txt to ReST

Quoted 8 lines · Sheriff Esseson
Quoted 4 lines · Christoph Hellwig
Quoted 1 line · Sheriff Esseson

Convert xfs.txt to ReST, rename and fix broken references, consequently.

The subject line still uses completely b0rked naming conventions.

Sorry, Christoph, for repeating the mistake. I did not know the mailing list auto-inserts the "...mentees..." header in my subject line - I did it manually.

Now, that is not the problem as that gets stripped away. It is your we?rd use of colons and shortening of Documentation to Doc.

#4 lore raw

PATCH v6 1/1 Doc : fs : convert xfs.txt to ReST

Quoted 5 lines · Christoph Hellwig
Quoted 4 lines · Sheriff Esseson
Quoted 3 lines · Christoph Hellwig
Quoted 1 line · Sheriff Esseson

Convert xfs.txt to ReST, rename and fix broken references, consequently.

Quoted 8 lines
Quoted 4 lines
Quoted 1 line

The subject line still uses completely b0rked naming conventions.

Sorry, Christoph, for repeating the mistake. I did not know the mailing list auto-inserts the "...mentees..." header in my subject line - I did it manually.

Now, that is not the problem as that gets stripped away. It is your we?rd use of colons and shortening of Documentation to Doc.

Oh, *noted*.

Thanks,

Sheriff

#5 lore raw
In reply to Sheriff Esseson
Quoted 14 lines · Sheriff Esseson

Convert xfs.txt to ReST, rename and fix broken references, consequently.

Signed-off-by Sheriff Esseson <sheriffesseson at gmail.com>

---

Changes in v6:
- undo text reflow from v5.
- fix a typo.
- change indication of defaults , as suggested by Darrick J. Wong, to keep the read simple.
- change delimiter of boolean option from a newline to an "or" (clue from something like "<option> and <another option>" in the text) because the former does not render well in html.

Quoted 6 lines
 Documentation/filesystems/dax.txt             |   2 +-
 Documentation/filesystems/index.rst           |   1 +
 .../filesystems/{xfs.txt => xfs.rst}          | 123 +++++++++---------
 MAINTAINERS                                   |   2 +-
 4 files changed, 61 insertions(+), 67 deletions(-)
 rename Documentation/filesystems/{xfs.txt => xfs.rst} (81%)

Documentation/{filesystem/xfs.txt => admin-guide/xfs.rst}.

Documentation/filesystems/xfs.rst default behaviour. · line 108

Quoted 5 lines
Documentation/filesystems/xfs.rst renamed from Documentation/filesystems/xfs.txt +1 -4
-	If "largeio" specified, a filesystem that was created with a
-	"swidth" specified will return the "swidth" value (in bytes)
-	in st_blksize. If the filesystem does not have a "swidth"
-	specified but does specify an "allocsize" then "allocsize"
+	If ``largeio`` specified, a filesystem that was created with a

surely 'If ``largeio`` is specified' here?

Quoted 4 lines
Documentation/filesystems/xfs.rst renamed from Documentation/filesystems/xfs.txt +3 -0
+	``swidth`` specified will return the ``swidth`` value (in bytes)
+	in ``st_blksize``. If the filesystem does not have a ``swidth``
+	specified but does specify an ``allocsize`` then ``allocsize``
 	(in bytes) will be returned instead. Otherwise the behaviour
#6 lore raw

PATCH v6 1/1 Doc : fs : convert xfs.txt to ReST

Quoted 24 lines · Matthew Wilcox
Quoted 14 lines · Sheriff Esseson

Convert xfs.txt to ReST, rename and fix broken references, consequently.

Signed-off-by Sheriff Esseson <sheriffesseson at gmail.com>

---

Changes in v6:
- undo text reflow from v5.
- fix a typo.
- change indication of defaults , as suggested by Darrick J. Wong, to keep the read simple.
- change delimiter of boolean option from a newline to an "or" (clue from something like "<option> and <another option>" in the text) because the former does not render well in html.

Quoted 6 lines
 Documentation/filesystems/dax.txt             |   2 +-
 Documentation/filesystems/index.rst           |   1 +
 .../filesystems/{xfs.txt => xfs.rst}          | 123 +++++++++---------
 MAINTAINERS                                   |   2 +-
 4 files changed, 61 insertions(+), 67 deletions(-)
 rename Documentation/filesystems/{xfs.txt => xfs.rst} (81%)

Documentation/{filesystem/xfs.txt => admin-guide/xfs.rst}.

Quoted 7 lines

Documentation/filesystems/xfs.rst default behaviour. · line 108

Quoted 5 lines
Documentation/filesystems/xfs.rst renamed from Documentation/filesystems/xfs.txt +1 -4
-	If "largeio" specified, a filesystem that was created with a
-	"swidth" specified will return the "swidth" value (in bytes)
-	in st_blksize. If the filesystem does not have a "swidth"
-	specified but does specify an "allocsize" then "allocsize"
+	If ``largeio`` specified, a filesystem that was created with a

surely 'If ``largeio`` is specified' here?

Oops!!! Thanks.

Quoted 5 lines
Quoted 5 lines
Documentation/filesystems/xfs.rst renamed from Documentation/filesystems/xfs.txt +3 -0
+	``swidth`` specified will return the ``swidth`` value (in bytes)
+	in ``st_blksize``. If the filesystem does not have a ``swidth``
+	specified but does specify an ``allocsize`` then ``allocsize``
 	(in bytes) will be returned instead. Otherwise the behaviour