diff options
| author |   Luca Boccassi <luca.boccassi@gmail.com> | 2018-12-05 14:28:20 +0000 |
|---|---|---|
| committer | Luca Boccassi <luca.boccassi@gmail.com> | 2018-12-05 14:28:20 +0000 |
| commit | 13b767a721d411692dad858cc26d58ec5121a45d (patch) | |
| tree | a895a7b139436ac748deaebb35cf5bd54ad98275 | |
| parent | 496f073673199cd1a8f3c69e8f19734aa1caebe3 (diff) | |
Add patch to fix reproducible doc builds
Change-Id: I95375f49ddd230ae71175809bacefac5feaaec32
Signed-off-by: Luca Boccassi <luca.boccassi@gmail.com>
| -rw-r--r-- | debian/patches/0001-doc-fix-garbage-text-in-generated-HTML-guides.patch | 34 | ||||
| -rw-r--r-- | debian/patches/series | 1 |
2 files changed, 35 insertions, 0 deletions
diff --git a/debian/patches/0001-doc-fix-garbage-text-in-generated-HTML-guides.patch b/debian/patches/0001-doc-fix-garbage-text-in-generated-HTML-guides.patch new file mode 100644 index 00000000..49bb1cd2 --- /dev/null +++ b/debian/patches/0001-doc-fix-garbage-text-in-generated-HTML-guides.patch @@ -0,0 +1,34 @@ +Description: 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. +Author: bluca@debian.org +Forwarded: https://patches.dpdk.org/patch/48544/ +--- a/doc/guides/conf.py ++++ b/doc/guides/conf.py +@@ -9,6 +9,7 @@ from sphinx import __version__ as sphinx + 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_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 + diff --git a/debian/patches/series b/debian/patches/series index e69de29b..65570207 100644 --- a/debian/patches/series +++ b/debian/patches/series @@ -0,0 +1 @@ +0001-doc-fix-garbage-text-in-generated-HTML-guides.patch |