From fcc78f9c22474d60c65d522e50ea07006ec1b9fc Mon Sep 17 00:00:00 2001 From: Logan Gunthorpe Date: Thu, 4 Oct 2018 15:27:39 -0600 Subject: docs-rst: Add a new directory for PCI documentation Add a new directory in the driver API guide for PCI-specific documentation. This is in preparation for adding a new PCI P2P DMA driver writers guide which will go in this directory. Signed-off-by: Logan Gunthorpe Signed-off-by: Bjorn Helgaas Cc: Jonathan Corbet Cc: Mauro Carvalho Chehab Cc: Greg Kroah-Hartman Cc: Vinod Koul Cc: Linus Walleij Cc: Logan Gunthorpe Cc: Thierry Reding Cc: Sanyog Kale Cc: Sagar Dharia --- Documentation/driver-api/index.rst | 2 +- Documentation/driver-api/pci.rst | 47 ---------------------------------- Documentation/driver-api/pci/index.rst | 21 +++++++++++++++ Documentation/driver-api/pci/pci.rst | 47 ++++++++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 48 deletions(-) delete mode 100644 Documentation/driver-api/pci.rst create mode 100644 Documentation/driver-api/pci/index.rst create mode 100644 Documentation/driver-api/pci/pci.rst (limited to 'Documentation/driver-api') diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index 6d9f2f9fe20e..e9e7d24169cf 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -29,7 +29,7 @@ available subsections can be seen below. iio/index input usb/index - pci + pci/index spi i2c hsi diff --git a/Documentation/driver-api/pci.rst b/Documentation/driver-api/pci.rst deleted file mode 100644 index ca85e5e78b2c..000000000000 --- a/Documentation/driver-api/pci.rst +++ /dev/null @@ -1,47 +0,0 @@ -PCI Support Library -------------------- - -.. kernel-doc:: drivers/pci/pci.c - :export: - -.. kernel-doc:: drivers/pci/pci-driver.c - :export: - -.. kernel-doc:: drivers/pci/remove.c - :export: - -.. kernel-doc:: drivers/pci/search.c - :export: - -.. kernel-doc:: drivers/pci/msi.c - :export: - -.. kernel-doc:: drivers/pci/bus.c - :export: - -.. kernel-doc:: drivers/pci/access.c - :export: - -.. kernel-doc:: drivers/pci/irq.c - :export: - -.. kernel-doc:: drivers/pci/probe.c - :export: - -.. kernel-doc:: drivers/pci/slot.c - :export: - -.. kernel-doc:: drivers/pci/rom.c - :export: - -.. kernel-doc:: drivers/pci/iov.c - :export: - -.. kernel-doc:: drivers/pci/pci-sysfs.c - :internal: - -PCI Hotplug Support Library ---------------------------- - -.. kernel-doc:: drivers/pci/hotplug/pci_hotplug_core.c - :export: diff --git a/Documentation/driver-api/pci/index.rst b/Documentation/driver-api/pci/index.rst new file mode 100644 index 000000000000..36633fb96771 --- /dev/null +++ b/Documentation/driver-api/pci/index.rst @@ -0,0 +1,21 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================================ +The Linux PCI driver implementer's API guide +============================================ + +.. class:: toc-title + + Table of contents + +.. toctree:: + :maxdepth: 2 + + pci + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/driver-api/pci/pci.rst b/Documentation/driver-api/pci/pci.rst new file mode 100644 index 000000000000..ca85e5e78b2c --- /dev/null +++ b/Documentation/driver-api/pci/pci.rst @@ -0,0 +1,47 @@ +PCI Support Library +------------------- + +.. kernel-doc:: drivers/pci/pci.c + :export: + +.. kernel-doc:: drivers/pci/pci-driver.c + :export: + +.. kernel-doc:: drivers/pci/remove.c + :export: + +.. kernel-doc:: drivers/pci/search.c + :export: + +.. kernel-doc:: drivers/pci/msi.c + :export: + +.. kernel-doc:: drivers/pci/bus.c + :export: + +.. kernel-doc:: drivers/pci/access.c + :export: + +.. kernel-doc:: drivers/pci/irq.c + :export: + +.. kernel-doc:: drivers/pci/probe.c + :export: + +.. kernel-doc:: drivers/pci/slot.c + :export: + +.. kernel-doc:: drivers/pci/rom.c + :export: + +.. kernel-doc:: drivers/pci/iov.c + :export: + +.. kernel-doc:: drivers/pci/pci-sysfs.c + :internal: + +PCI Hotplug Support Library +--------------------------- + +.. kernel-doc:: drivers/pci/hotplug/pci_hotplug_core.c + :export: -- cgit