linux-pci.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Changbin Du <changbin.du@gmail.com>
To: bhelgaas@google.com, corbet@lwn.net
Cc: linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, mchehab+samsung@kernel.org,
	Changbin Du <changbin.du@gmail.com>
Subject: [PATCH v6 00/12] Include linux PCI docs into Sphinx TOC tree
Date: Tue, 14 May 2019 22:47:22 +0800	[thread overview]
Message-ID: <20190514144734.19760-1-changbin.du@gmail.com> (raw)

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
v5: update MAINTAINERS (Joe Perches)
v6: fix comments.

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}    |  92 +++--
 ...est-function.txt => pci-test-function.rst} |  84 +++--
 ...{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                                   |   4 +-
 include/linux/mod_devicetable.h               |  19 +
 include/linux/pci.h                           |  37 ++
 17 files changed, 938 insertions(+), 710 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} (83%)
 rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (55%)
 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


             reply	other threads:[~2019-05-14 14:49 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-14 14:47 Changbin Du [this message]
2019-05-14 14:47 ` [PATCH v6 01/12] Documentation: add Linux PCI to Sphinx TOC tree Changbin Du
2019-05-14 14:47 ` [PATCH v6 02/12] Documentation: PCI: convert pci.txt to reST Changbin Du
2019-05-14 14:47 ` [PATCH v6 03/12] Documentation: PCI: convert PCIEBUS-HOWTO.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 04/12] Documentation: PCI: convert pci-iov-howto.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 05/12] Documentation: PCI: convert MSI-HOWTO.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 06/12] Documentation: PCI: convert acpi-info.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 07/12] Documentation: PCI: convert pci-error-recovery.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 08/12] Documentation: PCI: convert pcieaer-howto.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 09/12] Documentation: PCI: convert endpoint/pci-endpoint.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 10/12] Documentation: PCI: convert endpoint/pci-endpoint-cfs.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 11/12] Documentation: PCI: convert endpoint/pci-test-function.txt " Changbin Du
2019-05-14 14:47 ` [PATCH v6 12/12] Documentation: PCI: convert endpoint/pci-test-howto.txt " Changbin Du
2022-07-05 22:24   ` Bjorn Helgaas
2019-05-20  6:10 ` [PATCH v6 00/12] Include linux PCI docs into Sphinx TOC tree Changbin Du
2019-05-20 14:23   ` Mauro Carvalho Chehab
2019-05-20 15:05     ` Changbin Du
2019-05-29 22:35   ` Jonathan Corbet
2019-05-30  2:56     ` Bjorn Helgaas
2019-05-30  3:01     ` Bjorn Helgaas
2019-05-30 13:04       ` Bjorn Helgaas

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190514144734.19760-1-changbin.du@gmail.com \
    --to=changbin.du@gmail.com \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=mchehab+samsung@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).