Re: [PATCH v4 25/63] Documentation: add Linux PCI to Sphinx TOC tree

Changbin Du
2019-04-25T15:42:26Z

On Wed, Apr 24, 2019 at 12:03:43PM -0300, Mauro Carvalho Chehab wrote:
> Em Wed, 24 Apr 2019 00:28:54 +0800
> Changbin Du <changbin.du@gmail.com> escreveu:
>
> > Add a index.rst for PCI subsystem. More docs will be added later.
> >
> > Signed-off-by: Changbin Du <changbin.du@gmail.com>
> > Acked-by: Bjorn Helgaas <bhelgaas@google.com>
> > ---
> > Documentation/PCI/index.rst | 9 +++++++++
>
> On a past discussion at docs ML, we've agreed to use lowercase for new
> stuff. My suggestion here would be to use lowercase for "pci".
>
> Also, there's already a pci directory under driver-api, added on this
> commit:
>
> commit fcc78f9c22474d60c65d522e50ea07006ec1b9fc
> Author: Logan Gunthorpe <logang@deltatee.com>
> Date: Thu Oct 4 15:27:39 2018 -0600
>
> docs-rst: Add a new directory for PCI documentation
>
> I would just add a new section at Documentation/driver-api/pci/index.rst
> with something like:
>
> Legacy PCI documentation
> ========================
>
> .. note::
>
> The files here were written a long time ago and need some serious
> work. Use their contents with caution.
>
> .. toctree::
> :maxdepth: 1
>
> <files converted from Documentation/PCI>
>
> And add those documents from Documentation/PCI into it.
>
Bjorn, Jonathan,
Do you agree with this? By this all Documentation/PCI/* will be moved to
Documentation/driver-api/pci.

>
> Thanks,
> Mauro

--
Cheers,
Changbin Du