Skip to contentSkip to conversation

doc/guides: remove dependency on make build system

PATCH In review Bruce Richardson 2 participants 5 messages Jul 21, 2020 – Aug 20, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc/guides: remove dependency on make build system

When building the DPDK guide documents, the DPDK version information was pulled using "make showversion", which meant there was a dependency on the DPDK make-based build system. Change this to just read the data from the VERSION file in the root directory.

---
NOTE: When make build system is completed removed, we can change the relative path to the VERSION file i.e. "../../", to instead pull the path from "MESON_SOURCE_ROOT" in the environment, which should be more robust.

---
 doc/guides/conf.py | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)
doc/guides/conf.py +2 -5
index 700e05e17..ff8ddc7e7 100644
@@ -2,7 +2,6 @@
 # Copyright(c) 2010-2015 Intel Corporation
 
 from __future__ import print_function
-import subprocess
 from docutils import nodes
 from distutils.version import LooseVersion
 from sphinx import __version__ as sphinx_version
@@ -38,10 +37,8 @@
 html_show_copyright = False
 highlight_language = 'none'
 
-# 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()
+with open('../../VERSION') as verfile:
+    version = verfile.readline().rstrip()
 release = version
 
 master_doc = 'index'
Signature · 1 line
2.25.1
#1 lore raw
Quoted 31 lines · Bruce Richardson

When building the DPDK guide documents, the DPDK version information was pulled using "make showversion", which meant there was a dependency on the DPDK make-based build system. Change this to just read the data from the VERSION file in the root directory.

---
NOTE: When make build system is completed removed, we can change the relative path to the VERSION file i.e. "../../", to instead pull the path from "MESON_SOURCE_ROOT" in the environment, which should be more robust.

---
 doc/guides/conf.py | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)
doc/guides/conf.py +0 -1
index 700e05e17..ff8ddc7e7 100644
@@ -2,7 +2,6 @@
 # Copyright(c) 2010-2015 Intel Corporation
 
 from __future__ import print_function
-import subprocess
 from docutils import nodes
 from distutils.version import LooseVersion
 from sphinx import __version__ as sphinx_version
@@ -38,10 +37,8 @@
 html_show_copyright = False
 highlight_language = 'none'

doc/guides/conf.py line 44

Quoted 10 lines
doc/guides/conf.py +2 -4
 
-# 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()
+with open('../../VERSION') as verfile:
+    version = verfile.readline().rstrip()
 release = version
 
 master_doc = 'index'

As a side-effect, this patch also allows doc building on FreeBSD, since it no longer uses "make" command, which should be "gmake" on BSD.

/Bruce

#2 lore raw
In reply to Bruce Richardson

21/07/2020 17:39, Bruce Richardson:

Quoted 11 lines

When building the DPDK guide documents, the DPDK version information was pulled using "make showversion", which meant there was a dependency on the DPDK make-based build system. Change this to just read the data from the VERSION file in the root directory.

---
NOTE: When make build system is completed removed, we can change the relative path to the VERSION file i.e. "../../", to instead pull the path from "MESON_SOURCE_ROOT" in the environment, which should be more robust.

Yes it would be a bit better.
If we merge this patch in 20.08, we'll forget about this improvement :) I suggest waiting 20.11 to merge the definitive improvement.

#3 lore raw
Quoted 13 lines · Thomas Monjalon

21/07/2020 17:39, Bruce Richardson:

Quoted 11 lines

When building the DPDK guide documents, the DPDK version information was pulled using "make showversion", which meant there was a dependency on the DPDK make-based build system. Change this to just read the data from the VERSION file in the root directory.

---
NOTE: When make build system is completed removed, we can change the relative path to the VERSION file i.e. "../../", to instead pull the path from "MESON_SOURCE_ROOT" in the environment, which should be more robust.

Quoted 4 lines

Yes it would be a bit better.
If we merge this patch in 20.08, we'll forget about this improvement :) I suggest waiting 20.11 to merge the definitive improvement.

I'd prefer now, but I can be patient, I suppose. :-)

#4 lore raw
Quoted 14 lines · Bruce Richardson
Quoted 13 lines · Thomas Monjalon

21/07/2020 17:39, Bruce Richardson:

Quoted 11 lines

When building the DPDK guide documents, the DPDK version information was pulled using "make showversion", which meant there was a dependency on the DPDK make-based build system. Change this to just read the data from the VERSION file in the root directory.

---
NOTE: When make build system is completed removed, we can change the relative path to the VERSION file i.e. "../../", to instead pull the path from "MESON_SOURCE_ROOT" in the environment, which should be more robust.

Quoted 5 lines
Quoted 4 lines

Yes it would be a bit better.
If we merge this patch in 20.08, we'll forget about this improvement :) I suggest waiting 20.11 to merge the definitive improvement.

I'd prefer now, but I can be patient, I suppose. :-)

Updated and improved version of this patch is now part of the "make removal" patch series. Marking this standalone patch as superceded.

/Bruce