From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by dpdk.org (Postfix) with ESMTP id B6DFDA3 for ; Fri, 8 Mar 2019 18:48:12 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from yskoh@mellanox.com) with ESMTPS (AES256-SHA encrypted); 8 Mar 2019 19:48:10 +0200 Received: from scfae-sc-2.mti.labs.mlnx (scfae-sc-2.mti.labs.mlnx [10.101.0.96]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x28HloAR002625; Fri, 8 Mar 2019 19:48:09 +0200 From: Yongseok Koh To: Luca Boccassi Cc: dpdk stable Date: Fri, 8 Mar 2019 09:46:49 -0800 Message-Id: <20190308174749.30771-11-yskoh@mellanox.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20190308174749.30771-1-yskoh@mellanox.com> References: <20190308174749.30771-1-yskoh@mellanox.com> Subject: [dpdk-stable] patch 'doc: fix garbage text in generated HTML guides' has been queued to LTS release 17.11.6 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 08 Mar 2019 17:48:13 -0000 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 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: 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 Override MAKEFLAGS in the Python subprocess call to avoid this issue. Fixes: f7aaae2fe6f7 ("doc: add copyright and version") Signed-off-by: Luca Boccassi --- 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 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@dpdk.org Signed-off-by: Luca Boccassi --- @@ -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'