linux-pci.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v4 00/12] Include linux PCI docs into Sphinx TOC tree
@ 2019-05-12 12:49 Changbin Du
  2019-05-12 12:49 ` [PATCH v4 01/12] Documentation: add Linux PCI to " Changbin Du
                   ` (11 more replies)
  0 siblings, 12 replies; 15+ messages in thread
From: Changbin Du @ 2019-05-12 12:49 UTC (permalink / raw)
  To: bhelgaas, corbet
  Cc: linux-pci, linux-doc, linux-kernel, mchehab+samsung, Changbin Du

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


^ permalink raw reply	[flat|nested] 15+ messages in thread

end of thread, other threads:[~2019-05-13 14:18 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-12 12:49 [PATCH v4 00/12] Include linux PCI docs into Sphinx TOC tree Changbin Du
2019-05-12 12:49 ` [PATCH v4 01/12] Documentation: add Linux PCI to " Changbin Du
2019-05-12 12:49 ` [PATCH v4 02/12] Documentation: PCI: convert pci.txt to reST Changbin Du
2019-05-12 12:50 ` [PATCH v4 03/12] Documentation: PCI: convert PCIEBUS-HOWTO.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 04/12] Documentation: PCI: convert pci-iov-howto.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 05/12] Documentation: PCI: convert MSI-HOWTO.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 06/12] Documentation: PCI: convert acpi-info.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 07/12] Documentation: PCI: convert pci-error-recovery.txt " Changbin Du
2019-05-12 14:22   ` Joe Perches
2019-05-13 14:18     ` Changbin Du
2019-05-12 12:50 ` [PATCH v4 08/12] Documentation: PCI: convert pcieaer-howto.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 09/12] Documentation: PCI: convert endpoint/pci-endpoint.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 10/12] Documentation: PCI: convert endpoint/pci-endpoint-cfs.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 11/12] Documentation: PCI: convert endpoint/pci-test-function.txt " Changbin Du
2019-05-12 12:50 ` [PATCH v4 12/12] Documentation: PCI: convert endpoint/pci-test-howto.txt " Changbin Du

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).