lkml.org 
[lkml]   [2019]   [Apr]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 00/12] Include linux PCI docs into Sphinx TOC tree
On Sat, Mar 30, 2019 at 12:04:01AM +0800, Changbin Du wrote:
> Hi Corbet,

Conventional address would be "Hi Jonathan", just FYI.

> 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

Thanks for doing all this work!

Acked-by: Bjorn Helgaas <bhelgaas@google.com>

There's not a real convention yet for subject lines in Documentation/,
but I would propose:

Documentation: PCI: Convert pci.txt to reST
Documentation: PCI: Convert endpoint/pci-endpoint.txt to reST

because that at least goes with some recent Documentation/PCI changes
and it identifies "reST" as something other than a plain English word
(RST or ReST would also work for me).

> .../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
>

\
 
 \ /
  Last update: 2019-04-02 01:03    [W:0.037 / U:61.356 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site