[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [for-5.2 0/9] docs: Move orphan top-level .rst files into manuals
From: |
Alex Bennée |
Subject: |
Re: [for-5.2 0/9] docs: Move orphan top-level .rst files into manuals |
Date: |
Thu, 12 Nov 2020 18:33:43 +0000 |
User-agent: |
mu4e 1.5.7; emacs 28.0.50 |
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
- [for-5.2 5/9] docs: Split out 'pc' machine model docs into their own file, (continued)
- [for-5.2 5/9] docs: Split out 'pc' machine model docs into their own file, Peter Maydell, 2020/11/12
- [for-5.2 6/9] docs: Move microvm.rst into the system manual, Peter Maydell, 2020/11/12
- [for-5.2 7/9] docs: Move pr-manager.rst into the system manual, Peter Maydell, 2020/11/12
- [for-5.2 9/9] docs/system/pr-manager.rst: Fix minor docs nits, Peter Maydell, 2020/11/12
- [for-5.2 8/9] docs: Split qemu-pr-helper documentation into tools manual, Peter Maydell, 2020/11/12
- Re: [for-5.2 0/9] docs: Move orphan top-level .rst files into manuals,
Alex Bennée <=