patches for DPDK stable branches
 help / color / mirror / Atom feed
* [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
@ 2021-11-23 14:47 Timothy Redaelli
  2021-11-23 14:48 ` Timothy Redaelli
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Timothy Redaelli @ 2021-11-23 14:47 UTC (permalink / raw)
  To: Ferruh Yigit, Thomas Monjalon; +Cc: Luca Boccassi, stable

examples.dox is built inside builddir/doc/api 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

This commit adds builddir/doc/api (the path where examples.dox is
generated) to STRIP_FROM_PATH, so the generated documentation doesn't
change if builddir changes.

Fixes: a6090630f4e5 ("doc: automate examples file list for API")
Signed-off-by: Timothy Redaelli <>
 - Don't use another VARIABLE name, but set STRIP_FROM_PATH with the 2
   paths directly (suggested by David Marchand)
 - Strip the full path of examples.dox (except the last component)
   instead of stripping only build_root. This is needed since doxygen
   generates the HASH of dir_HASH.html filename using the last component
   of the path and so if the last part of buildroot is changed, the
   filename is different.
 doc/api/ | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/ b/doc/api/
index d34c383694..7e2b429ac8 100644
--- a/doc/api/
+++ b/doc/api/
@@ -36,7 +36,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples
 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('STRIP_FROM_PATH', ' '.join([meson.source_root(), join_paths(meson.build_root(), 'doc', 'api')]))
 cdata.set('WARN_AS_ERROR', 'NO')
 if get_option('werror')
     cdata.set('WARN_AS_ERROR', 'YES')

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

end of thread, other threads:[~2021-11-24 13:19 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-23 14:47 [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH Timothy Redaelli
2021-11-23 14:48 ` Timothy Redaelli
2021-11-23 15:16 ` Luca Boccassi
2021-11-24 13:19   ` David Marchand
2021-11-23 19:39 ` David Marchand

patches for DPDK stable branches

This inbox may be cloned and mirrored by anyone:

	git clone --mirror stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ \
	public-inbox-index stable

Example config snippet for mirrors.
Newsgroup available over NNTP:

AGPL code for this site: git clone