summary refs log tree commit diff stats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorDaniel P. Berrangé <berrange@redhat.com>2025-02-25 19:41:16 +0000
committerDaniel P. Berrangé <berrange@redhat.com>2025-05-08 17:11:16 +0100
commit3fbb0a1397a9acea523f3c8062df8c6f8032788d (patch)
tree5ab4f971119590bda381db6a94bbd69db0b7dded /docs/conf.py
parent83e256c0df7433c05d28b11690323fba7ad9dbf0 (diff)
downloadfocaccia-qemu-3fbb0a1397a9acea523f3c8062df8c6f8032788d.tar.gz
focaccia-qemu-3fbb0a1397a9acea523f3c8062df8c6f8032788d.zip
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>
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 248ff8cf5d..f892a6e1da 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)