Currently we have a handful of rST documents that are sat in the top
level docs/ directory and do not get built into the manuals.  These
are a legacy from the period after we'd decided we wanted rST format
documentation but before we'd set up the manual structure.  This
patchset moves them all into at least plausibly suitable places in
the manual set:

 * virtio-net-failover, cpu-hotplug, virtio-pmem all go into the
   system manual
 * microvm goes into the system manual, but first we have to create a
   structure in target-i386.rst that lets us have a list of multiple
   machine types (along the pattern that target-arm.rst does)
 * pr-manager.rst goes into the system manual, but the part of it
   documenting the qemu-pr-helper executable needs to go into the
   tools manual

If anybody who cares about the x86 machine models would like to
create some documentation of the others ("q35", "isapc", "xenpv",
"xenfv") you now have a place for it to live :-)

Since there's no good way to cross-reference between different
manuals there is no direct link between the pr-manager.rst and the
qemu-pr-helper.rst; my proposal for fixing that is the recent "build
a single manual, not five" RFC.

thanks
-- PMM

Peter Maydell (9):
  docs: Move virtio-net-failover.rst into the system manual
  docs: Move cpu-hotplug.rst into the system manual
  docs: Move virtio-pmem.rst into the system manual
  docs/system/virtio-pmem.rst: Fix minor style issues
  docs: Split out 'pc' machine model docs into their own file
  docs: Move microvm.rst into the system manual
  docs: Move pr-manager.rst into the system manual
  docs: Split qemu-pr-helper documentation into tools manual
  docs/system/pr-manager.rst: Fix minor docs nits

 docs/meson.build                          |  1 +
 docs/{ => system}/cpu-hotplug.rst         |  0
 docs/{ => system/i386}/microvm.rst        |  5 +-
 docs/system/i386/pc.rst                   |  7 ++
 docs/system/index.rst                     |  4 +
 docs/{ => system}/pr-manager.rst          | 44 ++---------
 docs/system/target-i386.rst               | 19 +++--
 docs/{ => system}/virtio-net-failover.rst |  0
 docs/system/virtio-pmem.rst               | 75 +++++++++++++++++++
 docs/tools/conf.py                        |  2 +
 docs/tools/index.rst                      |  1 +
 docs/tools/qemu-pr-helper.rst             | 90 +++++++++++++++++++++++
 docs/virtio-pmem.rst                      | 76 -------------------
 13 files changed, 204 insertions(+), 120 deletions(-)
 rename docs/{ => system}/cpu-hotplug.rst (100%)
 rename docs/{ => system/i386}/microvm.rst (98%)
 create mode 100644 docs/system/i386/pc.rst
 rename docs/{ => system}/pr-manager.rst (68%)
 rename docs/{ => system}/virtio-net-failover.rst (100%)
 create mode 100644 docs/system/virtio-pmem.rst
 create mode 100644 docs/tools/qemu-pr-helper.rst
 delete mode 100644 docs/virtio-pmem.rst

-- 
2.20.1

Peter Maydell <peter.maydell@linaro.org> writes:

> Currently we have a handful of rST documents that are sat in the top
> level docs/ directory and do not get built into the manuals.  These
> are a legacy from the period after we'd decided we wanted rST format
> documentation but before we'd set up the manual structure.  This
> patchset moves them all into at least plausibly suitable places in
> the manual set:
>
>  * virtio-net-failover, cpu-hotplug, virtio-pmem all go into the
>    system manual
>  * microvm goes into the system manual, but first we have to create a
>    structure in target-i386.rst that lets us have a list of multiple
>    machine types (along the pattern that target-arm.rst does)
>  * pr-manager.rst goes into the system manual, but the part of it
>    documenting the qemu-pr-helper executable needs to go into the
>    tools manual
>
> If anybody who cares about the x86 machine models would like to
> create some documentation of the others ("q35", "isapc", "xenpv",
> "xenfv") you now have a place for it to live :-)

I should have read the cover letter ;-)

Anyway I also ran a build through rtd:

  https://qemu-stsquad.readthedocs.io/en/docs-review/index.html

-- 
Alex Bennée