diff mbox series

[PATCH-for-5.2,1/4] docs/system: Deprecate raspi2/raspi3 machine aliases

Message ID 20201120152140.2493197-2-f4bug@amsat.org
State New
Headers show
Series docs/system/arm: Document raspi/tosa boards | expand

Commit Message

Philippe Mathieu-Daudé Nov. 20, 2020, 3:21 p.m. UTC
Since commit aa35ec2213b ("hw/arm/raspi: Use more specific
machine names") the raspi2/raspi3 machines have been renamed
as raspi2b/raspi3b.

Note, rather than the raspi3b, the raspi3ap introduced in
commit 5be94252d34 ("hw/arm/raspi: Add the Raspberry Pi 3
model A+") is a closer match to what QEMU models, but only
provides 512 MB of RAM.

As more Raspberry Pi 2/3 models are emulated, in order
to avoid confusion, deprecate the raspi2/raspi3 machine
aliases.

ACKed-by: Peter Krempa <pkrempa@redhat.com>
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 docs/system/deprecated.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Peter Maydell Nov. 20, 2020, 4:46 p.m. UTC | #1
On Fri, 20 Nov 2020 at 15:21, Philippe Mathieu-Daudé <f4bug@amsat.org> wrote:
>
> Since commit aa35ec2213b ("hw/arm/raspi: Use more specific
> machine names") the raspi2/raspi3 machines have been renamed
> as raspi2b/raspi3b.
>
> Note, rather than the raspi3b, the raspi3ap introduced in
> commit 5be94252d34 ("hw/arm/raspi: Add the Raspberry Pi 3
> model A+") is a closer match to what QEMU models, but only
> provides 512 MB of RAM.
>
> As more Raspberry Pi 2/3 models are emulated, in order
> to avoid confusion, deprecate the raspi2/raspi3 machine
> aliases.
>
> ACKed-by: Peter Krempa <pkrempa@redhat.com>
> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> ---
>  docs/system/deprecated.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
> index d98464098f5..d1bc03d7e61 100644
> --- a/docs/system/deprecated.rst
> +++ b/docs/system/deprecated.rst
> @@ -346,6 +346,13 @@ This machine has been renamed ``fuloong2e``.
>  These machine types are very old and likely can not be used for live migration
>  from old QEMU versions anymore. A newer machine type should be used instead.
>
> +Raspberry Pi ``raspi2`` and ``raspi3`` machines (since 5.2)
> +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
> +
> +The Raspberry Pi machines come in various models (A, A+, B, B+). To be able
> +to distinct which model is used, the ``raspi2`` and ``raspi3`` machines  have

"to distinguish which model QEMU is implementing"

> +been respectively renamed ``raspi2b`` and ``raspi3b``.

"been renamed ``raspi2b`` and ``raspi3b`` respectively"

(or just drop 'respectively' altogether and assume the reader can
figure out which is which ;-))


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

thanks
-- PMM
diff mbox series

Patch

diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index d98464098f5..d1bc03d7e61 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -346,6 +346,13 @@  This machine has been renamed ``fuloong2e``.
 These machine types are very old and likely can not be used for live migration
 from old QEMU versions anymore. A newer machine type should be used instead.
 
+Raspberry Pi ``raspi2`` and ``raspi3`` machines (since 5.2)
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+The Raspberry Pi machines come in various models (A, A+, B, B+). To be able
+to distinct which model is used, the ``raspi2`` and ``raspi3`` machines  have
+been respectively renamed ``raspi2b`` and ``raspi3b``.
+
 Device options
 --------------