Re: [PATCH 1/2] Documentation: filesystems: Convert sysfs-pci to ReST

From: Vitor Massaru Iha
Date: Tue Mar 31 2020 - 19:03:56 EST


On Tue, 2020-03-31 at 16:57 -0600, Jonathan Corbet wrote:
> On Tue, 31 Mar 2020 19:28:56 -0300
> Vitor Massaru Iha <vitor@xxxxxxxxxxx> wrote:
>
> > Signed-off-by: Vitor Massaru Iha <vitor@xxxxxxxxxxx>
> > ---
> > .../{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

Thanks for the review, I will check your comments and correct themif that document is still needed.

BR,
Vitor