From: <jerinj@marvell.com>
To: <dev@dpdk.org>
Cc: <thomas@monjalon.net>, <bruce.richardson@intel.com>,
Jerin Jacob <jerinj@marvell.com>, <stable@dpdk.org>
Subject: [dpdk-dev] [PATCH v1] doc: remove warning with doxygen 1.9.7
Date: Fri, 2 Jun 2023 14:00:32 +0530 [thread overview]
Message-ID: <20230602083032.4160601-1-jerinj@marvell.com> (raw)
In-Reply-To: <20230531124648.1358005-1-jerinj@marvell.com>
From: Jerin Jacob <jerinj@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@dpdk.org
Signed-off-by: Jerin Jacob <jerinj@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
+@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
next prev parent reply other threads:[~2023-06-02 8:30 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-31 12:46 jerinj
2023-05-31 13:21 ` Jerin Jacob
2023-05-31 14:01 ` Thomas Monjalon
2023-05-31 14:07 ` Jerin Jacob
2023-05-31 14:49 ` Thomas Monjalon
2023-05-31 14:54 ` Jerin Jacob
2023-05-31 15:06 ` Thomas Monjalon
2023-06-02 8:40 ` Bruce Richardson
2023-06-02 8:30 ` jerinj [this message]
2023-06-02 8:41 ` Bruce Richardson
2023-06-02 8:43 ` Jerin Jacob
2023-06-02 11:06 ` [dpdk-dev] [PATCH v3] " jerinj
2023-06-02 11:16 ` Bruce Richardson
2023-06-12 17:19 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230602083032.4160601-1-jerinj@marvell.com \
--to=jerinj@marvell.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=stable@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).