mbox series

[0/4] docs: automated info about machine deprecation/removal info

Message ID 20250225200423.2350471-1-berrange@redhat.com (mailing list archive)
Headers show
Series docs: automated info about machine deprecation/removal info | expand

Message

Daniel P. Berrangé Feb. 25, 2025, 8:04 p.m. UTC 
Since we deprecate and remove versioned machine types on a fixed
schedule, we can automatically ensure that the docs reflect the
latest version info, rather than requiring manual updates on each
dev cycle.

The first patch in this series fixes the logic to ensure dev snapshots
and release candidates don't have an off-by-1 error in setting
deprecation and removal thresholds - they must predict the next formal
release version number.

The remaining patches deal with the docs stuff.

The first two patches can be applied in this release (10.0) if desired.

The third patch documents deletion logic that doesn't come into effect
until the 10.1.0 release is out, so we shouldn't include that commit
in 10.0.0. It can be applied after the following is reverted:

  commit c9fd2d9a48ee3c195cf83cc611b87b09f02f0013
  Author: Daniel P. Berrangé <berrange@redhat.com>
  Date:   Thu Jun 20 17:57:37 2024 +0100

    include/hw: temporarily disable deletion of versioned machine types

    The new deprecation and deletion policy for versioned machine types is
    being introduced in QEMU 9.1.0.

    Under the new policy a number of old machine types (any prior to 2.12)
    would be liable for immediate deletion which would be a violation of our
    historical deprecation and removal policy

    Thus automatic deletions (by skipping QOM registration) are temporarily
    gated on existance of the env variable "QEMU_DELETE_MACHINES" / QEMU
    version number >= 10.1.0. This allows opt-in testing of the automatic
    deletion logic, while activating it fully in QEMU >= 10.1.0.

    This whole commit should be reverted in the 10.1.0 dev cycle or shortly
    thereafter.

Daniel P. Berrangé (4):
  include/hw/boards: cope with dev/rc versions in deprecation checks
  docs/about/deprecated: auto-generate a note for versioned machine
    types
  docs/about/removed-features: auto-generate a note for versioned
    machine types
  include/hw/boards: add warning about changing deprecation logic

 docs/about/deprecated.rst       |  7 ++++++
 docs/about/removed-features.rst | 10 +++++----
 docs/conf.py                    | 39 ++++++++++++++++++++++++++++++++-
 include/hw/boards.h             | 39 +++++++++++++++++++++++++++++++--
 4 files changed, 88 insertions(+), 7 deletions(-)