docs/system: clarify pflash0 and pflash1 are virt-only options
PATCH 1/1 docs/system: clarify pflash0 and pflash1 are virt-only options
The pflash0 and pflash1 machine options shown in the Aarch64 virt example are only available for virt machine types on Arm, RISC-V, and LoongArch architectures. Add a note to clarify this for users who may try these options on x86 machines and be confused when they are not available.
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3254
--- docs/system/introduction.rst | 6 ++++++ 1 file changed, 6 insertions(+)
docs/system/introduction.rst +6 -0
@@ -158,6 +158,12 @@ virtualisation so we can use KVM inside the emulated guest. As the ``virt`` machine comes with some built in pflash devices we give them names so we can override the defaults later. +.. note:: + The ``pflash0`` and ``pflash1`` machine options are specific to the + ``virt`` machine type on Arm, RISC-V, and LoongArch architectures. + They are not available on x86 machines, which use ``-bios`` or + ``-pflash`` for firmware instead. + .. code:: $ qemu-system-aarch64 \
Signature · 1 line
2.47.0.windows.1
Quoted 13 lines · Linisha
The pflash0 and pflash1 machine options shown in the Aarch64 virt example are only available for virt machine types on Arm, RISC-V, and LoongArch architectures. Add a note to clarify this for users who may try these options on x86 machines and be confused when they are not available.
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3254
Signed-off-by Linisha <[email protected]>--- docs/system/introduction.rst | 6 ++++++ 1 file changed, 6 insertions(+)docs/system/introduction.rst +0
-0
docs/system/introduction.rst virtualisation so we can use KVM inside the emulated guest. As the · line 165
Quoted 8 lines
docs/system/introduction.rst +5
-0@@ -158,6 +158,12 @@ virtualisation so we can use KVM inside the emulated guest. As the ``virt`` machine comes with some built in pflash devices we give them names so we can override the defaults later. +.. note:: + The ``pflash0`` and ``pflash1`` machine options are specific to the + ``virt`` machine type on Arm, RISC-V, and LoongArch architectures. + They are not available on x86 machines, which use ``-bios`` or + ``-pflash`` for firmware instead.
No this is wrong.
The pflash0 and pflash1 properties apply to x86 pc & q35 machines too.
-pflash is a legacy syntax which remaps to pflash0 and pflash1 internally, but also applies to other machines which don't use the new pflash0/pflash1 properties.
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com ~~ https://hachyderm.io/@berrange :| |: https://libvirt.org ~~ https://entangle-photo.org :| |: https://pixelfed.art/berrange ~~ https://fstop138.berrange.com :|
Quoted 26 lines · Daniel P. Berrangé
Quoted 13 lines · Linisha
The pflash0 and pflash1 machine options shown in the Aarch64 virt example are only available for virt machine types on Arm, RISC-V, and LoongArch architectures. Add a note to clarify this for users who may try these options on x86 machines and be confused when they are not available.
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3254
Signed-off-by Linisha <[email protected]>--- docs/system/introduction.rst | 6 ++++++ 1 file changed, 6 insertions(+)docs/system/introduction.rst +0
-0docs/system/introduction.rst virtualisation so we can use KVM inside the emulated guest. As the · line 165
Quoted 8 lines
docs/system/introduction.rst +5
-0@@ -158,6 +158,12 @@ virtualisation so we can use KVM inside the emulated guest. As the ``virt`` machine comes with some built in pflash devices we give them names so we can override the defaults later. +.. note:: + The ``pflash0`` and ``pflash1`` machine options are specific to the + ``virt`` machine type on Arm, RISC-V, and LoongArch architectures. + They are not available on x86 machines, which use ``-bios`` or + ``-pflash`` for firmware instead.No this is wrong.
Quoted 5 lines
The pflash0 and pflash1 properties apply to x86 pc & q35 machines too.
-pflash is a legacy syntax which remaps to pflash0 and pflash1 internally, but also applies to other machines which don't use the new pflash0/pflash1 properties.
I think it is probably worth having something in the intro text that makes the point that for QEMU all architectures and machines are potentially different, and that options and command lines that work on for example an x86 PC machine will not necessarily work on an Arm machine, and so on. But we should do that as a kind of general warning somewhere near the start.
The bug report notes that "./build/x86/qemu-system-x86_64 -M pc,help" does not list the pflash0 and pflash1 options. I think this is because we set these up as alias properties on the actual flash device object in pc_pflash_create(), so they don't exist as class properties that "help" can introspect on.
-- PMM
Hi Daniel, Peter,
Thank you both for taking the time to review and explain. I understand now that pflash0 and pflash1 do work on x86 pc/q35 — the underlying issue is that help cannot introspect alias properties created at machine construction.
The deeper code fix to address that is beyond my current scope as a new contributor. Please disregard this patch — I'd like to withdraw it. I'll work on a v2 that focuses only on the documentation improvement Peter suggested — adding a general note about cross-architecture and cross-machine-type differences near the start of the introduction text, rather than pflash-specific wording.
I'll send v2 once I've drafted appropriate wording.
Thanks again for the patient guidance.
Best regards,
Linisha
Quoted 48 lines · Peter Maydell
Quoted 26 lines · Daniel P. Berrangé
Quoted 13 lines · Linisha
The pflash0 and pflash1 machine options shown in the Aarch64 virt example are only available for virt machine types on Arm, RISC-V, and LoongArch architectures. Add a note to clarify this for users who may try these options on x86 machines and be confused when they are not available.
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3254
Signed-off-by Linisha <[email protected]>--- docs/system/introduction.rst | 6 ++++++ 1 file changed, 6 insertions(+)docs/system/introduction.rst +0
-0docs/system/introduction.rst virtualisation so we can use KVM inside the emulated guest. As the · line 165
Quoted 8 lines
docs/system/introduction.rst +5
-0@@ -158,6 +158,12 @@ virtualisation so we can use KVM inside the emulated guest. As the ``virt`` machine comes with some built in pflash devices we give them names so we can override the defaults later. +.. note:: + The ``pflash0`` and ``pflash1`` machine options are specific to the + ``virt`` machine type on Arm, RISC-V, and LoongArch architectures. + They are not available on x86 machines, which use ``-bios`` or + ``-pflash`` for firmware instead.No this is wrong.
Quoted 5 lines
The pflash0 and pflash1 properties apply to x86 pc & q35 machines too.
-pflash is a legacy syntax which remaps to pflash0 and pflash1 internally, but also applies to other machines which don't use the new pflash0/pflash1 properties.
I think it is probably worth having something in the intro text that makes the point that for QEMU all architectures and machines are potentially different, and that options and command lines that work on for example an x86 PC machine will not necessarily work on an Arm machine, and so on. But we should do that as a kind of general warning somewhere near the start.
The bug report notes that "./build/x86/qemu-system-x86_64 -M pc,help" does not list the pflash0 and pflash1 options. I think this is because we set these up as alias properties on the actual flash device object in
pc_pflash_create(), so they don't exist as class properties that "help" can introspect on.-- PMM
Quoted 37 lines · Peter Maydell
Quoted 30 lines · Daniel P. Berrangé
Quoted 17 lines · Linisha
The pflash0 and pflash1 machine options shown in the Aarch64 virt example are only available for virt machine types on Arm, RISC-V, and LoongArch architectures. Add a note to clarify this for users who may try these options on x86 machines and be confused when they are not available.
Resolves: https://gitlab.com/qemu-project/qemu/-/issues/3254
Signed-off-by Linisha <[email protected]>--- docs/system/introduction.rst | 6 ++++++ 1 file changed, 6 insertions(+)docs/system/introduction.rst +0
-0docs/system/introduction.rst virtualisation so we can use KVM inside the emulated guest. As the · line 165
Quoted 8 lines
docs/system/introduction.rst +5
-0@@ -158,6 +158,12 @@ virtualisation so we can use KVM inside the emulated guest. As the ``virt`` machine comes with some built in pflash devices we give them names so we can override the defaults later. +.. note:: + The ``pflash0`` and ``pflash1`` machine options are specific to the + ``virt`` machine type on Arm, RISC-V, and LoongArch architectures. + They are not available on x86 machines, which use ``-bios`` or + ``-pflash`` for firmware instead.No this is wrong.
Quoted 5 lines
The pflash0 and pflash1 properties apply to x86 pc & q35 machines too.
-pflash is a legacy syntax which remaps to pflash0 and pflash1 internally, but also applies to other machines which don't use the new pflash0/pflash1 properties.
Quoted 6 lines
I think it is probably worth having something in the intro text that makes the point that for QEMU all architectures and machines are potentially different, and that options and command lines that work on for example an x86 PC machine will not necessarily work on an Arm machine, and so on. But we should do that as a kind of general warning somewhere near the start.
That was the intention with the wording:
QEMU provides a rich and complex API which can be overwhelming to understand. While some architectures can boot something with just a disk image, those examples elide a lot of details with defaults that may not be optimal for modern systems.
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.
but it could probably be improved. Aside from working mostly on Arm I chose the example because the default PC command lines are very prone to using the old legacy shortcuts.
Quoted 8 lines
The bug report notes that "./build/x86/qemu-system-x86_64 -M pc,help" does not list the pflash0 and pflash1 options. I think this is because we set these up as alias properties on the actual flash device object in
pc_pflash_create(), so they don't exist as class properties that "help" can introspect on.-- PMM
Signature · 2 lines
Alex Bennée Virtualisation Tech Lead @ Linaro
PATCH v2 1/1 docs/system: add general note about architecture and machine differences
In reply to LinishaAdd 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.
---
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(+)
docs/system/introduction.rst +9 -0
@@ -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
Signature · 1 line
2.47.0.windows.1
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
CC Pierrick as docs maintainer.
Quoted 1 line · Linisha
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============
docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +
Not convinced many people will read this, but I gues it doesn't hurt.
Quoted 6 lines
docs/system/introduction.rst +0
-0.. _Accelerators: Virtualisation AcceleratorsSignature · 1 line
2.47.0.windows.1
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com ~~ https://hachyderm.io/@berrange :| |: https://libvirt.org ~~ https://entangle-photo.org :| |: https://pixelfed.art/berrange ~~ https://fstop138.berrange.com :|
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-0.. _Accelerators: Virtualisation AcceleratorsSignature · 1 line
2.47.0.windows.1With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used scripts/get_maintainer.pl -f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.
Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)
Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now scripts/get_maintainer.pl -f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.
Best regards,
Linisha
Quoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Hi Pierrick,
Quick correction to my last reply — I checked again more carefully and get_maintainer.pl -f docs/ still says "No maintainers found" on my tree (origin/master), even after git pull. It only lists recent contributors. So whatever change adds you to MAINTAINERS isn't in my tree yet — could you point me to the commit/branch?
Apologies for the confusion.
Best regards,
Linisha
Quoted 113 lines · linisha
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now
scripts/get_maintainer.pl-f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.Best regards,
LinishaQuoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Just to clear the confusion, attached the screenshot.
Best regards,
Linisha
Quoted 128 lines · linisha
Hi Pierrick,
Quick correction to my last reply — I checked again more carefully and get_maintainer.pl -f docs/ still says "No maintainers found" on my tree (origin/master), even after git pull. It only lists recent contributors. So whatever change adds you to
MAINTAINERSisn't in my tree yet — could you point me to the commit/branch?Apologies for the confusion.
Best regards,
LinishaQuoted 113 lines · linisha
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now
scripts/get_maintainer.pl-f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.Best regards,
LinishaQuoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Quoted 2 lines · linisha
Just to clear the confusion, attached the screenshot.
Hum interesting.
On my side, reproduced on a clean debian container:
$ git clone https://gitlab.com/qemu-project/qemu --depth=1 && cd qemu && ./scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)
Maybe we have a funny joke hiding there with mingw/windows.
Quoted 132 lines
Best regards,
LinishaQuoted 128 lines · linisha
Hi Pierrick,
Quick correction to my last reply — I checked again more carefully and get_maintainer.pl -f docs/ still says "No maintainers found" on my tree (origin/master), even after git pull. It only lists recent contributors. So whatever change adds you to
MAINTAINERSisn't in my tree yet — could you point me to the commit/branch?Apologies for the confusion.
Best regards,
LinishaQuoted 113 lines · linisha
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now
scripts/get_maintainer.pl-f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.Best regards,
LinishaQuoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Hmm that would explain it! I'm on Git Bash / MinGW on Windows, so there may indeed be a line-ending or Perl quirk affecting how the script parses MAINTAINERS. Good to know, I'll keep this in mind and double-check the MAINTAINERS file directly when picking CCs in the future, rather than relying solely on the script's output.
Quoted 150 lines · Pierrick Bouvier
Quoted 2 lines · linisha
Just to clear the confusion, attached the screenshot.
Hum interesting.
On my side, reproduced on a clean debian container:
$ git clone https://gitlab.com/qemu-project/qemu --depth=1 && cd qemu && ./scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Maybe we have a funny joke hiding there with mingw/windows.
Quoted 132 lines
Best regards,
LinishaQuoted 128 lines · linisha
Hi Pierrick,
Quick correction to my last reply — I checked again more carefully and get_maintainer.pl -f docs/ still says "No maintainers found" on my tree (origin/master), even after git pull. It only lists recent contributors. So whatever change adds you to
MAINTAINERSisn't in my tree yet — could you point me to the commit/branch?Apologies for the confusion.
Best regards,
LinishaQuoted 113 lines · linisha
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now
scripts/get_maintainer.pl-f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.Best regards,
LinishaQuoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Quoted 6 lines · linisha
Hmm that would explain it! I'm on Git Bash / MinGW on Windows, so there may indeed be a line-ending or Perl quirk affecting how the script parses
MAINTAINERS. Good to know, I'll keep this in mind and double-check theMAINTAINERSfile directly when picking CCs in the future, rather than relying solely on the script's output.
In case your (corporate) machine allows it, you can also use WSL to have a native Linux env instead of using MSYS2.
In my experience it works very well.
Quoted 152 lines
Quoted 150 lines · Pierrick Bouvier
Quoted 2 lines · linisha
Just to clear the confusion, attached the screenshot.
Hum interesting.
On my side, reproduced on a clean debian container:
$ git clone https://gitlab.com/qemu-project/qemu --depth=1 && cd qemu && ./scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Maybe we have a funny joke hiding there with mingw/windows.
Quoted 132 lines
Best regards,
LinishaQuoted 128 lines · linisha
Hi Pierrick,
Quick correction to my last reply — I checked again more carefully and get_maintainer.pl -f docs/ still says "No maintainers found" on my tree (origin/master), even after git pull. It only lists recent contributors. So whatever change adds you to
MAINTAINERSisn't in my tree yet — could you point me to the commit/branch?Apologies for the confusion.
Best regards,
LinishaQuoted 113 lines · linisha
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now
scripts/get_maintainer.pl-f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.Best regards,
LinishaQuoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
Re: [PATCH v2] docs/system: add general note about architecture and machine differences
Thanks for the tip!
Quoted 166 lines · Pierrick Bouvier
Quoted 6 lines · linisha
Hmm that would explain it! I'm on Git Bash / MinGW on Windows, so there may indeed be a line-ending or Perl quirk affecting how the script parses
MAINTAINERS. Good to know, I'll keep this in mind and double-check theMAINTAINERSfile directly when picking CCs in the future, rather than relying solely on the script's output.In case your (corporate) machine allows it, you can also use WSL to have a native Linux env instead of using MSYS2.
In my experience it works very well.Quoted 152 lines
Quoted 150 lines · Pierrick Bouvier
Quoted 2 lines · linisha
Just to clear the confusion, attached the screenshot.
Hum interesting.
On my side, reproduced on a clean debian container:
$ git clone https://gitlab.com/qemu-project/qemu --depth=1 && cd qemu && ./scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Maybe we have a funny joke hiding there with mingw/windows.
Quoted 132 lines
Best regards,
LinishaQuoted 128 lines · linisha
Hi Pierrick,
Quick correction to my last reply — I checked again more carefully and get_maintainer.pl -f docs/ still says "No maintainers found" on my tree (origin/master), even after git pull. It only lists recent contributors. So whatever change adds you to
MAINTAINERSisn't in my tree yet — could you point me to the commit/branch?Apologies for the confusion.
Best regards,
LinishaQuoted 113 lines · linisha
Hi Pierrick,
You're right — my tree was outdated. I just ran git pull and now
scripts/get_maintainer.pl-f docs/ does show you as maintainer for General Documentation. Sorry for the miss; I'll make sure to pull and re-check maintainers before sending future versions.Best regards,
LinishaQuoted 100 lines · Pierrick Bouvier
Quoted 11 lines · linisha
Hi Daniel, Pierrick,
Thank you, Daniel, for the Reviewed-by tag and the wrapping feedback.
Pierrick — I didn't intentionally remove anyone. I used
scripts/get_maintainer.pl-f docs/ which returned Peter Maydell, Philippe Mathieu-Daudé, Richard Henderson, Alex Bennée, and Cédric Le Goater, and I picked CCs from that list along with people who responded to v1. You weren't in the script's output, so I didn't know to include you. Apologies for the miss — I'll CC you on any future v3.Thanks for your answer.
Just to dig this further, is your tree up to date?
When running it on my side (from upstream/master), I get:
$ scripts/get_maintainer.pl -f docs/ Pierrick Bouvier <[email protected]> (maintainer:General Documenta...) [email protected] (open list:All patches CC here)Quoted 75 lines
Daniel — I'll send a v3 with the commit message body properly line-wrapped to 76 characters. Let me know if there are other changes you'd like at the same time.
Best regards, Linisha
Quoted 67 lines · Pierrick Bouvier
Quoted 2 lines · Daniel P. Berrangé
CC Pierrick as docs maintainer.
Thanks Daniel.
I wonder how I was not in original recipients for this patch. @Linisha: did you explicitly set list of recipients, or remove some people?
Quoted 56 lines · Linisha
Quoted 1 line
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.
Please ensure commit messages are line wrapped.
Quoted 25 lines
Suggested-by Peter Maydell <[email protected]>Signed-off-by Linisha <[email protected]>---
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(+)docs/system/introduction.rst +0
-0@@ -1,6 +1,15 @@ Introduction ============docs/system/introduction.rst line 12
Quoted 10 lines
docs/system/introduction.rst +9
-0+.. 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. +Not convinced many people will read this, but I gues it doesn't hurt.
Reviewed-by Daniel P. Berrangé <[email protected]>Quoted 6 lines
docs/system/introduction.rst +0
-1.. _Accelerators: Virtualisation Accelerators --2.47.0.windows.1
With regards,
Daniel
PATCH v3 1/1 docs/system: add general note about architecture and machine differences
In reply to LinishaAdd 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.
---
v3:
- Wrap commit message body at 76 characters (Daniel P. Berrangé)
- Add Reviewed-by: Daniel P. Berrangé
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(+)
docs/system/introduction.rst +9 -0
@@ -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
Re: [PATCH v3] docs/system: add general note about architecture and machine differences
Quoted 24 lines · Linisha
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 <[email protected]>Reviewed-by Daniel P. Berrangé <[email protected]>Signed-off-by Linisha <[email protected]>---
v3:
- Wrap commit message body at 76 characters (Daniel P. Berrangé)
- Add Reviewed-by: Daniel P. Berrangé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.
Quoted 3 lines
docs/system/introduction.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
Re: [PATCH v3] docs/system: add general note about architecture and machine differences
In reply to LinishaQuoted 24 lines · Linisha
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 <[email protected]>Reviewed-by Daniel P. Berrangé <[email protected]>Signed-off-by Linisha <[email protected]>---
v3:
- Wrap commit message body at 76 characters (Daniel P. Berrangé)
- Add Reviewed-by: Daniel P. Berrangé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.
Quoted 3 lines
docs/system/introduction.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
This was merged into master (20553466cc47af6a8c95f665b601fce3c852e503). Thank you for your contribution!
Regards,
Pierrick
Re: [PATCH v3] docs/system: add general note about architecture and machine differences
😊
linisha reacted via Gmail
<https://www.google.com/gmail/about/?utm_source=gmail-in-product&utm_medium=et&utm_campaign=emojireactionemail#app>
Quoted 29 lines · Pierrick Bouvier,
Quoted 24 lines · Linisha
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 <[email protected]>Reviewed-by Daniel P. Berrangé <[email protected]>Signed-off-by Linisha <[email protected]>---
v3:
- Wrap commit message body at 76 characters (Daniel P. Berrangé)
- Add Reviewed-by: Daniel P. Berrangé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.Quoted 3 lines
docs/system/introduction.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
Quoted 6 lines
This was merged into master (
20553466cc47af6a8c95f665b601fce3c852e503). Thank you for your contribution!Regards,
Pierrick
{
"emoji": "😊",
"version": 1
}