linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Changbin Du <changbin.du@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
	linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, Changbin Du <changbin.du@gmail.com>
Subject: [PATCH 00/12] Include linux PCI docs into Sphinx TOC tree
Date: Sat, 30 Mar 2019 00:04:01 +0800	[thread overview]
Message-ID: <20190329160413.4293-1-changbin.du@gmail.com> (raw)

Hi Corbet,
I also did the conversion for PCI documentation. Please check, Thanks!

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://104.238.181.70:8080/kernel-doc/PCI/index.html

Thank you!

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

 .../PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst}      |  56 +++--
 .../{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst}  | 112 +++++----
 .../PCI/{acpi-info.txt => acpi-info.rst}      |  11 +-
 Documentation/PCI/endpoint/index.rst          |  13 ++
 ...-endpoint-cfs.txt => pci-endpoint-cfs.rst} |  99 ++++----
 .../{pci-endpoint.txt => pci-endpoint.rst}    |  74 +++---
 ...est-function.txt => pci-test-function.rst} |  32 +--
 ...{pci-test-howto.txt => pci-test-howto.rst} |  51 ++--
 Documentation/PCI/index.rst                   |  17 ++
 ...or-recovery.txt => pci-error-recovery.rst} | 180 ++++++++-------
 .../{pci-iov-howto.txt => pci-iov-howto.rst}  | 144 +++++++-----
 Documentation/PCI/{pci.txt => pci.rst}        | 218 +++++++++---------
 .../{pcieaer-howto.txt => pcieaer-howto.rst}  |  67 ++++--
 Documentation/index.rst                       |   1 +
 MAINTAINERS                                   |   2 +-
 15 files changed, 641 insertions(+), 436 deletions(-)
 rename Documentation/PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst} (89%)
 rename Documentation/PCI/{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst} (75%)
 rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (97%)
 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} (86%)
 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} (83%)
 create mode 100644 Documentation/PCI/index.rst
 rename Documentation/PCI/{pci-error-recovery.txt => pci-error-recovery.rst} (80%)
 rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (65%)
 rename Documentation/PCI/{pci.txt => pci.rst} (80%)
 rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (83%)

-- 
2.20.1


             reply	other threads:[~2019-03-29 16:04 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-29 16:04 Changbin Du [this message]
2019-03-29 16:04 ` [PATCH 01/12] Documentation: add Linux PCI to Sphinx TOC tree Changbin Du
2019-03-29 16:04 ` [PATCH 02/12] pci doc: convert PCI/pci.txt to rst format Changbin Du
2019-03-29 16:04 ` [PATCH 03/12] pci doc: convert PCI/PCIEBUS-HOWTO.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 04/12] pci doc: convert PCI/pci-iov-howto.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 05/12] pci doc: convert PCI/MSI-HOWTO.txt " Changbin Du
2019-03-30  4:00   ` Matthew Wilcox
2019-03-31  5:18     ` Changbin Du
2019-03-31 15:33   ` Changbin Du
2019-03-29 16:04 ` [PATCH 06/12] pci doc: convert PCI/acpi-info.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 07/12] pci doc: convert PCI/pci-error-recovery.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 08/12] pci doc: convert PCI/pcieaer-howto.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 09/12] pci doc: convert PCI/endpoint/pci-endpoint.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 10/12] pci doc: convert PCI/endpoint/pci-endpoint-cfs.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 11/12] pci doc: convert PCI/endpoint/pci-test-function.txt " Changbin Du
2019-03-29 16:04 ` [PATCH 12/12] pci doc: convert PCI/endpoint/pci-test-howto.txt " Changbin Du
2019-04-01 23:03 ` [PATCH 00/12] Include linux PCI docs into Sphinx TOC tree Bjorn Helgaas
2019-04-02 15:08   ` Changbin Du
2019-04-02 18:07     ` Bjorn Helgaas
2019-04-03 15:39       ` Changbin Du

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=20190329160413.4293-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 \
    /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).