patch 'doc: strip build artefacts for examples file list' has been queued to stable release 19.11.11

[christian.ehrhardt at canonical.com]

Hi,

FYI, your patch has been queued to stable release 19.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before December 10th 2021. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/cpaelzer/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/cpaelzer/dpdk-stable-queue/commit/bfee2c85d61bfdac606d32d834a818eb80b2f15b

Thanks.

Christian Ehrhardt <christian.ehrhardt at canonical.com>

---
>From bfee2c85d61bfdac606d32d834a818eb80b2f15b Mon Sep 17 00:00:00 2001
From: Timothy Redaelli <tredaelli at redhat.com>
Date: Tue, 23 Nov 2021 15:48:42 +0100
Subject: [PATCH] doc: strip build artefacts for examples file list

[ upstream commit 92eb2c3465439dad4d7aa4f073df517de1817ed9 ]

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

Signed-off-by: Timothy Redaelli <tredaelli at redhat.com>
Acked-by: Luca Boccassi <bluca at debian.org>
Tested-by: David Marchand <david.marchand at redhat.com>
---
 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 c72b880e10..e5e2f1acb2 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -37,7 +37,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', 'api')
 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')]))
 
 doxy_conf = configure_file(input: 'doxy-api.conf.in',
 	output: 'doxy-api.conf',
-- 
2.34.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-11-30 16:50:14.795523249 +0100
+++ 0154-doc-strip-build-artefacts-for-examples-file-list.patch	2021-11-30 16:50:06.130876025 +0100
@@ -1 +1 @@
-From 92eb2c3465439dad4d7aa4f073df517de1817ed9 Mon Sep 17 00:00:00 2001
+From bfee2c85d61bfdac606d32d834a818eb80b2f15b Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 92eb2c3465439dad4d7aa4f073df517de1817ed9 ]
+
@@ -17 +18,0 @@
-Cc: stable at dpdk.org
@@ -27 +28 @@
-index d34c383694..7e2b429ac8 100644
+index c72b880e10..e5e2f1acb2 100644
@@ -30 +31 @@
-@@ -36,7 +36,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples
+@@ -37,7 +37,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples
@@ -32 +33 @@
- cdata.set('HTML_OUTPUT', 'html')
+ cdata.set('HTML_OUTPUT', 'api')
@@ -36,3 +37,3 @@
- cdata.set('WARN_AS_ERROR', 'NO')
- if get_option('werror')
-     cdata.set('WARN_AS_ERROR', 'YES')
+ 
+ doxy_conf = configure_file(input: 'doxy-api.conf.in',
+ 	output: 'doxy-api.conf',