[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 17/33] docs/system: convert managed startup to rST.
From: |
Peter Maydell |
Subject: |
[PATCH v3 17/33] docs/system: convert managed startup to rST. |
Date: |
Fri, 28 Feb 2020 15:36:03 +0000 |
Fix one typo in the process and format more option and
command names as literal text, but make no significant
changes to the content.
Signed-off-by: Peter Maydell <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
Message-id: address@hidden
---
docs/system/index.rst | 2 +-
docs/system/managed-startup.rst | 35 +++++++++++++++++++++++++++++++++
2 files changed, 36 insertions(+), 1 deletion(-)
create mode 100644 docs/system/managed-startup.rst
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 5034f903407..d655344fffd 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -13,6 +13,6 @@ Contents:
.. toctree::
:maxdepth: 2
-
+ managed-startup
security
vfio-ap
diff --git a/docs/system/managed-startup.rst b/docs/system/managed-startup.rst
new file mode 100644
index 00000000000..9bcf98ea790
--- /dev/null
+++ b/docs/system/managed-startup.rst
@@ -0,0 +1,35 @@
+Managed start up options
+========================
+
+In system mode emulation, it's possible to create a VM in a paused
+state using the ``-S`` command line option. In this state the machine
+is completely initialized according to command line options and ready
+to execute VM code but VCPU threads are not executing any code. The VM
+state in this paused state depends on the way QEMU was started. It
+could be in:
+
+- initial state (after reset/power on state)
+- with direct kernel loading, the initial state could be amended to execute
+ code loaded by QEMU in the VM's RAM and with incoming migration
+- with incoming migration, initial state will be amended with the migrated
+ machine state after migration completes
+
+This paused state is typically used by users to query machine state and/or
+additionally configure the machine (by hotplugging devices) in runtime before
+allowing VM code to run.
+
+However, at the ``-S`` pause point, it's impossible to configure options
+that affect initial VM creation (like: ``-smp``/``-m``/``-numa`` ...) or
+cold plug devices. The experimental ``--preconfig`` command line option
+allows pausing QEMU before the initial VM creation, in a "preconfig" state,
+where additional queries and configuration can be performed via QMP
+before moving on to the resulting configuration startup. In the
+preconfig state, QEMU only allows a limited set of commands over the
+QMP monitor, where the commands do not depend on an initialized
+machine, including but not limited to:
+
+- ``qmp_capabilities``
+- ``query-qmp-schema``
+- ``query-commands``
+- ``query-status``
+- ``x-exit-preconfig``
--
2.20.1
- [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks, (continued)
- [PATCH v3 03/33] texi2pod: parse @include directives outside "@c man" blocks, Peter Maydell, 2020/02/28
- [PATCH v3 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual, Peter Maydell, 2020/02/28
- [PATCH v3 06/33] qemu-doc: extract common system emulator documentation from the PC section, Peter Maydell, 2020/02/28
- [PATCH v3 07/33] qemu-doc: move system requirements chapter inside PC section, Peter Maydell, 2020/02/28
- [PATCH v3 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts, Peter Maydell, 2020/02/28
- [PATCH v3 15/33] docs/system: Convert qemu-cpu-models.texi to rST, Peter Maydell, 2020/02/28
- [PATCH v3 10/33] qemu-doc: move qemu-tech.texi into main section, Peter Maydell, 2020/02/28
- [PATCH v3 11/33] qemu-doc: move included files to docs/system, Peter Maydell, 2020/02/28
- [PATCH v3 12/33] qemu-doc: remove indices other than findex, Peter Maydell, 2020/02/28
- [PATCH v3 14/33] docs: Create defs.rst.inc as a place to define substitutions, Peter Maydell, 2020/02/28
- [PATCH v3 17/33] docs/system: convert managed startup to rST.,
Peter Maydell <=
- [PATCH v3 18/33] docs/system: convert the documentation of deprecated features to rST., Peter Maydell, 2020/02/28
- [PATCH v3 08/33] qemu-doc: split target sections to separate files, Peter Maydell, 2020/02/28
- [PATCH v3 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes", Peter Maydell, 2020/02/28
- [PATCH v3 16/33] docs/system: Convert security.texi to rST format, Peter Maydell, 2020/02/28
- [PATCH v3 05/33] qemu-doc: split qemu-doc.texi in multiple files, Peter Maydell, 2020/02/28
- [PATCH v3 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING, Peter Maydell, 2020/02/28
- [PATCH v3 21/33] hmp-commands-info.hx: Add rST documentation fragments, Peter Maydell, 2020/02/28
- [PATCH v3 24/33] docs: Roll -prom-env and -g target-specific info into qemu-options.hx, Peter Maydell, 2020/02/28
- [PATCH v3 13/33] docs/system: put qemu-block-drivers body in an included file, Peter Maydell, 2020/02/28
- [PATCH v3 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion, Peter Maydell, 2020/02/28