[dpdk-dev] [PATCH] doc/guides: remove dependency on make build system

Bruce Richardson bruce.richardson at intel.com
Tue Jul 21 17:39:50 CEST 2020


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.

Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
---
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(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 700e05e17..ff8ddc7e7 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -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'
-- 
2.25.1



More information about the dev mailing list