Skip to contentSkip to conversation

Documentation: filesystems: convert vfat.txt to RST

PATCH Superseded Daniel W. S. Almeida 3 participants 4 messages Nov 21, 2019 – Dec 20, 2019

Subsystems (2)

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Documentation: filesystems: convert vfat.txt to RST

From: "Daniel W. S. Almeida" <[email protected]>

Converts vfat.txt to the reStructuredText format, improving presentation without changing the underlying content.

-----------------------------------------------------------
Changes in v2:
Refactored long lines as pointed out by Jonathan Copied the maintainer
Updated the reference in the MAINTAINERS file for vfat

I did not move this into admin-guide, waiting on what the maintainer has to say about this and also about old sections in the text, if any.

---
 Documentation/filesystems/index.rst |   1 +
 Documentation/filesystems/vfat.rst  | 393 ++++++++++++++++++++++++++++
 Documentation/filesystems/vfat.txt  | 347 ------------------------
 MAINTAINERS                         |   2 +-
 4 files changed, 395 insertions(+), 348 deletions(-)
 create mode 100644 Documentation/filesystems/vfat.rst
 delete mode 100644 Documentation/filesystems/vfat.txt
Documentation/filesystems/index.rst +1 -0
index 2c3a9f761205..aaffaa9042c3 100644
@@ -47,3 +47,4 @@ Documentation for filesystem implementations.
    :maxdepth: 2
 
    virtiofs
+   vfat
Documentation/filesystems/vfat.rst new file +393 -0

393 lines not on this page · raw message

Documentation/filesystems/vfat.txt deleted +0 -347

347 lines not on this page · raw message

MAINTAINERS +1 -1
index 2a427d1e9f01..60a1b05c46a0 100644
@@ -17104,7 +17104,7 @@ F:	drivers/mtd/nand/raw/vf610_nfc.c
 VFAT/FAT/MSDOS FILESYSTEM
 M:	OGAWA Hirofumi <[email protected]>
 S:	Maintained
-F:	Documentation/filesystems/vfat.txt
+F:	Documentation/filesystems/vfat.rst
 F:	fs/fat/
 
 VFIO DRIVER
Signature · 1 line
2.24.0
maintainer
#1 lore raw
Quoted 12 lines · On Thu, 21 Nov 2019 10:06:05 -0300 "Daniel W. S. Almeida"…

From: "Daniel W. S. Almeida" <[email protected]>

Converts vfat.txt to the reStructuredText format, improving presentation without changing the underlying content.

-----------------------------------------------------------
Changes in v2:
Refactored long lines as pointed out by Jonathan Copied the maintainer
Updated the reference in the MAINTAINERS file for vfat

Quoted 3 lines

I did not move this into admin-guide, waiting on what the maintainer has to say about this and also about old sections in the text, if any.

This one, too, could user a bit less markup, and more consistent markup. If you have to mark up literal text, for example, it should be ``literal``, not *emphasis*. But please think about whether it needs marking up at all.

I have one other thing here, that could use input from the vfat maintainer:

[...]

Quoted 6 lines
Documentation/filesystems/vfat.rst new file +6 -0
+BUG REPORTS
+===========
+If you have trouble with the *VFAT* filesystem, mail bug reports to
[email protected].
+
+Please specify the filename and the operation that gave you trouble.

Documentation/filesystems/vfat.rst line 266

Quoted 10 lines
Documentation/filesystems/vfat.rst new file +10 -0
+
+TEST SUITE
+==========
+If you plan to make any modifications to the vfat filesystem, please
+get the test suite that comes with the vfat distribution at
+
+`<http://web.archive.org/web/*/http://bmrc.berkeley.edu/people/chaffee/vfat.html>`_
+
+This tests quite a few parts of the vfat filesystem and additional
+tests for new features or untested features would be appreciated.

What are the chances that the above email address works at all, especially given that the associated web page has to be dug out of the wayback machine? We should really try to avoid perpetuating obviously wrong information when we can. Hirofumi, do you have any thoughts on what might replace this section?

Thanks,

jon

#2 lore raw

Hey Jonathan,

This is also pending.

Quoted 3 lines

I did not move this into admin-guide, waiting on what the maintainer has to say about this and also about old sections in the text, if any.

....

Quoted 26 lines

I have one other thing here, that could use input from the vfat maintainer:

[...]

Quoted 6 lines
Documentation/filesystems/vfat.rst new file +6 -0
+BUG REPORTS
+===========
+If you have trouble with the*VFAT*  filesystem, mail bug reports to
[email protected].
+
+Please specify the filename and the operation that gave you trouble.

Documentation/filesystems/vfat.rst line 266

Quoted 10 lines
Documentation/filesystems/vfat.rst new file +10 -0
+
+TEST SUITE
+==========
+If you plan to make any modifications to the vfat filesystem, please
+get the test suite that comes with the vfat distribution at
+
+`<http://web.archive.org/web/*/http://bmrc.berkeley.edu/people/chaffee/vfat.html>`_
+
+This tests quite a few parts of the vfat filesystem and additional
+tests for new features or untested features would be appreciated.

What are the chances that the above email address works at all, especially given that the associated web page has to be dug out of the wayback machine? We should really try to avoid perpetuating obviously wrong information when we can. Hirofumi, do you have any thoughts on what might replace this section?

Quoted 3 lines

Thanks,

jon

Thanks!

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

maintainer
#3 lore raw
In reply to Jonathan Corbet
Quoted 19 lines · Jonathan Corbet
Quoted 12 lines · On Thu, 21 Nov 2019 10:06:05 -0300 "Daniel W. S. Almeida"…

From: "Daniel W. S. Almeida" <[email protected]>

Converts vfat.txt to the reStructuredText format, improving presentation without changing the underlying content.

-----------------------------------------------------------
Changes in v2:
Refactored long lines as pointed out by Jonathan Copied the maintainer
Updated the reference in the MAINTAINERS file for vfat

Quoted 3 lines

I did not move this into admin-guide, waiting on what the maintainer has to say about this and also about old sections in the text, if any.

Quoted 5 lines

This one, too, could user a bit less markup, and more consistent markup. If you have to mark up literal text, for example, it should be ``literal``, not *emphasis*. But please think about whether it needs marking up at all.

I have one other thing here, that could use input from the vfat maintainer:

Sorry, I have very small knowledge in Documentation stuff. So I was thinking no need my input...

I don't know what markup is proper here. My opinion would be, let's make it be consistent with other Documents/*.

Quoted 14 lines
Quoted 14 lines
Documentation/filesystems/vfat.rst new file +14 -0
+BUG REPORTS
+===========
+If you have trouble with the *VFAT* filesystem, mail bug reports to
[email protected].
+
+Please specify the filename and the operation that gave you trouble.
+
+TEST SUITE
+==========
+If you plan to make any modifications to the vfat filesystem, please
+get the test suite that comes with the vfat distribution at
+
+`<http://web.archive.org/web/*/http://bmrc.berkeley.edu/people/chaffee/vfat.html>`_
+
Quoted 8 lines

Documentation/filesystems/vfat.rst line 266

Quoted 2 lines
Documentation/filesystems/vfat.rst new file +2 -0
+This tests quite a few parts of the vfat filesystem and additional
+tests for new features or untested features would be appreciated.

What are the chances that the above email address works at all, especially given that the associated web page has to be dug out of the wayback machine? We should really try to avoid perpetuating obviously wrong information when we can. Hirofumi, do you have any thoughts on what might replace this section?

Those sections are so long years didn't work, IIRC. So IMHO, we can remove those simply. The address for bug report would work from MAINTAINER, lkml as usual, and even bugzilla.

Thanks.

Signature · 1 line
OGAWA Hirofumi <[email protected]>