From: Bruce Richardson <bruce.richardson@intel.com>
To: Robin Jarry <rjarry@redhat.com>
Cc: dev@dpdk.org, "Jeremy Spewock" <jspewock@iol.unh.edu>,
"Luca Vizzarro" <luca.vizzarro@arm.com>,
"Dean Marx" <dmarx@iol.unh.edu>,
"Thomas Monjalon" <thomas@monjalon.net>,
"Juraj Linkeš" <juraj.linkes@pantheon.tech>
Subject: Re: [PATCH dpdk] meson: properly disable docs
Date: Tue, 22 Oct 2024 16:25:37 +0100 [thread overview]
Message-ID: <ZxfD8XQvEiwc1Qz1@bricha3-mobl1.ger.corp.intel.com> (raw)
In-Reply-To: <20241022151142.246535-2-rjarry@redhat.com>
On Tue, Oct 22, 2024 at 05:11:42PM +0200, Robin Jarry wrote:
> Fix the following meson warning when -Denable_docs=false:
>
> $ meson setup build -Denable_docs=false -Denable_drivers=net/null \
> -Denable_libs=rib -Ddisable_apps=* --wipe --fatal-meson-warnings
> ...
> Program doxygen found: YES (/usr/bin/doxygen)
> Configuring doxy-api-html.conf using configuration
> doc/api/meson.build:54: WARNING: The variable(s) 'DTS_API_MAIN_PAGE' in
> the input file 'doc/api/doxy-api.conf.in' are not present in the given
> configuration data.
> doc/api/meson.build:54:17: ERROR: Fatal warnings enabled, aborting
>
> When -Denable_docs=false, do not even enter the doc subdir. Replace all
> occurrences of get_option('enable_docs') in the doc subdir with true.
>
> Fixes: 7f9326423a04 ("dts: add API doc generation")
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> ---
> doc/api/dts/meson.build | 6 +++---
> doc/api/meson.build | 16 ++++++++--------
> doc/guides/meson.build | 6 +++---
> meson.build | 6 ++++--
> 4 files changed, 18 insertions(+), 16 deletions(-)
>
No strong objection to this. Just FYI, the reason it is currently done as
it is in the build, is that even if you configure a build without the docs
enabled, you can just build the docs explicitly by doing "ninja -C build
doc". That is so that one can do a test build of the docs without
a) having to reconfigure the whole project
b) not have every build from then on rebuild e.g. the APIs doc if you
change a header.
Regards,
/Bruce
next prev parent reply other threads:[~2024-10-22 15:25 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-22 15:11 Robin Jarry
2024-10-22 15:25 ` Bruce Richardson [this message]
2024-10-22 15:31 ` Robin Jarry
2024-10-22 15:49 ` Bruce Richardson
2024-10-22 16:01 ` Thomas Monjalon
2024-10-22 15:36 ` Stephen Hemminger
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=ZxfD8XQvEiwc1Qz1@bricha3-mobl1.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=dmarx@iol.unh.edu \
--cc=jspewock@iol.unh.edu \
--cc=juraj.linkes@pantheon.tech \
--cc=luca.vizzarro@arm.com \
--cc=rjarry@redhat.com \
--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).