[PATCH v2 4/5] docs/about/removed-features: auto-generate a note for versioned machine types

Daniel P. Berrangé via Devel posted 5 patches 4 months, 1 week ago
There is a newer version of this series
[PATCH v2 4/5] docs/about/removed-features: auto-generate a note for versioned machine types
Posted by Daniel P. Berrangé 4 months, 1 week ago
We remove versioned machine types on a fixed schedule. This allows us
to auto-generate a paragraph in the removed-features.rst document that
always has accurate version info.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/about/removed-features.rst | 10 ++++++----
 docs/conf.py                    |  2 ++
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.rst
index 790a5e481c..59fec3c9a1 100644
--- a/docs/about/removed-features.rst
+++ b/docs/about/removed-features.rst
@@ -981,10 +981,12 @@ from Linux in 2021, and is not supported anymore by QEMU either.
 System emulator machines
 ------------------------
 
-Note: Versioned machine types that have been introduced in a QEMU version
-that has initially been released more than 6 years before are considered
-obsolete and will be removed without further notice in this document.
-Please use newer machine types instead.
+Versioned machine types (aarch64, arm, i386, m68k, ppc, ppc64, s390x, x86_64)
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+In accordance with our versioned machine type deprecation policy, all machine
+types with version |VER_MACHINE_DELETION_VERSION|, or older, have been
+removed.
 
 ``s390-virtio`` (removed in 2.6)
 ''''''''''''''''''''''''''''''''
diff --git a/docs/conf.py b/docs/conf.py
index 60dcf2a541..248ff8cf5d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -137,6 +137,7 @@
         minor += 1
 
 ver_machine_deprecation_version = "%d.%d.0" % (major - 3, minor)
+ver_machine_deletion_version = "%d.%d.0" % (major - 6, minor)
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -170,6 +171,7 @@
 vars = {
     "CONFDIR": confdir,
     "VER_MACHINE_DEPRECATION_VERSION": ver_machine_deprecation_version,
+    "VER_MACHINE_DELETION_VERSION": ver_machine_deletion_version,
 }
 
 rst_epilog = "".join([
-- 
2.49.0


Re: [PATCH v2 4/5] docs/about/removed-features: auto-generate a note for versioned machine types
Posted by Thomas Huth 4 months, 1 week ago
On 29/04/2025 15.15, Daniel P. Berrangé wrote:
> We remove versioned machine types on a fixed schedule. This allows us
> to auto-generate a paragraph in the removed-features.rst document that
> always has accurate version info.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   docs/about/removed-features.rst | 10 ++++++----
>   docs/conf.py                    |  2 ++
>   2 files changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.rst
> index 790a5e481c..59fec3c9a1 100644
> --- a/docs/about/removed-features.rst
> +++ b/docs/about/removed-features.rst
> @@ -981,10 +981,12 @@ from Linux in 2021, and is not supported anymore by QEMU either.
>   System emulator machines
>   ------------------------
>   
> -Note: Versioned machine types that have been introduced in a QEMU version
> -that has initially been released more than 6 years before are considered
> -obsolete and will be removed without further notice in this document.
> -Please use newer machine types instead.
> +Versioned machine types (aarch64, arm, i386, m68k, ppc, ppc64, s390x, x86_64)

I think we don't have versioned machine types for 32-bit ppc, do we?
(pseries is 64-bit only)

  Thomas


> +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
> +
> +In accordance with our versioned machine type deprecation policy, all machine
> +types with version |VER_MACHINE_DELETION_VERSION|, or older, have been
> +removed.
>   
>   ``s390-virtio`` (removed in 2.6)
>   ''''''''''''''''''''''''''''''''
> diff --git a/docs/conf.py b/docs/conf.py
> index 60dcf2a541..248ff8cf5d 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -137,6 +137,7 @@
>           minor += 1
>   
>   ver_machine_deprecation_version = "%d.%d.0" % (major - 3, minor)
> +ver_machine_deletion_version = "%d.%d.0" % (major - 6, minor)
>   
>   # The language for content autogenerated by Sphinx. Refer to documentation
>   # for a list of supported languages.
> @@ -170,6 +171,7 @@
>   vars = {
>       "CONFDIR": confdir,
>       "VER_MACHINE_DEPRECATION_VERSION": ver_machine_deprecation_version,
> +    "VER_MACHINE_DELETION_VERSION": ver_machine_deletion_version,
>   }
>   
>   rst_epilog = "".join([