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 1/2] Documentation: filesystems: Convert sysfs-pci to ReST
Date: Tue, 31 Mar 2020 16:57:07 -0600	[thread overview]
Message-ID: <20200331165707.7c708646@lwn.net> (raw)
In-Reply-To: <637c0379a76fcf4eb6cdde0de3cc727203fd942f.1585693146.git.vitor@massaru.org>

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

> Signed-off-by: Vitor Massaru Iha <vitor@massaru.org>
> ---
>  .../{sysfs-pci.txt => sysfs-pci.rst}          | 40 ++++++++++---------
>  1 file changed, 22 insertions(+), 18 deletions(-)
>  rename Documentation/filesystems/{sysfs-pci.txt => sysfs-pci.rst} (82%)

Please supply a changelog with your patches.

The conversion you have done in this file is incomplete; I suspect that
you have not actually built the docs and seen what the results look like.
There are literal blocks that you have not marked as such, as a minimum.
Please actually do a docs build (after adding this file to index.rst) and
make sure that the output is what you intended.

One other thing of note...this file dates back to before the Git era, and
while it has seen numerous tweaks since then, it's clearly outdated.  Look
at what's actually under /sys/devices/pci* compared to what's documented.
I will take the conversion without it, but what I would really like to see
would be an effort to document all of the attributes that appear there
with current kernels.

Thanks,

jon

  reply	other threads:[~2020-03-31 22:57 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 [this message]
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 ` [PATCH 0/2] Documentation: Convert sysfs-pci to ReST Jonathan Corbet
2020-04-01  2:00   ` 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=20200331165707.7c708646@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).