aboutsummaryrefslogtreecommitdiff
path: root/docs/system
diff options
context:
space:
mode:
authorAlex Bennée <alex.bennee@linaro.org>2021-03-05 09:23:21 +0000
committerAlex Bennée <alex.bennee@linaro.org>2021-03-10 12:13:59 +0000
commit085d9afc68e30b97b1d4118849a3f3c8c77ff43a (patch)
treea4925830e70a6070bb5107f3bfb135c3d97fa527 /docs/system
parenta557b00469bca61a058fc1db4855503cac1c3219 (diff)
docs/system: add a gentle prompt for the complexity to come
We all know the QEMU command line can become a fiendishly complex beast. Lets gently prepare our user for the horrors to come by referencing where other example command lines can be found in the manual. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: John Snow <jsnow@redhat.com> Reviewed-by: Thomas Huth <thuth@redhat.com> Message-Id: <20210305092328.31792-3-alex.bennee@linaro.org>
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/quickstart.rst8
-rw-r--r--docs/system/targets.rst2
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/system/quickstart.rst b/docs/system/quickstart.rst
index 3a3acab5e7..681678c86e 100644
--- a/docs/system/quickstart.rst
+++ b/docs/system/quickstart.rst
@@ -11,3 +11,11 @@ Download and uncompress a PC hard disk image with Linux installed (e.g.
|qemu_system| linux.img
Linux should boot and give you a prompt.
+
+Users should be aware the above example elides a lot of the complexity
+of setting up a VM with x86_64 specific defaults and assumes the
+first non switch argument is a PC compatible disk image with a boot
+sector. For a non-x86 system where we emulate a broad range of machine
+types, the command lines are generally more explicit in defining the
+machine and boot behaviour. You will find more example command lines
+in the :ref:`system-targets-ref` section of the manual.
diff --git a/docs/system/targets.rst b/docs/system/targets.rst
index 75ed1087fd..9dcd95dd84 100644
--- a/docs/system/targets.rst
+++ b/docs/system/targets.rst
@@ -1,3 +1,5 @@
+.. _system-targets-ref:
+
QEMU System Emulator Targets
============================