@samitouri / QOSamiQemu / commits / ee03a20aab

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>

Linisha committed Jun 26, 2026 at 23:41 UTC ee03a20aabd2783a575035bd9dcbd46883647d0f
1 file changed +9
docs/system/introduction.rst
+9
@@ -1,6 +1,15 @@
1 Introduction
2 ============
3
4 +.. note::
5 + QEMU supports many different target CPU architectures and many
6 + different machine types for each architecture. Options, properties,
7 + and command lines that work for one architecture or machine type
8 + will not necessarily work on another. The examples shown in this
9 + manual are specific to the architecture and machine type being
10 + demonstrated. When in doubt, consult the documentation for your
11 + specific target architecture and machine type.
12 +
13 .. _Accelerators:
14
15 Virtualisation Accelerators