patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: Jerin Jacob <jerinjacobk@gmail.com>, <jerinj@marvell.com>,
	<dev@dpdk.org>,  <david.marchand@redhat.com>, <stable@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v1] doc: remove warning with doxygen 1.9.7
Date: Fri, 2 Jun 2023 09:40:17 +0100	[thread overview]
Message-ID: <ZHmq8bXVsppO0NCJ@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <2232141.KTMopqUuYO@thomas>

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@monjalon.net> wrote:
> > >
> > > 31/05/2023 15:21, Jerin Jacob:
> > > > On Wed, May 31, 2023 at 6:17 PM <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.
> > > >
> > > > 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

  parent reply	other threads:[~2023-06-02  8:40 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 [this message]
2023-06-02  8:30 ` jerinj
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=ZHmq8bXVsppO0NCJ@bricha3-MOBL.ger.corp.intel.com \
    --to=bruce.richardson@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=jerinj@marvell.com \
    --cc=jerinjacobk@gmail.com \
    --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).