linux-kernel - Re: [PATCH v2 00/12] Include linux PCI docs into Sphinx TOC tree

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

Message-ID: <20190403132305.41e6e185@lwn.net>
Date:   Wed, 3 Apr 2019 13:23:05 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Changbin Du <changbin.du@...il.com>
Cc:     Bjorn Helgaas <bhelgaas@...gle.com>, linux-pci@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 00/12] Include linux PCI docs into Sphinx TOC tree

On Wed,  3 Apr 2019 23:49:43 +0800
Changbin Du <changbin.du@...il.com> wrote:

> The kernel now uses Sphinx to generate intelligent and beautiful documentation
> from reStructuredText files. I converted most of the Linux PCI docs to rst
> format in this serias.
> 
> For you to preview, please visit below url:
> http://www.bytemem.com:8080/kernel-doc/PCI/index.html
> 
> Thank you!

So I have the same comment that I had with regard to the ACPI set: I would
really rather not clutter the top level of the doc tree with this.  In
this case the resolution is a lot simpler, though: everything here seems
suitable for the driver API guide.  Could you please redo the patch set to
place the docs there?

Reflecting Bjorn's comment on the title lines and adding his ack would be
a nice touch while you're at it.

Thanks for doing this work - this one's almost there, I think.

jon