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

From: Bjorn Helgaas
Date: Tue Apr 02 2019 - 14:07:52 EST


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@xxxxxxxxxx>
> >
> > 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