diff options
| author | Daniel P. Berrangé <berrange@redhat.com> | 2025-02-25 19:41:16 +0000 |
|---|---|---|
| committer | Daniel P. Berrangé <berrange@redhat.com> | 2025-05-08 17:11:16 +0100 |
| commit | 3fbb0a1397a9acea523f3c8062df8c6f8032788d (patch) | |
| tree | 5ab4f971119590bda381db6a94bbd69db0b7dded | |
| parent | 83e256c0df7433c05d28b11690323fba7ad9dbf0 (diff) | |
| download | qemu-3fbb0a1397a9acea523f3c8062df8c6f8032788d.zip qemu-3fbb0a1397a9acea523f3c8062df8c6f8032788d.tar.gz qemu-3fbb0a1397a9acea523f3c8062df8c6f8032788d.tar.bz2 | |
include/hw/boards: add warning about changing deprecation logic
If we change the deprecation logic in include/hw/boards.h, we must make
a corresponding change to docs/conf.py and docs/about/deprecated.rst.
Add comments to these files as a warning to future maintainers to keep
these files in sync.
Tested-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Thomas Huth <thuth@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | include/hw/boards.h | 6 |
2 files changed, 9 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 248ff8c..f892a6e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -136,6 +136,10 @@ if micro >= 50: else: minor += 1 +# These thresholds must match the constants +# MACHINE_VER_DELETION_MAJOR & MACHINE_VER_DEPRECATION_MAJOR +# defined in include/hw/boards.h and the introductory text in +# docs/about/deprecated.rst ver_machine_deprecation_version = "%d.%d.0" % (major - 3, minor) ver_machine_deletion_version = "%d.%d.0" % (major - 6, minor) diff --git a/include/hw/boards.h b/include/hw/boards.h index a6784fe..a7b1fcf 100644 --- a/include/hw/boards.h +++ b/include/hw/boards.h @@ -636,7 +636,11 @@ struct MachineState { /* * How many years/major releases for each phase * of the life cycle. Assumes use of versioning - * scheme where major is bumped each year + * scheme where major is bumped each year. + * + * These values must match the ver_machine_deprecation_version + * and ver_machine_deletion_version logic in docs/conf.py and + * the text in docs/about/deprecated.rst */ #define MACHINE_VER_DELETION_MAJOR 6 #define MACHINE_VER_DEPRECATION_MAJOR 3 |