[dpdk-dev] [PATCH v1] doc: remove warning with doxygen 1.9.7

[Bruce Richardson]

On Wed, May 31, 2023 at 04:49:04PM +0200, Thomas Monjalon wrote:
> 31/05/2023 16:07, Jerin Jacob:
> > On Wed, May 31, 2023 at 7:31 PM Thomas Monjalon <thomas at monjalon.net> wrote:
> > >
> > > 31/05/2023 15:21, Jerin Jacob:
> > > > On Wed, May 31, 2023 at 6:17 PM <jerinj at marvell.com> wrote:
> > > > >
> > > > > 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.
> > > >
> > > > loongarch-compilation reported a build issue  at
> > > > http://mails.dpdk.org/archives/test-report/2023-May/402940.html
> > > > https://mesonbuild.com/Reference-manual_returned_external_program.html#external_programversion
> > > > introduced in 0.62 version, so not sure how we can do version check
> > > > without that.
> > > >
> > > > Another option is to just remove HTIML_TIMESTAMP from config file.
> > > > Since 1.8.9 doxgen version,
> > > > it is disabled by default.
> > > >
> > > > Thoughts?
> > >
> > > No need to disable if it is already disabled by default.
> > > What was the default of the old HTML_TIMESTAMP?
> > 
> > Prior to doxygen Release_1_8_9_1-64-g3f2e8a306 it is enabled by default.
> 
> Then it would be better to keep HTML_TIMESTAMP until doxygen 1.9
> and don't add TIMESTAMP for new versions.
> 

Sorry for late arrival in the discussion.

I am not sure it's worth going to all that trouble. If the option is
disabled by default in all new versions of doxygen, then we don't have an
issue with the official DPDK docs on the website being any different if we
just drop the option from our config. All that would happen is that any
individual developer/user generating the docs with an older doxygen, will
get their HTML output timestampted in the footer.

Not a big deal, to my mind. Therefore I suggest just removing the option,
and being done with it. Once we put in the version check code, it's nigh on
impossible to remove it as it gets forgotten.

/Bruce