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

Changbin Du
2019-05-12T12:50:30Z

Hi all,

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!

v2: trivial style update.
v3: update titles. (Bjorn Helgaas)
v4: fix comments from Mauro Carvalho Chehab

Changbin Du (12):
Documentation: add Linux PCI to Sphinx TOC tree
Documentation: PCI: convert pci.txt to reST
Documentation: PCI: convert PCIEBUS-HOWTO.txt to reST
Documentation: PCI: convert pci-iov-howto.txt to reST
Documentation: PCI: convert MSI-HOWTO.txt to reST
Documentation: PCI: convert acpi-info.txt to reST
Documentation: PCI: convert pci-error-recovery.txt to reST
Documentation: PCI: convert pcieaer-howto.txt to reST
Documentation: PCI: convert endpoint/pci-endpoint.txt to reST
Documentation: PCI: convert endpoint/pci-endpoint-cfs.txt to reST
Documentation: PCI: convert endpoint/pci-test-function.txt to reST
Documentation: PCI: convert endpoint/pci-test-howto.txt to reST

.../PCI/{acpi-info.txt => acpi-info.rst} | 15 +-
Documentation/PCI/endpoint/index.rst | 13 +
...-endpoint-cfs.txt => pci-endpoint-cfs.rst} | 99 ++---
.../{pci-endpoint.txt => pci-endpoint.rst} | 96 +++--
...est-function.txt => pci-test-function.rst} | 34 +-
...{pci-test-howto.txt => pci-test-howto.rst} | 81 ++--
Documentation/PCI/index.rst | 18 +
.../PCI/{MSI-HOWTO.txt => msi-howto.rst} | 85 +++--
...or-recovery.txt => pci-error-recovery.rst} | 287 +++++++-------
.../{pci-iov-howto.txt => pci-iov-howto.rst} | 161 ++++----
Documentation/PCI/{pci.txt => pci.rst} | 356 ++++++++----------
.../{pcieaer-howto.txt => pcieaer-howto.rst} | 156 +++++---
.../{PCIEBUS-HOWTO.txt => picebus-howto.rst} | 140 ++++---
Documentation/index.rst | 1 +
MAINTAINERS | 2 +-
include/linux/mod_devicetable.h | 19 +
include/linux/pci.h | 37 ++
17 files changed, 912 insertions(+), 688 deletions(-)
rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (96%)
create mode 100644 Documentation/PCI/endpoint/index.rst
rename Documentation/PCI/endpoint/{pci-endpoint-cfs.txt => pci-endpoint-cfs.rst} (64%)
rename Documentation/PCI/endpoint/{pci-endpoint.txt => pci-endpoint.rst} (82%)
rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (84%)
rename Documentation/PCI/endpoint/{pci-test-howto.txt => pci-test-howto.rst} (78%)
create mode 100644 Documentation/PCI/index.rst
rename Documentation/PCI/{MSI-HOWTO.txt => msi-howto.rst} (88%)
rename Documentation/PCI/{pci-error-recovery.txt => pci-error-recovery.rst} (67%)
rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (63%)
rename Documentation/PCI/{pci.txt => pci.rst} (68%)
rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (72%)
rename Documentation/PCI/{PCIEBUS-HOWTO.txt => picebus-howto.rst} (70%)

--
2.20.1