lkml.org 
[lkml]   [2020]   [Mar]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 0/2] Documentation: Convert sysfs-pci to ReST
On Tue, 31 Mar 2020 19:28:55 -0300
Vitor Massaru Iha <vitor@massaru.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

\
 
 \ /
  Last update: 2020-04-01 00:50    [W:0.061 / U:5.400 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site