docs/system: Deprecate raspi2/raspi3 machine aliases

[PATCH] docs/system: Deprecate raspi2/raspi3 machine aliases

Posted by Philippe Mathieu-Daudé 3 years, 6 months ago

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``.
+
 Device options
 --------------
 
-- 
2.26.2

Re: [PATCH] docs/system: Deprecate raspi2/raspi3 machine aliases

Posted by Philippe Mathieu-Daudé 3 years, 6 months ago

On 10/19/20 10:21 AM, Philippe Mathieu-Daudé 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.

Note that the raspi3ap (posted yesterday) is a closer match
to what we model than the raspi3b. But the B model has 1GB
of RAM, while the A+ has 512MB. As a bigger amount of RAM
is probably more useful to our users, I'm not suggesting
replacing the raspi3 alias.

> 
> 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``.
> +
>   Device options
>   --------------
>   
>

Re: [PATCH] docs/system: Deprecate raspi2/raspi3 machine aliases

Posted by Peter Krempa 3 years, 6 months ago

On Mon, Oct 19, 2020 at 10:21:21 +0200, Philippe Mathieu-DaudÃ© 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``.
> +

libvirt doesn't do any interpretation for these machine types, so we
don't need to add any compatibility. Obviously users of these machine
types might end up with broken configs if they were using them, but
that's qemu's decision.

On behalf of libvirt:

ACKed-by: Peter Krempa <pkrempa@redhat.com>

Re: [PATCH] docs/system: Deprecate raspi2/raspi3 machine aliases

Posted by Peter Maydell 3 years, 5 months ago

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

Re: [PATCH] docs/system: Deprecate raspi2/raspi3 machine aliases

Posted by Philippe Mathieu-Daudé 3 years, 5 months ago

On 10/30/20 3:33 PM, Peter Maydell wrote:
> 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.

I indeed forgot to run 'make man/html'.

Re: [PATCH] docs/system: Deprecate raspi2/raspi3 machine aliases

Posted by Philippe Mathieu-Daudé 3 years, 5 months ago

Ping? (patch Acked).

On 10/19/20 10:21 AM, Philippe Mathieu-Daudé 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``.
> +
>   Device options
>   --------------
>   
>