patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Timothy Redaelli <tredaelli@redhat.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
	Thomas Monjalon <thomas@monjalon.net>
Cc: Luca Boccassi <bluca@debian.org>, dev@dpdk.org, stable@dpdk.org
Subject: [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
Date: Tue, 23 Nov 2021 15:48:42 +0100
Message-ID: <4c058c558a858267b8d14b0460dce5fcc8bbcc2c.1637678260.git.tredaelli@redhat.com> (raw)
Message-ID: <20211123144842.KT0Z3SXgfs4JeR9S-zPwQvMykgrTRAh2bEluWPpMC-k@z> (raw)

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

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")
Cc: ferruh.yigit@intel.com
Cc: stable@dpdk.org
Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
---
v2:
 - 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/meson.build | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/meson.build b/doc/api/meson.build
index d34c383694..7e2b429ac8 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -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')
-- 
2.33.1


             reply	other threads:[~2021-11-23 14:48 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-23 14:47 Timothy Redaelli [this message]
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

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=4c058c558a858267b8d14b0460dce5fcc8bbcc2c.1637678260.git.tredaelli@redhat.com \
    --to=tredaelli@redhat.com \
    --cc=bluca@debian.org \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.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

patches for DPDK stable branches

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/stable/0 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/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git