linux-kernel - Re: [RFC PATCH] Documentation: filesystems: convert fuse to RST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20191112085516.15ed4b1a@lwn.net>
Date:   Tue, 12 Nov 2019 08:55:16 -0700
From:   Jonathan Corbet <corbet@....net>
To:     "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        skhan@...uxfoundation.org,
        linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [RFC PATCH] Documentation: filesystems: convert fuse to RST

On Fri,  8 Nov 2019 13:46:19 -0300
"Daniel W. S. Almeida" <dwlsalmeida@...il.com> wrote:

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

This generally looks like a good conversion, thanks!  That said, I have a
few small comments...

 - You should copy the FUSE maintainer on this change.  You can find the
   relevant information in the MAINTAINERS file or with
   get_maintainer.pl.

 - Speaking of MAINTAINERS, you also need to fix the reference to
   fuse.txt there when you rename the file.

 - You are reasonably well restrained in your use of markup, but it would
   be good to pull back just a bit more.  Just FUSE everywhere rather than
   ``FUSE`` in some places.  Less **emphasis**.  Remember that the
   readability of the plain-text file is important.

 - This file contains information that is useful to system
   administrators, so I think that a move to admin-guide would be
   warranted.

Thanks,

jon