diff mbox series

[for-5.2,6/9] docs: Move microvm.rst into the system manual

Message ID 20201112144041.32278-7-peter.maydell@linaro.org
State New
Headers show
Series docs: Move orphan top-level .rst files into manuals | expand

Commit Message

Peter Maydell Nov. 12, 2020, 2:40 p.m. UTC
Now that target-i386.rst has a place to list documentation of
machines other than the 'pc' machine, we have a place we can
move the microvm documentation to.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/{ => system/i386}/microvm.rst | 5 ++---
 docs/system/target-i386.rst        | 1 +
 2 files changed, 3 insertions(+), 3 deletions(-)
 rename docs/{ => system/i386}/microvm.rst (98%)

Comments

Alex Bennée Nov. 12, 2020, 6:30 p.m. UTC | #1
Peter Maydell <peter.maydell@linaro.org> writes:

> Now that target-i386.rst has a place to list documentation of
> machines other than the 'pc' machine, we have a place we can
> move the microvm documentation to.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

That said the x86 section runs straight into board models and I feel it
would be nice if we could persuade the x86 guys to write a bit of
pre-amble similar to what we have for Arm that explains the status of
KVM and TCG for x86 guests and the point of i440 and q35 models.
diff mbox series

Patch

diff --git a/docs/microvm.rst b/docs/system/i386/microvm.rst
similarity index 98%
rename from docs/microvm.rst
rename to docs/system/i386/microvm.rst
index fcf41fc1f6f..1675e37d3e7 100644
--- a/docs/microvm.rst
+++ b/docs/system/i386/microvm.rst
@@ -1,6 +1,5 @@ 
-====================
-microvm Machine Type
-====================
+'microvm' virtual platform (``microvm``)
+========================================
 
 ``microvm`` is a machine type inspired by ``Firecracker`` and
 constructed after its machine model.
diff --git a/docs/system/target-i386.rst b/docs/system/target-i386.rst
index 1612ddba907..22ba5ce2c0f 100644
--- a/docs/system/target-i386.rst
+++ b/docs/system/target-i386.rst
@@ -16,6 +16,7 @@  Board-specific documentation
 .. toctree::
    :maxdepth: 1
 
+   i386/microvm
    i386/pc
 
 .. include:: cpu-models-x86.rst.inc