Re: [Linux-kernel-mentees] [PATCH v4] Documentation: filesystems: convert fuse to RST

[Jonathan Corbet <corbet@lwn.net>]

On Tue, 31 Dec 2019 15:51:10 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:

> From: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
> 
> Converts fuse.txt to reStructuredText format, improving the presentation
> without changing much of the underlying content.
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>

So I note that the last non-typo-fix change to this document happened in
2006, which leads me to suspect that it might be just a wee bit out of
date.  Miklos, what's the story here?  Should we put a warning at the top?

Otherwise I really only have one other comment on the conversion...


>  .../filesystems/{fuse.txt => fuse.rst}        | 174 ++++++++----------
>  Documentation/filesystems/index.rst           |   1 +
>  MAINTAINERS                                   |   2 +-
>  3 files changed, 80 insertions(+), 97 deletions(-)
>  rename Documentation/filesystems/{fuse.txt => fuse.rst} (79%)
> 
> diff --git a/Documentation/filesystems/fuse.txt b/Documentation/filesystems/fuse.rst
> similarity index 79%
> rename from Documentation/filesystems/fuse.txt
> rename to Documentation/filesystems/fuse.rst
> index 13af4a49e7db..aa7d6f506b8d 100644
> --- a/Documentation/filesystems/fuse.txt
> +++ b/Documentation/filesystems/fuse.rst
> @@ -1,41 +1,39 @@
> -Definitions
> -~~~~~~~~~~~
> +==============
> +FUSE
> +==============
>  
> -Userspace filesystem:
> +Definitions
> +===========
>  
> +``Userspace filesystem:``
>    A filesystem in which data and metadata are provided by an ordinary
>    userspace process.  The filesystem can be accessed normally through
>    the kernel interface.

I think that ``literal text`` should really only be used for literal text -
something that the user types, function names, etc.  Here you're defining a
term, which is different.  You could use **emphasis** as you have in other
places, but I also honestly think it doesn't need special markup at all.

Thanks,

jon
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees