mbox series

[0/8] docs/specs: Convert txt files to rST

Message ID 20230927151205.70930-1-peter.maydell@linaro.org
Headers show
Series docs/specs: Convert txt files to rST | expand

Message

Peter Maydell Sept. 27, 2023, 3:11 p.m. UTC
This patchseries converts most of the remaining .txt files in
docs/specs to rST format and integrates tem with our documentation.
(The one remaining .txt file is rocker.txt, which I left to do
later because at over 1000 lines it is much bigger than these.)

These are mostly simple conversions with not too much effort
put into the formatting/markup. In a few cases I dropped
parts of the text already covered elsewhere or made light
fixes for grammar/spelling; see individual patch commit
messages for more detail.

thanks
-- PMM

Peter Maydell (8):
  docs/specs/vmw_pvscsi-spec: Convert to rST
  docs/specs/edu: Convert to rST
  docs/specs/ivshmem-spec: Convert to rST
  docs/specs/pvpanic: Convert to rST
  docs/specs/standard-vga: Convert to rST
  docs/specs/virt-ctlr: Convert to rST
  docs/specs/vmcoreinfo: Convert to rST
  docs/specs/vmgenid: Convert to rST

 MAINTAINERS                                   |   5 +-
 docs/specs/{edu.txt => edu.rst}               |  84 +++---
 docs/specs/index.rst                          |   8 +
 .../{ivshmem-spec.txt => ivshmem-spec.rst}    |  63 ++---
 docs/specs/pci-ids.rst                        |   2 +-
 docs/specs/{pvpanic.txt => pvpanic.rst}       |  41 ++-
 docs/specs/standard-vga.rst                   |  94 +++++++
 docs/specs/standard-vga.txt                   |  81 ------
 docs/specs/{virt-ctlr.txt => virt-ctlr.rst}   |  12 +-
 docs/specs/{vmcoreinfo.txt => vmcoreinfo.rst} |  33 +--
 docs/specs/vmgenid.rst                        | 246 ++++++++++++++++++
 docs/specs/vmgenid.txt                        | 245 -----------------
 docs/specs/vmw_pvscsi-spec.rst                | 115 ++++++++
 docs/specs/vmw_pvscsi-spec.txt                |  92 -------
 docs/system/devices/ivshmem.rst               |   2 +-
 hw/display/vga-isa.c                          |   2 +-
 hw/display/vga-pci.c                          |   2 +-
 17 files changed, 595 insertions(+), 532 deletions(-)
 rename docs/specs/{edu.txt => edu.rst} (64%)
 rename docs/specs/{ivshmem-spec.txt => ivshmem-spec.rst} (88%)
 rename docs/specs/{pvpanic.txt => pvpanic.rst} (64%)
 create mode 100644 docs/specs/standard-vga.rst
 delete mode 100644 docs/specs/standard-vga.txt
 rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%)
 rename docs/specs/{vmcoreinfo.txt => vmcoreinfo.rst} (50%)
 create mode 100644 docs/specs/vmgenid.rst
 delete mode 100644 docs/specs/vmgenid.txt
 create mode 100644 docs/specs/vmw_pvscsi-spec.rst
 delete mode 100644 docs/specs/vmw_pvscsi-spec.txt

Comments

Peter Maydell Oct. 17, 2023, 12:46 p.m. UTC | #1
Ping for code review ?

thanks
-- PMM

On Wed, 27 Sept 2023 at 16:12, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> This patchseries converts most of the remaining .txt files in
> docs/specs to rST format and integrates tem with our documentation.
> (The one remaining .txt file is rocker.txt, which I left to do
> later because at over 1000 lines it is much bigger than these.)
>
> These are mostly simple conversions with not too much effort
> put into the formatting/markup. In a few cases I dropped
> parts of the text already covered elsewhere or made light
> fixes for grammar/spelling; see individual patch commit
> messages for more detail.
>
> thanks
> -- PMM
>
> Peter Maydell (8):
>   docs/specs/vmw_pvscsi-spec: Convert to rST
>   docs/specs/edu: Convert to rST
>   docs/specs/ivshmem-spec: Convert to rST
>   docs/specs/pvpanic: Convert to rST
>   docs/specs/standard-vga: Convert to rST
>   docs/specs/virt-ctlr: Convert to rST
>   docs/specs/vmcoreinfo: Convert to rST
>   docs/specs/vmgenid: Convert to rST
>
>  MAINTAINERS                                   |   5 +-
>  docs/specs/{edu.txt => edu.rst}               |  84 +++---
>  docs/specs/index.rst                          |   8 +
>  .../{ivshmem-spec.txt => ivshmem-spec.rst}    |  63 ++---
>  docs/specs/pci-ids.rst                        |   2 +-
>  docs/specs/{pvpanic.txt => pvpanic.rst}       |  41 ++-
>  docs/specs/standard-vga.rst                   |  94 +++++++
>  docs/specs/standard-vga.txt                   |  81 ------
>  docs/specs/{virt-ctlr.txt => virt-ctlr.rst}   |  12 +-
>  docs/specs/{vmcoreinfo.txt => vmcoreinfo.rst} |  33 +--
>  docs/specs/vmgenid.rst                        | 246 ++++++++++++++++++
>  docs/specs/vmgenid.txt                        | 245 -----------------
>  docs/specs/vmw_pvscsi-spec.rst                | 115 ++++++++
>  docs/specs/vmw_pvscsi-spec.txt                |  92 -------
>  docs/system/devices/ivshmem.rst               |   2 +-
>  hw/display/vga-isa.c                          |   2 +-
>  hw/display/vga-pci.c                          |   2 +-
>  17 files changed, 595 insertions(+), 532 deletions(-)
>  rename docs/specs/{edu.txt => edu.rst} (64%)
>  rename docs/specs/{ivshmem-spec.txt => ivshmem-spec.rst} (88%)
>  rename docs/specs/{pvpanic.txt => pvpanic.rst} (64%)
>  create mode 100644 docs/specs/standard-vga.rst
>  delete mode 100644 docs/specs/standard-vga.txt
>  rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%)
>  rename docs/specs/{vmcoreinfo.txt => vmcoreinfo.rst} (50%)
>  create mode 100644 docs/specs/vmgenid.rst
>  delete mode 100644 docs/specs/vmgenid.txt
>  create mode 100644 docs/specs/vmw_pvscsi-spec.rst
>  delete mode 100644 docs/specs/vmw_pvscsi-spec.txt
>
> --
> 2.34.1
>
Peter Maydell Oct. 31, 2023, 2:09 p.m. UTC | #2
On Wed, 27 Sept 2023 at 16:12, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> This patchseries converts most of the remaining .txt files in
> docs/specs to rST format and integrates tem with our documentation.
> (The one remaining .txt file is rocker.txt, which I left to do
> later because at over 1000 lines it is much bigger than these.)
>
> These are mostly simple conversions with not too much effort
> put into the formatting/markup. In a few cases I dropped
> parts of the text already covered elsewhere or made light
> fixes for grammar/spelling; see individual patch commit
> messages for more detail.
>
> thanks
> -- PMM
>
> Peter Maydell (8):
>   docs/specs/vmw_pvscsi-spec: Convert to rST
>   docs/specs/edu: Convert to rST
>   docs/specs/ivshmem-spec: Convert to rST
>   docs/specs/pvpanic: Convert to rST
>   docs/specs/standard-vga: Convert to rST
>   docs/specs/virt-ctlr: Convert to rST
>   docs/specs/vmcoreinfo: Convert to rST
>   docs/specs/vmgenid: Convert to rST

In the absence of further review I'm going to apply these via
target-arm.next, since they're only docs format conversions;
let me know if you'd like more time.

thanks
-- PMM