Commit ee03a20aab for qemu.org
commit ee03a20aabd2783a575035bd9dcbd46883647d0f
Author: Linisha <linisha232@gmail.com>
Date: Fri Jun 26 23:41:18 2026 +0530
docs/system: add general note about architecture and machine differences
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>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Buglink: https://gitlab.com/qemu-project/qemu/-/issues/3254
Signed-off-by: Linisha <linisha232@gmail.com>
Reviewed-by: Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>
Link: https://lore.kernel.org/qemu-devel/20260626181118.1136-1-linisha232@gmail.com
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>
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