DPDK patches and discussions
 help / color / mirror / Atom feed
* [PATCH] doc: add build_root to STRIP_FROM_PATH
@ 2021-11-22 20:16 Timothy Redaelli
  2021-11-22 20:26 ` Timothy Redaelli
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Timothy Redaelli @ 2021-11-22 20:16 UTC (permalink / raw)
  To: Ferruh Yigit, Thomas Monjalon; +Cc: dev

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


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-11-23 10:55 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-22 20:16 [PATCH] doc: add build_root to STRIP_FROM_PATH Timothy Redaelli
2021-11-22 20:26 ` Timothy Redaelli
2021-11-23 10:50 ` Luca Boccassi
2021-11-23 10:54 ` David Marchand

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).