qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: peter.maydell@linaro.org
Cc: "John Snow" <jsnow@redhat.com>, "Thomas Huth" <thuth@redhat.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	qemu-devel@nongnu.org, "Stefan Hajnoczi" <stefanha@redhat.com>
Subject: [PULL 01/18] docs/system: add a gentle prompt for the complexity to come
Date: Mon,  8 Mar 2021 13:50:47 +0000	[thread overview]
Message-ID: <20210308135104.24903-2-alex.bennee@linaro.org> (raw)
In-Reply-To: <20210308135104.24903-1-alex.bennee@linaro.org>

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>

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
 ============================
 
-- 
2.20.1



  reply	other threads:[~2021-03-08 13:52 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-08 13:50 [PULL 00/18] testing, docs, semihosting move and guest-loader Alex Bennée
2021-03-08 13:50 ` Alex Bennée [this message]
2021-03-08 13:50 ` [PULL 02/18] tests/docker: add a test-tcg for building then running check-tcg Alex Bennée
2021-03-08 13:50 ` [PULL 03/18] docker: Add Hexagon image Alex Bennée
2021-03-08 13:50 ` [PULL 04/18] tests/tcg: Use Hexagon Docker image Alex Bennée
2021-03-08 13:50 ` [PULL 05/18] gitlab: add build-user-hexagon test Alex Bennée
2021-03-08 13:50 ` [PULL 06/18] gitlab-ci.yml: Allow custom # of parallel linkers Alex Bennée
2021-03-08 13:50 ` [PULL 07/18] gitlab-ci.yml: Add jobs to test CFI flags Alex Bennée
2021-03-08 13:50 ` [PULL 08/18] tests/docker: Use --arch-only when building Debian cross image Alex Bennée
2021-03-08 13:50 ` [PULL 09/18] .editorconfig: update the automatic mode setting for Emacs Alex Bennée
2021-03-08 13:50 ` [PULL 10/18] hw/board: promote fdt from ARM VirtMachineState to MachineState Alex Bennée
2021-03-08 13:50 ` [PULL 11/18] hw/riscv: migrate fdt field to generic MachineState Alex Bennée
2021-03-08 13:50 ` [PULL 12/18] device_tree: add qemu_fdt_setprop_string_array helper Alex Bennée
2021-03-08 13:50 ` [PULL 13/18] hw/core: implement a guest-loader to support static hypervisor guests Alex Bennée
2021-03-15 16:16   ` Christian Borntraeger
2021-03-15 16:44     ` Philippe Mathieu-Daudé
2021-03-15 16:51       ` Philippe Mathieu-Daudé
2021-03-15 16:59         ` Christian Borntraeger
2021-03-15 17:05           ` Philippe Mathieu-Daudé
2021-03-15 18:01             ` Alex Bennée
2021-03-15 16:52       ` Christian Borntraeger
2021-03-08 13:51 ` [PULL 14/18] docs: move generic-loader documentation into the main manual Alex Bennée
2021-03-08 13:51 ` [PULL 15/18] docs: add some documentation for the guest-loader Alex Bennée
2021-03-08 13:51 ` [PULL 16/18] tests/avocado: add boot_xen tests Alex Bennée
2021-03-08 13:51 ` [PULL 17/18] semihosting: Move include/hw/semihosting/ -> include/semihosting/ Alex Bennée
2021-03-08 13:51 ` [PULL 18/18] semihosting: Move hw/semihosting/ -> semihosting/ Alex Bennée
2021-03-08 14:39 ` [PULL 00/18] testing, docs, semihosting move and guest-loader no-reply
2021-03-09 18:11 ` Peter Maydell
2021-03-09 18:37   ` Alex Bennée
2021-03-09 21:33     ` Peter Maydell
2021-03-09 22:26     ` Philippe Mathieu-Daudé
2021-03-10 10:41   ` Alex Bennée
2021-03-10 11:10     ` Peter Maydell
2021-03-10 13:27       ` Alex Bennée
2021-03-10 13:53         ` Philippe Mathieu-Daudé
2021-03-10 15:47           ` Alex Bennée

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210308135104.24903-2-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=jsnow@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    --cc=thuth@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).