diff mbox series

dev-manual/qemu: add an example for the snapshot+nographic mode

Message ID 20260105-qemu-snapshot-v1-1-b598171f513f@bootlin.com
State New
Headers show
Series dev-manual/qemu: add an example for the snapshot+nographic mode | expand

Commit Message

Antonin Godard Jan. 5, 2026, 4:06 p.m. UTC 
The snapshot option was added by OE-Core commit 8fec4a5a004f
("scripts/runqemu: Add snapshot support"). Along with nographic, this
execution mode is useful for temporary tests in an environment that does
not have graphics support (like a remote server, or a container).

Add it as part of the listed examples.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/qemu.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)


---
base-commit: f9042e1da554017fe46460c1fd2bdf8c74b3fa18
change-id: 20251028-qemu-snapshot-c529fded964e
diff mbox series

Patch

diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst
index 9e0b8b813..442fdced3 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -119,6 +119,17 @@  available. Follow these general steps to run QEMU:
 
          $ runqemu qemux86-64 core-image-minimal ext4
 
+   -  This example starts QEMU in a temporary root filesystem ("snapshot") with
+      no graphical environment ("nographic"), meaning QEMU is started in the
+      current shell:
+
+      .. code-block:: console
+
+         $ runqemu qemux86-64 snapshot nographic
+
+      Running in "snapshot" mode means that changes in root filesystem will not
+      remain after quitting QEMU.
+
    -  This example specifies to boot an :term:`Initramfs` image and to
       enable audio in QEMU. For this case, ``runqemu`` sets the internal
       variable ``FSTYPE`` to ``cpio.gz``. Also, for audio to be enabled,