From: Timothy Redaelli <tredaelli@redhat.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: dev@dpdk.org
Subject: [PATCH] doc: add build_root to STRIP_FROM_PATH
Date: Mon, 22 Nov 2021 21:16:53 +0100 [thread overview]
Message-ID: <1f6e95f1c4e148a18d8de8dc25d8bb63c094af60.1637612120.git.tredaelli@redhat.com> (raw)
examples.dox is built inside builddir and so doxygen generates some
dir_HASH.html that includes the builddir name and this may prevent DPDK
documentation to be correctly generated in some distributions, for
example CentOS Stream 9 and RHEL9, since the builddir includes the
architecture.
This commit adds builddir to STRIP_FROM_PATH in order to avoid
generating html files that includes it.
Fixes: a6090630f4e5 ("doc: automate examples file list for API")
Cc: ferruh.yigit@intel.com
Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
---
doc/api/doxy-api.conf.in | 1 +
doc/api/meson.build | 1 +
2 files changed, 2 insertions(+)
diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index db2ca9b6ed..a668cad687 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -112,6 +112,7 @@ EXAMPLE_RECURSIVE = YES
OUTPUT_DIRECTORY = @OUTPUT@
STRIP_FROM_PATH = @STRIP_FROM_PATH@
+STRIP_FROM_PATH += @BUILDDIR@
GENERATE_HTML = YES
HTML_OUTPUT = @HTML_OUTPUT@
GENERATE_LATEX = NO
diff --git a/doc/api/meson.build b/doc/api/meson.build
index d34c383694..6dda9bec46 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -37,6 +37,7 @@ cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
cdata.set('HTML_OUTPUT', 'html')
cdata.set('TOPDIR', meson.source_root())
cdata.set('STRIP_FROM_PATH', meson.source_root())
+cdata.set('BUILDDIR', meson.build_root())
cdata.set('WARN_AS_ERROR', 'NO')
if get_option('werror')
cdata.set('WARN_AS_ERROR', 'YES')
--
2.33.1
next reply other threads:[~2021-11-22 20:17 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-22 20:16 Timothy Redaelli [this message]
2021-11-22 20:26 ` Timothy Redaelli
2021-11-23 10:50 ` Luca Boccassi
2021-11-23 10:54 ` David Marchand
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=1f6e95f1c4e148a18d8de8dc25d8bb63c094af60.1637612120.git.tredaelli@redhat.com \
--to=tredaelli@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=thomas.monjalon@6wind.com \
/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).