From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by dpdk.org (Postfix) with ESMTP id EEDD01B4A3 for ; Fri, 4 Jan 2019 14:26:26 +0100 (CET) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 5EEC5811DD; Fri, 4 Jan 2019 13:26:26 +0000 (UTC) Received: from ktraynor.remote.csb (ovpn-117-13.ams2.redhat.com [10.36.117.13]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1EC505C224; Fri, 4 Jan 2019 13:26:24 +0000 (UTC) From: Kevin Traynor To: Luca Boccassi Cc: dpdk stable Date: Fri, 4 Jan 2019 13:23:50 +0000 Message-Id: <20190104132455.15170-8-ktraynor@redhat.com> In-Reply-To: <20190104132455.15170-1-ktraynor@redhat.com> References: <20190104132455.15170-1-ktraynor@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.27]); Fri, 04 Jan 2019 13:26:26 +0000 (UTC) Subject: [dpdk-stable] patch 'doc: fix garbage text in generated HTML guides' has been queued to LTS release 18.11.1 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, 04 Jan 2019 13:26:27 -0000 Hi, FYI, your patch has been queued to LTS release 18.11.1 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 01/11/19. 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. Thanks. Kevin Traynor --- >>From 8f8cc56e461a830fa0d277a0e25dff4ade1807a0 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 c883306d7..da99a3f84 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -10,4 +10,5 @@ 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 @@ -38,5 +39,7 @@ 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.19.0 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2019-01-04 13:23:07.649500426 +0000 +++ 0008-doc-fix-garbage-text-in-generated-HTML-guides.patch 2019-01-04 13:23:07.000000000 +0000 @@ -1,8 +1,10 @@ -From 430b35de4a579a7f65eda5c3fd00eaab2bc57aca Mon Sep 17 00:00:00 2001 +From 8f8cc56e461a830fa0d277a0e25dff4ade1807a0 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 ---