doc: remove warning with doxygen 1.9.7
PATCH 1/1 doc: remove warning with doxygen 1.9.7
From: Jerin Jacob <[email protected]>
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
--- doc/api/doxy-api.conf.in | 2 +- doc/api/meson.build | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-)
doc/api/doxy-api.conf.in +1 -1
@@ -112,7 +112,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
doc/api/meson.build +6 -0
@@ -41,6 +41,12 @@ if get_option('werror') cdata.set('WARN_AS_ERROR', 'YES') endif +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)
Signature · 1 line
2.40.1
Quoted 6 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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?
commit 3f2e8a3067712b025623e4420e6eb161febfd42b
Author: Dimitri van Heesch <[email protected]> Date: Thu Mar 5 21:54:12 2015 +0100
Bug 745439 - PATCH: please consider making doxygen output byte for
byte identical between individual runs by default
src/config.xml +2 -3
@@ -1889,13 +1889,13 @@ hr.footer { ]]> </docs> </option> - <option type='bool' id='HTML_TIMESTAMP' defval='1' depends='GENERATE_HTML'> + <option type='bool' id='HTML_TIMESTAMP' defval='0' depends='GENERATE_HTML'> <docs> <![CDATA[ If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of each generated HTML page will contain the date and time when the page - was generated. Setting this to \c NO can help when comparing the output of - multiple runs. + was generated. Setting this to \c YES can help to show when doxygen
was last run
+ and thus if the documentation is up to date.
]]>
</docs>
</option>[(HEAD detached at Release_1_9_5)]dell[doxygen] $ git describe 3f2e8a3067712b025623e4420e6eb161febfd42b Release_1_8_9_1-64-g3f2e8a306
Quoted 49 lines
[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_timestampSigned-off-by Jerin Jacob <[email protected]>--- doc/api/doxy-api.conf.in | 2 +- doc/api/meson.build | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-)doc/api/doxy-api.conf.in +1
-1@@ -112,7 +112,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 = YESdoc/api/meson.build +6
-1@@ -41,6 +41,12 @@ if get_option('werror') cdata.set('WARN_AS_ERROR', 'YES') endif +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
31/05/2023 15:21, Jerin Jacob:
Quoted 14 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
Quoted 6 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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.
Quoted 5 lines
Another option is to just remove
HTIML_TIMESTAMPfrom 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?
Quoted 16 lines · Thomas Monjalon
31/05/2023 15:21, Jerin Jacob:
Quoted 14 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
Quoted 6 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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.
Quoted 8 lines
Quoted 5 lines
Another option is to just remove
HTIML_TIMESTAMPfrom 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.
Quoted 2 lines
31/05/2023 16:07, Jerin Jacob:
Quoted 21 lines · Thomas Monjalon
Quoted 20 lines
31/05/2023 15:21, Jerin Jacob:
Quoted 18 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
Quoted 6 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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_TIMESTAMPfrom config file. Since 1.8.9 doxgen version,
it is disabled by default.
Quoted 6 lines
Quoted 4 lines
Quoted 1 line
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.
Quoted 25 lines · Thomas Monjalon
31/05/2023 16:07, Jerin Jacob:
Quoted 23 lines · Thomas Monjalon
Quoted 22 lines
31/05/2023 15:21, Jerin Jacob:
Quoted 19 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
Quoted 6 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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_TIMESTAMPfrom config file. Since 1.8.9 doxgen version,
it is disabled by default.Thoughts?
Quoted 7 lines
Quoted 4 lines
Quoted 2 lines
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_TIMESTAMPuntil doxygen 1.9 and don't add TIMESTAMP for new versions.
https://mesonbuild.com/Reference-manual_returned_external_program.html#external_programversion
introduced in 0.62 version. Thats is one issue to check doxgen version in meson code to do something based
on version.
Quoted 3 lines
31/05/2023 16:54, Jerin Jacob:
Quoted 31 lines · Thomas Monjalon
Quoted 30 lines
31/05/2023 16:07, Jerin Jacob:
Quoted 27 lines · Thomas Monjalon
Quoted 16 lines
31/05/2023 15:21, Jerin Jacob:
Quoted 14 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
Quoted 6 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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.Quoted 8 lines
Quoted 5 lines
Another option is to just remove
HTIML_TIMESTAMPfrom 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.
Quoted 7 lines
Quoted 2 lines
Then it would be better to keep
HTML_TIMESTAMPuntil doxygen 1.9 and don't add TIMESTAMP for new versions.https://mesonbuild.com/Reference-manual_returned_external_program.html#external_programversion
introduced in 0.62 version. Thats is one issue to check doxgen version in meson code to do something based
on version.
It should be possible to check version without using this new Meson feature. Look at what is done for "binutils_ok" as an example.
Quoted 24 lines · Thomas Monjalon
31/05/2023 16:07, Jerin Jacob:
Quoted 23 lines · Thomas Monjalon
Quoted 22 lines
31/05/2023 15:21, Jerin Jacob:
Quoted 19 lines · On Wed, May 31, 2023 at 6:17 PM <[email protected]> wrote:
Quoted 6 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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_TIMESTAMPfrom config file. Since 1.8.9 doxgen version,
it is disabled by default.Thoughts?
Quoted 8 lines
Quoted 4 lines
Quoted 2 lines
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_TIMESTAMPuntil 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
PATCH 1/1 doc: remove warning with doxygen 1.9.7
In reply to [email protected]From: Jerin Jacob <[email protected]>
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
---
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(-)
doc/api/doxy-api.conf.in +1 -1
@@ -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
doc/api/meson.build +7 -0
@@ -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)
Signature · 1 line
2.40.1
Quoted 30 lines · On Fri, Jun 02, 2023 at 02:00:32PM +0530, [email protected] wrote:
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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_timestampSigned-off-by Jerin Jacob <[email protected]>---
v2:
- userun_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.2doc/api/doxy-api.conf.in | 2 +- doc/api/meson.build | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-)doc/api/doxy-api.conf.in +0
-0
doc/api/doxy-api.conf.in GENERATE_DEPRECATEDLIST = YES · line 114
Quoted 5 lines
doc/api/doxy-api.conf.in +1
-1@@ -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
Quoted 35 lines · Bruce Richardson
Quoted 33 lines · On Fri, Jun 02, 2023 at 02:00:32PM +0530, [email protected] wrote:
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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_timestampSigned-off-by Jerin Jacob <[email protected]>---
v2:
- userun_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.2doc/api/doxy-api.conf.in | 2 +- doc/api/meson.build | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-)doc/api/doxy-api.conf.in +0
-0@@ -111,7 +111,7 @@ GENERATE_DEPRECATEDLIST = YES VERBATIM_HEADERS = NO ALPHABETICAL_INDEX = NO
Quoted 5 lines
doc/api/doxy-api.conf.in GENERATE_DEPRECATEDLIST = YES · line 114
Quoted 2 lines
doc/api/doxy-api.conf.in +1
-1-HTML_TIMESTAMP = NO +@TS_PREFIX@TIMESTAMP = NOAs 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.
Quoted 3 lines
/Bruce
PATCH v3 1/1 doc: remove warning with doxygen 1.9.7
In reply to [email protected]From: Jerin Jacob <[email protected]>
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
---
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(-)
doc/api/doxy-api.conf.in +0 -1
@@ -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
Signature · 1 line
2.40.1
Quoted 14 lines · On Fri, Jun 02, 2023 at 04:36:59PM +0530, [email protected] wrote:
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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.
Quoted 7 lines
[2]
https://www.doxygen.nl/manual/config.html#cfg_timestampSigned-off-by Jerin Jacob <[email protected]>---
Thomas Monjalon
Applied02/06/2023 13:16, Bruce Richardson:
Quoted 15 lines · On Fri, Jun 02, 2023 at 04:36:59PM +0530, [email protected] wrote:
Quoted 14 lines
From: Jerin Jacob <[email protected]>
Since doxygen 1.9.7 version,
HTML_TIMESTAMPconfiguration 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.
Quoted 8 lines
Quoted 6 lines
[2]
https://www.doxygen.nl/manual/config.html#cfg_timestampSigned-off-by Jerin Jacob <[email protected]>Acked-by Bruce Richardson <[email protected]>
Applied, thanks.