diff mbox series

[v3] doc: remove warning with doxygen 1.9.7

Message ID 20230602110659.214503-1-jerinj@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] 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/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-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-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS

Commit Message

Jerin Jacob Kollanukkaran June 2, 2023, 11:06 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
removing TIMESTAMP options all together as all new versions(since 1.8.9)
of doxygen this option is disabled by default. Another option was
considered to have this configuration option based on version check, which
may not be worth having it, especially, external_program.version()
API introduced in 0.62.0 version of meson.

[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>
---
v3:
- Based on Bruce's feedback, just removed the option all together to
  avoid special handling.
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 | 1 -
 1 file changed, 1 deletion(-)

Comments

Bruce Richardson June 2, 2023, 11:16 a.m. UTC | #1 
On Fri, Jun 02, 2023 at 04:36:59PM +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
> removing TIMESTAMP options all together as all new versions(since 1.8.9)
> of doxygen this option is disabled by default. Another option was
> considered to have this configuration option based on version check, which
> may not be worth having it, especially, external_program.version()
> API introduced in 0.62.0 version of meson.
> 
> [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>
> ---

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Thomas Monjalon June 12, 2023, 5:19 p.m. UTC | #2 
02/06/2023 13:16, Bruce Richardson:
> On Fri, Jun 02, 2023 at 04:36:59PM +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
> > removing TIMESTAMP options all together as all new versions(since 1.8.9)
> > of doxygen this option is disabled by default. Another option was
> > considered to have this configuration option based on version check, which
> > may not be worth having it, especially, external_program.version()
> > API introduced in 0.62.0 version of meson.
> > 
> > [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>
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index d230a19e1f..deea7b747d 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -111,7 +111,6 @@  GENERATE_DEPRECATEDLIST = YES
 VERBATIM_HEADERS        = NO
 ALPHABETICAL_INDEX      = NO
 
-HTML_TIMESTAMP          = NO
 HTML_DYNAMIC_SECTIONS   = YES
 HTML_EXTRA_STYLESHEET   = @TOPDIR@/doc/api/custom.css
 SEARCHENGINE            = YES