All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: fam@euphon.net, "Thomas Huth" <thuth@redhat.com>,
	berrange@redhat.com, "John Snow" <jsnow@redhat.com>,
	f4bug@amsat.org, stefanha@redhat.com, crosa@redhat.com,
	pbonzini@redhat.com, "Alex Bennée" <alex.bennee@linaro.org>,
	aurelien@aurel32.net
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	[thread overview]
Message-ID: <20210305092328.31792-3-alex.bennee@linaro.org> (raw)
In-Reply-To: <20210305092328.31792-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: <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



  parent reply	other threads:[~2021-03-05  9:27 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-05  9:23 [PATCH v1 0/9] testing/next (docs, hexagon, cfi, docker) Alex Bennée
2021-03-05  9:23 ` [PATCH v1 1/9] docs/devel: re-organise the developers guide into sections Alex Bennée
2021-03-05  9:40   ` Philippe Mathieu-Daudé
2021-03-05 13:37     ` Alex Bennée
2021-03-05  9:23 ` Alex Bennée [this message]
2021-03-05  9:23 ` [PATCH v1 3/9] tests/docker: add a test-tcg for building then running check-tcg Alex Bennée
2021-03-05  9:41   ` Philippe Mathieu-Daudé
2021-03-05  9:23 ` [PATCH v1 4/9] docker: Add Hexagon image Alex Bennée
2021-03-05  9:23 ` [PATCH v1 5/9] tests/tcg: Use Hexagon Docker image Alex Bennée
2021-03-05  9:23 ` [PATCH v1 6/9] gitlab: add build-user-hexagon test Alex Bennée
2021-03-05  9:43   ` Philippe Mathieu-Daudé
2021-03-05 15:37   ` Wainer dos Santos Moschetta
2021-03-05  9:23 ` [PATCH v1 7/9] gitlab-ci.yml: Allow custom # of parallel linkers Alex Bennée
2021-03-05  9:23 ` [PATCH v1 8/9] gitlab-ci.yml: Add jobs to test CFI flags Alex Bennée
2021-03-05  9:43   ` Philippe Mathieu-Daudé
2021-03-05  9:23 ` [PATCH v1 9/9] tests/docker: Use --arch-only when building Debian cross image Alex Bennée
2021-03-05  9:42 ` [PATCH v1 0/9] testing/next (docs, hexagon, cfi, docker) no-reply
2021-03-05 19:37 ` Willian Rampazzo
2021-03-07 17:29   ` 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=20210305092328.31792-3-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=aurelien@aurel32.net \
    --cc=berrange@redhat.com \
    --cc=crosa@redhat.com \
    --cc=f4bug@amsat.org \
    --cc=fam@euphon.net \
    --cc=jsnow@redhat.com \
    --cc=pbonzini@redhat.com \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.