[dpdk-dev] [PATCH v1] doc: remove warning with doxygen 1.9.7
jerinj at marvell.com
jerinj at marvell.com
Fri Jun 2 10:30:32 CEST 2023
From: Jerin Jacob <jerinj at marvell.com>
Since doxygen 1.9.7 version, HTML_TIMESTAMP configuration option
changed to TIMESTAMP [2]. Fixed the following warning[1] by providing
the correct configuration option based on doxygen version.
[1]
Warning: Tag 'HTML_TIMESTAMP' at line 115 of file 'doc/api/doxy-api.conf'
has become obsolete.
[2]
https://www.doxygen.nl/manual/config.html#cfg_timestamp
Cc: stable at dpdk.org
Signed-off-by: Jerin Jacob <jerinj at marvell.com>
---
v2:
- use run_command() as https://mesonbuild.com/Reference-manual_returned_external_program.html#external_programversion
introduced in 0.62 version and DPDK min meson version is 0.53.2
doc/api/doxy-api.conf.in | 2 +-
doc/api/meson.build | 7 +++++++
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index d230a19e1f..60e582d8fc 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -111,7 +111,7 @@ GENERATE_DEPRECATEDLIST = YES
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
-HTML_TIMESTAMP = NO
+ at TS_PREFIX@TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = YES
HTML_EXTRA_STYLESHEET = @TOPDIR@/doc/api/custom.css
SEARCHENGINE = YES
diff --git a/doc/api/meson.build b/doc/api/meson.build
index 2876a78a7e..4d1161d847 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -41,6 +41,13 @@ if get_option('werror')
cdata.set('WARN_AS_ERROR', 'YES')
endif
+doxygen_version = run_command('doxygen', '--version', check: true).stdout().strip()
+if doxygen_version.version_compare('>=1.9.7')
+ cdata.set('TS_PREFIX', '')
+else
+ cdata.set('TS_PREFIX', 'HTML_')
+endif
+
doxy_conf = configure_file(input: 'doxy-api.conf.in',
output: 'doxy-api.conf',
configuration: cdata)
--
2.40.1
More information about the dev
mailing list