linux-kernel - Re: [PATCH 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190402180744.GD141706@google.com>
Date:   Tue, 2 Apr 2019 13:07:44 -0500
From:   Bjorn Helgaas <helgaas@...nel.org>
To:     Changbin Du <changbin.du@...il.com>
Cc:     Jonathan Corbet <corbet@....net>, linux-pci@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 00/12] Include linux PCI docs into Sphinx TOC tree

On Tue, Apr 02, 2019 at 11:08:54PM +0800, Changbin Du wrote:
> On Mon, Apr 01, 2019 at 06:03:21PM -0500, Bjorn Helgaas wrote:
> > On Sat, Mar 30, 2019 at 12:04:01AM +0800, Changbin Du wrote:
> > > Changbin Du (12):
> > >   Documentation: add Linux PCI to Sphinx TOC tree
> > >   pci doc: convert PCI/pci.txt to rst format
> > >   pci doc: convert PCI/PCIEBUS-HOWTO.txt to rst format
> > >   pci doc: convert PCI/pci-iov-howto.txt to rst format
> > >   pci doc: convert PCI/MSI-HOWTO.txt to rst format
> > >   pci doc: convert PCI/acpi-info.txt to rst format
> > >   pci doc: convert PCI/pci-error-recovery.txt to rst format
> > >   pci doc: convert PCI/pcieaer-howto.txt to rst format
> > >   pci doc: convert PCI/endpoint/pci-endpoint.txt to rst format
> > >   pci doc: convert PCI/endpoint/pci-endpoint-cfs.txt to rst format
> > >   pci doc: convert PCI/endpoint/pci-test-function.txt to rst format
> > >   pci doc: convert PCI/endpoint/pci-test-howto.txt to rst format
> > 
> > Thanks for doing all this work!
> > 
> > Acked-by: Bjorn Helgaas <bhelgaas@...gle.com>
> > 
> > There's not a real convention yet for subject lines in Documentation/,
> > but I would propose:
> > 
> >   Documentation: PCI: Convert pci.txt to reST
> >   Documentation: PCI: Convert endpoint/pci-endpoint.txt to reST
> > 
> > because that at least goes with some recent Documentation/PCI changes
> > and it identifies "reST" as something other than a plain English word
> > (RST or ReST would also work for me).
> > 
> I agree. I am just a little lazy to update all of them this time :)
> Thanks for your ACK!

Well, I guess I'm too lazy to fix them all for you, so I personally
wouldn't apply these.  But maybe Jonathan will be more accommodating.

Bjorn