mbox series

[0/5] docs/specs: Convert various ACPI docs to rST

Message ID 20210727170414.3368-1-peter.maydell@linaro.org
Headers show
Series docs/specs: Convert various ACPI docs to rST | expand

Message

Peter Maydell July 27, 2021, 5:04 p.m. UTC
This patchset does a basic conversion of four ACPI related files in
docs/specs from plain text to rST format.  The aim of the conversion
is not to produce a maximally pretty result, but simply to do a
low-effort conversion that at least results in this documentation
appearing in our manuals rather than merely lying around in the
source tree.

Patch 4 adds the documentation files to MAINTAINERS file
blocks; feel free to suggest I've picked the wrong ones.

thanks
-- PMM

Peter Maydell (5):
  docs/specs/acpu_cpu_hotplug: Convert to rST
  docs/specs/acpi_mem_hotplug: Convert to rST
  docs/specs/acpi_pci_hotplug: Convert to rST
  docs/specs/acpi_nvdimm: Convert to rST
  MAINTAINERS: Add ACPI specs documents to ACPI and NVDIMM sections

 docs/specs/acpi_cpu_hotplug.rst               | 235 ++++++++++++++++++
 docs/specs/acpi_cpu_hotplug.txt               | 160 ------------
 docs/specs/acpi_mem_hotplug.rst               | 128 ++++++++++
 docs/specs/acpi_mem_hotplug.txt               |  94 -------
 docs/specs/acpi_nvdimm.rst                    | 228 +++++++++++++++++
 docs/specs/acpi_nvdimm.txt                    | 188 --------------
 ...i_pci_hotplug.txt => acpi_pci_hotplug.rst} |  37 +--
 docs/specs/index.rst                          |   4 +
 MAINTAINERS                                   |   5 +
 9 files changed, 620 insertions(+), 459 deletions(-)
 create mode 100644 docs/specs/acpi_cpu_hotplug.rst
 delete mode 100644 docs/specs/acpi_cpu_hotplug.txt
 create mode 100644 docs/specs/acpi_mem_hotplug.rst
 delete mode 100644 docs/specs/acpi_mem_hotplug.txt
 create mode 100644 docs/specs/acpi_nvdimm.rst
 delete mode 100644 docs/specs/acpi_nvdimm.txt
 rename docs/specs/{acpi_pci_hotplug.txt => acpi_pci_hotplug.rst} (51%)

Comments

Igor Mammedov July 30, 2021, 12:55 p.m. UTC | #1
On Tue, 27 Jul 2021 18:04:09 +0100
Peter Maydell <peter.maydell@linaro.org> wrote:

> This patchset does a basic conversion of four ACPI related files in
> docs/specs from plain text to rST format.  The aim of the conversion
> is not to produce a maximally pretty result, but simply to do a
> low-effort conversion that at least results in this documentation
> appearing in our manuals rather than merely lying around in the
> source tree.
> 
> Patch 4 adds the documentation files to MAINTAINERS file
> blocks; feel free to suggest I've picked the wrong ones.

compiled, and checked end result (html docs) which looks fine to me,
so

Reviewed-by: Igor Mammedov <imammedo@redhat.com>

> 
> thanks
> -- PMM
> 
> Peter Maydell (5):
>   docs/specs/acpu_cpu_hotplug: Convert to rST
>   docs/specs/acpi_mem_hotplug: Convert to rST
>   docs/specs/acpi_pci_hotplug: Convert to rST
>   docs/specs/acpi_nvdimm: Convert to rST
>   MAINTAINERS: Add ACPI specs documents to ACPI and NVDIMM sections
> 
>  docs/specs/acpi_cpu_hotplug.rst               | 235 ++++++++++++++++++
>  docs/specs/acpi_cpu_hotplug.txt               | 160 ------------
>  docs/specs/acpi_mem_hotplug.rst               | 128 ++++++++++
>  docs/specs/acpi_mem_hotplug.txt               |  94 -------
>  docs/specs/acpi_nvdimm.rst                    | 228 +++++++++++++++++
>  docs/specs/acpi_nvdimm.txt                    | 188 --------------
>  ...i_pci_hotplug.txt => acpi_pci_hotplug.rst} |  37 +--
>  docs/specs/index.rst                          |   4 +
>  MAINTAINERS                                   |   5 +
>  9 files changed, 620 insertions(+), 459 deletions(-)
>  create mode 100644 docs/specs/acpi_cpu_hotplug.rst
>  delete mode 100644 docs/specs/acpi_cpu_hotplug.txt
>  create mode 100644 docs/specs/acpi_mem_hotplug.rst
>  delete mode 100644 docs/specs/acpi_mem_hotplug.txt
>  create mode 100644 docs/specs/acpi_nvdimm.rst
>  delete mode 100644 docs/specs/acpi_nvdimm.txt
>  rename docs/specs/{acpi_pci_hotplug.txt => acpi_pci_hotplug.rst} (51%)
>
Peter Maydell Aug. 26, 2021, 2:33 p.m. UTC | #2
On Fri, 30 Jul 2021 at 13:56, Igor Mammedov <imammedo@redhat.com> wrote:
>
> On Tue, 27 Jul 2021 18:04:09 +0100
> Peter Maydell <peter.maydell@linaro.org> wrote:
>
> > This patchset does a basic conversion of four ACPI related files in
> > docs/specs from plain text to rST format.  The aim of the conversion
> > is not to produce a maximally pretty result, but simply to do a
> > low-effort conversion that at least results in this documentation
> > appearing in our manuals rather than merely lying around in the
> > source tree.
> >
> > Patch 4 adds the documentation files to MAINTAINERS file
> > blocks; feel free to suggest I've picked the wrong ones.
>
> compiled, and checked end result (html docs) which looks fine to me,
> so
>
> Reviewed-by: Igor Mammedov <imammedo@redhat.com>

Thanks; I'll take this via target-arm.next.

-- PMM