diff mbox series

[v1] doc: remove warning with doxygen 1.9.7

Message ID 20230602083032.4160601-1-jerinj@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v1] doc: remove warning with doxygen 1.9.7 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-unit-testing success Testing PASS

Commit Message

Jerin Jacob Kollanukkaran June 2, 2023, 8:30 a.m. UTC 
  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(-)

Comments

Bruce Richardson June 2, 2023, 8:41 a.m. UTC | #1 
On Fri, Jun 02, 2023 at 02:00:32PM +0530, jerinj@marvell.com wrote:
> 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

As explained in previous email, belately sent in reply to v1, I think we
should just drop this line, and not worry about version checks.

/Bruce
Jerin Jacob June 2, 2023, 8:43 a.m. UTC | #2 
On Fri, Jun 2, 2023 at 2:11 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> On Fri, Jun 02, 2023 at 02:00:32PM +0530, jerinj@marvell.com wrote:
> > 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
>
> As explained in previous email, belately sent in reply to v1, I think we
> should just drop this line, and not worry about version checks.

Yes. I think that is better. I will send new version to remove it.

>
> /Bruce
>
diff mbox series

Patch

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)