linux-kernel - Re: [PATCH v2 00/12] Include linux PCI docs into Sphinx TOC tree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190403165858.GA67241@google.com>
Date:   Wed, 3 Apr 2019 11:58:58 -0500
From:   Bjorn Helgaas <helgaas@...nel.org>
To:     Changbin Du <changbin.du@...il.com>
Cc:     Jonathan Corbet <corbet@....net>, linux-pci@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 00/12] Include linux PCI docs into Sphinx TOC tree

On Wed, Apr 03, 2019 at 11:49:43PM +0800, Changbin Du wrote:
> 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.
> 
> Changbin Du (12):
>   Documentation: add Linux PCI to Sphinx TOC tree
>   Documentation: PCI: convert PCI/pci.txt to reST format
>   Documentation: PCI: convert PCI/PCIEBUS-HOWTO.txt to reST format
>   Documentation: PCI: convert PCI/pci-iov-howto.txt to reST format
>   Documentation: PCI: convert PCI/MSI-HOWTO.txt to reST format
>   Documentation: PCI: convert PCI/acpi-info.txt to reST format
>   Documentation: PCI: convert PCI/pci-error-recovery.txt to reST format
>   Documentation: PCI: convert PCI/pcieaer-howto.txt to reST format
>   Documentation: PCI: convert PCI/endpoint/pci-endpoint.txt to reST
>     format
>   Documentation: PCI: convert PCI/endpoint/pci-endpoint-cfs.txt to reST
>     format
>   Documentation: PCI: convert PCI/endpoint/pci-test-function.txt to reST
>     format
>   Documentation: PCI: convert PCI/endpoint/pci-test-howto.txt to reST
>     format

Thanks for doing that!  If you have occasion to revise this for any
other reason, I actually suggested this:

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

which (a) Capitalizes the "Convert" and (b) omits the "PCI/" prefix
because it seems redundant.

By coincidence I happened across this post that talks about why I care
about these seemingly trivial things:

  https://chris.beams.io/posts/git-commit/

But with or without that change, for the whole series:

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

>  .../PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst}      |  83 +++---
>  .../{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst}  | 140 +++++----
>  .../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}    |  95 ++++---
>  ...est-function.txt => pci-test-function.rst} |  32 ++-
>  ...{pci-test-howto.txt => pci-test-howto.rst} |  81 ++++--
>  Documentation/PCI/index.rst                   |  18 ++
>  ...or-recovery.txt => pci-error-recovery.rst} | 178 ++++++------
>  .../{pci-iov-howto.txt => pci-iov-howto.rst}  | 161 ++++++-----
>  Documentation/PCI/{pci.txt => pci.rst}        | 267 +++++++++---------
>  .../{pcieaer-howto.txt => pcieaer-howto.rst}  | 110 +++++---
>  Documentation/index.rst                       |   1 +
>  MAINTAINERS                                   |   2 +-
>  15 files changed, 754 insertions(+), 537 deletions(-)
>  rename Documentation/PCI/{MSI-HOWTO.txt => MSI-HOWTO.rst} (88%)
>  rename Documentation/PCI/{PCIEBUS-HOWTO.txt => PCIEBUS-HOWTO.rst} (70%)
>  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} (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/{pci-error-recovery.txt => pci-error-recovery.rst} (80%)
>  rename Documentation/PCI/{pci-iov-howto.txt => pci-iov-howto.rst} (63%)
>  rename Documentation/PCI/{pci.txt => pci.rst} (78%)
>  rename Documentation/PCI/{pcieaer-howto.txt => pcieaer-howto.rst} (81%)
> 
> -- 
> 2.20.1
>