All of lore.kernel.org
 help / color / mirror / Atom feed
From: Linisha <linisha232@gmail.com>
To: qemu-devel@nongnu.org
Cc: alex.bennee@linaro.org, peter.maydell@linaro.org,
	pbonzini@redhat.com, mjt@tls.msk.ru, philmd@mailo.com,
	berrange@redhat.com, Linisha <linisha232@gmail.com>
Subject: [PATCH v2] docs/system: add general note about architecture and machine differences
Date: Fri, 26 Jun 2026 00:51:19 +0530	[thread overview]
Message-ID: <20260625192121.1887-1-linisha232@gmail.com> (raw)
In-Reply-To: <20260623205839.1294-1-linisha232@gmail.com>

Add a note near the start of the introduction explaining that QEMU options, properties, and command lines may differ between target architectures and machine types. This helps prevent confusion when examples shown for one architecture do not work for another, such as the pflash0/pflash1 options visible in -machine help on some machines but not others.

Suggested-by: Peter Maydell <peter.maydell@linaro.org>

Buglink: https://gitlab.com/qemu-project/qemu/-/issues/3254
Signed-off-by: Linisha <linisha232@gmail.com>
---

v2: Take a different approach based on review feedback from Daniel
    Berrangé and Peter Maydell. Instead of incorrectly claiming
    pflash0/pflash1 are virt-only (they actually work on x86 pc/q35
    machines too), add a general note near the start of the introduction
    about how options, properties, and command lines may differ between
    target architectures and machine types.


 docs/system/introduction.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/system/introduction.rst b/docs/system/introduction.rst
index bec7291e47..8d9ef61d26 100644
--- a/docs/system/introduction.rst
+++ b/docs/system/introduction.rst
@@ -1,6 +1,15 @@
 Introduction
 ============
 
+.. note::
+   QEMU supports many different target CPU architectures and many
+   different machine types for each architecture. Options, properties,
+   and command lines that work for one architecture or machine type
+   will not necessarily work on another. The examples shown in this
+   manual are specific to the architecture and machine type being
+   demonstrated. When in doubt, consult the documentation for your
+   specific target architecture and machine type.
+
 .. _Accelerators:
 
 Virtualisation Accelerators
-- 
2.47.0.windows.1



  parent reply	other threads:[~2026-06-25 19:22 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-23 20:58 [PATCH] docs/system: clarify pflash0 and pflash1 are virt-only options Linisha
2026-06-24  7:15 ` Daniel P. Berrangé
2026-06-24  8:47   ` Peter Maydell
2026-06-24  9:21     ` linisha
2026-06-24 10:28     ` Alex Bennée
2026-06-25 19:21 ` Linisha [this message]
2026-06-26 10:09   ` [PATCH v2] docs/system: add general note about architecture and machine differences Daniel P. Berrangé
2026-06-26 15:39     ` Pierrick Bouvier
2026-06-26 17:44       ` linisha
2026-06-26 18:28         ` Pierrick Bouvier
2026-06-26 18:38           ` linisha
2026-06-26 18:40             ` linisha
2026-06-26 18:44               ` linisha
2026-06-26 18:49                 ` Pierrick Bouvier
2026-06-26 18:58                   ` linisha
2026-06-26 19:13                     ` Pierrick Bouvier
2026-06-26 19:35                       ` linisha
2026-06-26 18:11   ` [PATCH v3] " Linisha
2026-06-26 18:56     ` Pierrick Bouvier

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=20260625192121.1887-1-linisha232@gmail.com \
    --to=linisha232@gmail.com \
    --cc=alex.bennee@linaro.org \
    --cc=berrange@redhat.com \
    --cc=mjt@tls.msk.ru \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=philmd@mailo.com \
    --cc=qemu-devel@nongnu.org \
    /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.