[dpdk-stable] patch 'doc: fix garbage text in generated HTML guides' has been queued to LTS release 17.11.6

[Yongseok Koh]

Hi,

FYI, your patch has been queued to LTS release 17.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objection by 03/13/19. So please
shout if anyone has objection.

Also note that after the patch there's a diff of the upstream commit vs the patch applied
to the branch. If the code is different (ie: not only metadata diffs), due for example to
a change in context or macro names, please double check it.

Thanks.

Yongseok

---
>From ea08f07946672c3520cb641ca819aa1abd83c515 Mon Sep 17 00:00:00 2001
From: Luca Boccassi <bluca at debian.org>
Date: Wed, 5 Dec 2018 14:25:45 +0000
Subject: [PATCH] doc: fix garbage text in generated HTML guides

[ upstream commit 430b35de4a579a7f65eda5c3fd00eaab2bc57aca ]

If the user has MAKEFLAGS set in the environment when building the
documentation, the doc/guides/conf.py script which calls "make"
exclusively to get the project version might pick up garbage from
stdout, like:

<title>FAQ — Data Plane Development Kit make[2]:
Entering directory '/build/1st/dpdk-18.11/doc/guides'
18.11.0
make[2]: Leaving directory '/build/1st/dpdk-18.11'
documentation</title>

Override MAKEFLAGS in the Python subprocess call to avoid this issue.

Fixes: f7aaae2fe6f7 ("doc: add copyright and version")

Signed-off-by: Luca Boccassi <bluca at debian.org>
---
 doc/guides/conf.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 31f914a89..084512dc7 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -36,6 +36,7 @@ from sphinx import __version__ as sphinx_version
 from sphinx.highlighting import PygmentsBridge
 from pygments.formatters.latex import LatexFormatter
 from os import listdir
+from os import environ
 from os.path import basename
 from os.path import dirname
 from os.path import join as path_join
@@ -64,7 +65,9 @@ html_add_permalinks = ""
 html_show_copyright = False
 highlight_language = 'none'
 
-version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'])
+# If MAKEFLAGS is exported by the user, garbage text might end up in version
+version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'],
+                                  env=dict(environ, MAKEFLAGS=""))
 version = version.decode('utf-8').rstrip()
 release = version
 
-- 
2.11.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-03-08 09:46:40.936077372 -0800
+++ 0011-doc-fix-garbage-text-in-generated-HTML-guides.patch	2019-03-08 09:46:40.001399000 -0800
@@ -1,8 +1,10 @@
-From 430b35de4a579a7f65eda5c3fd00eaab2bc57aca Mon Sep 17 00:00:00 2001
+From ea08f07946672c3520cb641ca819aa1abd83c515 Mon Sep 17 00:00:00 2001
 From: Luca Boccassi <bluca at debian.org>
 Date: Wed, 5 Dec 2018 14:25:45 +0000
 Subject: [PATCH] doc: fix garbage text in generated HTML guides
 
+[ upstream commit 430b35de4a579a7f65eda5c3fd00eaab2bc57aca ]
+
 If the user has MAKEFLAGS set in the environment when building the
 documentation, the doc/guides/conf.py script which calls "make"
 exclusively to get the project version might pick up garbage from
@@ -17,7 +19,6 @@
 Override MAKEFLAGS in the Python subprocess call to avoid this issue.
 
 Fixes: f7aaae2fe6f7 ("doc: add copyright and version")
-Cc: stable at dpdk.org
 
 Signed-off-by: Luca Boccassi <bluca at debian.org>
 ---
@@ -25,10 +26,10 @@
  1 file changed, 4 insertions(+), 1 deletion(-)
 
 diff --git a/doc/guides/conf.py b/doc/guides/conf.py
-index c883306d7..da99a3f84 100644
+index 31f914a89..084512dc7 100644
 --- a/doc/guides/conf.py
 +++ b/doc/guides/conf.py
-@@ -9,6 +9,7 @@ from sphinx import __version__ as sphinx_version
+@@ -36,6 +36,7 @@ from sphinx import __version__ as sphinx_version
  from sphinx.highlighting import PygmentsBridge
  from pygments.formatters.latex import LatexFormatter
  from os import listdir
@@ -36,7 +37,7 @@
  from os.path import basename
  from os.path import dirname
  from os.path import join as path_join
-@@ -37,7 +38,9 @@ html_add_permalinks = ""
+@@ -64,7 +65,9 @@ html_add_permalinks = ""
  html_show_copyright = False
  highlight_language = 'none'