Re: [Linux-kernel-mentees] [PATCH v2] Documentation: filesystems: convert vfat.txt to RST

From: Jonathan Corbet <corbet@lwn.net>
To: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
	linux-kernel@vger.kernel.org, hirofumi@mail.parknet.co.jp,
	linux-doc@vger.kernel.org
Subject: Re: [Linux-kernel-mentees] [PATCH v2] Documentation: filesystems: convert vfat.txt to RST
Date: Thu, 19 Dec 2019 10:00:25 -0700	[thread overview]
Message-ID: <20191219100025.255003e6@lwn.net> (raw)
In-Reply-To: <20191121130605.29074-1-dwlsalmeida@gmail.com>

On Thu, 21 Nov 2019 10:06:05 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Converts vfat.txt to the reStructuredText format, improving presentation
> without changing the underlying content.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
> -----------------------------------------------------------
> 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.

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:

[...]

> +BUG REPORTS
> +===========
> +If you have trouble with the *VFAT* filesystem, mail bug reports to
> +chaffee@bmrc.cs.berkeley.edu.
> +
> +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>`_
> +
> +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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees