linux-kernel - Re: [PATCH 0/2] Documentation: Convert sysfs-pci to ReST

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200331164956.0e10b87e@lwn.net>
Date:   Tue, 31 Mar 2020 16:49:56 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Vitor Massaru Iha <vitor@...saru.org>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        brendanhiggins@...gle.com, skhan@...uxfoundation.org,
        linux-kernel-mentees@...ts.linuxfoundation.org
Subject: Re: [PATCH 0/2] Documentation: Convert sysfs-pci to ReST

On Tue, 31 Mar 2020 19:28:55 -0300
Vitor Massaru Iha <vitor@...saru.org> wrote:

> Vitor Massaru Iha (2):
>   Documentation: filesystems: Convert sysfs-pci to ReST
>   Documentation: filesystems: remove whitespaces
> 
>  .../{sysfs-pci.txt => sysfs-pci.rst}          | 44 ++++++++++---------
>  1 file changed, 24 insertions(+), 20 deletions(-)
>  rename Documentation/filesystems/{sysfs-pci.txt => sysfs-pci.rst} (81%)

Thanks for working on the documentation!  I do have a few comments...

The purpose for including a cover letter on a patch series is to explain
what the series as a whole is trying to accomplish.  Without that, it's
not all the helpful.

In this case, there is no real need for a series; just clean up that
trailing whitespace while doing the conversion.  (It *is* normally good
practice to separate such conversions from other changes, but that
particular change is trivial enough that you should just do it while
you're there).

When you convert a file to RST, you need to add it to the index.rst file
as well so that it can be a part of the documentation build.

Thanks,

jon