From 5fc251daebe2eda9e2bf032db877e4183065753f Mon Sep 17 00:00:00 2001 From: Dundar Goc Date: Sun, 1 May 2022 17:53:22 +0200 Subject: [PATCH] build(gen_vimdoc): abort if doxygen version is too old There have been a few instances where developers got confused as to why their generated documentation differs from the one generated by the CI. More often than not, the reason is that their doxygen version is older than 1.9.0, which is the current minimum version. Having a simple version check will help save future developers avoid this problem. --- scripts/gen_vimdoc.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/gen_vimdoc.py b/scripts/gen_vimdoc.py index f37198e96a..8d38382405 100755 --- a/scripts/gen_vimdoc.py +++ b/scripts/gen_vimdoc.py @@ -53,11 +53,19 @@ import logging from xml.dom import minidom MIN_PYTHON_VERSION = (3, 6) +MIN_DOXYGEN_VERSION = (1, 9, 0) if sys.version_info < MIN_PYTHON_VERSION: print("requires Python {}.{}+".format(*MIN_PYTHON_VERSION)) sys.exit(1) +doxygen_version = tuple([int(i) for i in subprocess.check_output(["doxygen", "-v"], + universal_newlines=True).split('.')]) + +if doxygen_version < MIN_DOXYGEN_VERSION: + print("requires Doxygen {}.{}.{}+".format(*MIN_DOXYGEN_VERSION)) + sys.exit(1) + # DEBUG = ('DEBUG' in os.environ) INCLUDE_C_DECL = ('INCLUDE_C_DECL' in os.environ) INCLUDE_DEPRECATED = ('INCLUDE_DEPRECATED' in os.environ)