diff mbox series

docs/system: Deprecate raspi2/raspi3 machine aliases

Message ID 20201019082121.1544550-1-f4bug@amsat.org
State Accepted
Commit 155e1c82ed0da265dbc6cd499a2b2552a5388a9c
Headers show
Series docs/system: Deprecate raspi2/raspi3 machine aliases | expand

Commit Message

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

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

Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 docs/system/deprecated.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Peter Maydell Oct. 30, 2020, 2:33 p.m. UTC | #1
On Mon, 19 Oct 2020 at 09:23, 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.

>

> As more Raspberry Pi 2/3 models are emulated, in order

> to avoid confusion deprecate the raspi2/raspi3 machine

> aliases.

>

> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>

> ---

>  docs/system/deprecated.rst | 5 +++++

>  1 file changed, 5 insertions(+)

>

> diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst

> index 905628f3a0c..f0c7aaeb2ff 100644

> --- a/docs/system/deprecated.rst

> +++ b/docs/system/deprecated.rst

> @@ -355,6 +355,11 @@ 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)

> +'''''''''''''''''''''''''''''''''''''

> +

> +These machines have been respectively renamed ``raspi2b`` and ``raspi3b``.

> +


This isn't valid rST syntax, which requires the underlining to
be exactly the same length as the title string it underlines:

Warning, treated as error:
/home/petmay01/linaro/qemu-from-laptop/qemu/docs/system/deprecated.rst:348:Title
underline too short.

Raspberry Pi ``raspi2`` and ``raspi3`` machines (since 5.2)
'''''''''''''''''''''''''''''''''''''

I also think it would be helpful to have at least a sentence
saying why we've renamed the machines.

thanks
-- PMM
diff mbox series

Patch

diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index 905628f3a0c..f0c7aaeb2ff 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -355,6 +355,11 @@  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)
+'''''''''''''''''''''''''''''''''''''
+
+These machines have been respectively renamed ``raspi2b`` and ``raspi3b``.
+
 Device options
 --------------