[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 2/9] docs/system: add a gentle prompt for the complexity to co
From: |
Alex Bennée |
Subject: |
[PATCH v1 2/9] docs/system: add a gentle prompt for the complexity to come |
Date: |
Fri, 5 Mar 2021 09:23:21 +0000 |
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: <20210301112741.31047-1-alex.bennee@linaro.org>
---
v2
- minor grammar tweaks suggested by Thomas and John
---
docs/system/quickstart.rst | 8 ++++++++
docs/system/targets.rst | 2 ++
2 files changed, 10 insertions(+)
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 560783644d..145cc64551 100644
--- a/docs/system/targets.rst
+++ b/docs/system/targets.rst
@@ -1,3 +1,5 @@
+.. _system-targets-ref:
+
QEMU System Emulator Targets
============================
--
2.20.1
- [PATCH v1 0/9] testing/next (docs, hexagon, cfi, docker), Alex Bennée, 2021/03/05
- [PATCH v1 1/9] docs/devel: re-organise the developers guide into sections, Alex Bennée, 2021/03/05
- [PATCH v1 2/9] docs/system: add a gentle prompt for the complexity to come,
Alex Bennée <=
- [PATCH v1 8/9] gitlab-ci.yml: Add jobs to test CFI flags, Alex Bennée, 2021/03/05
- [PATCH v1 4/9] docker: Add Hexagon image, Alex Bennée, 2021/03/05
- [PATCH v1 5/9] tests/tcg: Use Hexagon Docker image, Alex Bennée, 2021/03/05
- [PATCH v1 6/9] gitlab: add build-user-hexagon test, Alex Bennée, 2021/03/05
- [PATCH v1 7/9] gitlab-ci.yml: Allow custom # of parallel linkers, Alex Bennée, 2021/03/05
- [PATCH v1 3/9] tests/docker: add a test-tcg for building then running check-tcg, Alex Bennée, 2021/03/05