linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Vitor Massaru Iha <vitor@massaru.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	brendanhiggins@google.com, skhan@linuxfoundation.org,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH 0/2] Documentation: Convert sysfs-pci to ReST
Date: Tue, 31 Mar 2020 16:49:56 -0600	[thread overview]
Message-ID: <20200331164956.0e10b87e@lwn.net> (raw)
In-Reply-To: <cover.1585693146.git.vitor@massaru.org>

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

  parent reply	other threads:[~2020-03-31 22:50 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-31 22:28 [PATCH 0/2] Documentation: Convert sysfs-pci to ReST Vitor Massaru Iha
2020-03-31 22:28 ` [PATCH 1/2] Documentation: filesystems: " Vitor Massaru Iha
2020-03-31 22:57   ` Jonathan Corbet
2020-03-31 23:03     ` Vitor Massaru Iha
2020-03-31 23:08       ` Jonathan Corbet
2020-04-01  2:33     ` [Linux-kernel-mentees] " Bjorn Helgaas
2020-04-01 17:22       ` Vitor Massaru Iha
2020-04-01  0:04   ` Matthew Wilcox
2020-04-01  0:08     ` Vitor Massaru Iha
2020-03-31 22:28 ` [PATCH 2/2] Documentation: filesystems: remove whitespaces Vitor Massaru Iha
2020-03-31 22:49 ` Jonathan Corbet [this message]
2020-04-01  2:00   ` [PATCH 0/2] Documentation: Convert sysfs-pci to ReST Joe Perches

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200331164956.0e10b87e@lwn.net \
    --to=corbet@lwn.net \
    --cc=brendanhiggins@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=vitor@massaru.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).