doc: fix garbage text in generated HTML guides

PATCH Applied Luca Boccassi 2 participants 2 messages Dec 5, 2018 – Dec 19, 2018

Share & tools

Luca Boccassi

author

2018-12-05 14:25 UTC #0 lore raw

PATCH 1/1 doc: fix garbage text in generated HTML guides

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

Cc [email protected]

Signed-off-by Luca Boccassi <[email protected]>

---
 doc/guides/conf.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

doc/guides/conf.py +4 -1

index c883306d7..da99a3f84 100644
@@ -9,6 +9,7 @@
 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

@@ -37,7 +38,9 @@
 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

Signature · 1 line

2.19.2

Thomas Monjalon

Applied

2018-12-19 02:28 UTC #1 lore raw

05/12/2018 15:25, Luca Boccassi:

Quoted 11 lines

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>

Quoted 6 lines

Override MAKEFLAGS in the Python subprocess call to avoid this issue.
Fixes f7aaae2fe6f7 ("doc: add copyright and version")
Cc [email protected]
Signed-off-by Luca Boccassi <[email protected]>

Applied, thanks