diff mbox series

[v2,18/37] doc/guides: remove use of DPDK make build system

Message ID	20200820124140.13451-19-ciara.power@intel.com (mailing list archive)
State	Superseded, archived
Delegated to:	Thomas Monjalon
Headers	IronPort-SDR: TdgLrRHC86VsKwUNNfCQaGgTjK1VwO5arzFh7BAJnt/2sjnp8r+YbNKNF7JDa4fqt9TYCFhyOR 1H71EgRS5nCA== IronPort-SDR: IHGxbuGqCeBVCxi7Foy54u6rWbPhNZAmsn/q6qLnpPboZigjpXAzf6lSOP9pe8BYZHd+Is/ecA gDO+W8wEs2/g== From: Ciara Power <ciara.power@intel.com> To: dev@dpdk.org Cc: Bruce Richardson <bruce.richardson@intel.com>, John McNamara <john.mcnamara@intel.com>, Marko Kovacevic <marko.kovacevic@intel.com> Date: Thu, 20 Aug 2020 13:41:21 +0100 Message-Id: <20200820124140.13451-19-ciara.power@intel.com> In-Reply-To: <20200820124140.13451-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200820124140.13451-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v2 18/37] doc/guides: remove use of DPDK make build system Precedence: list Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org>
Series	remove make support in DPDK \| [v2,00/37] remove make support in DPDK [v2,01/37] examples: remove legacy sections of makefiles [v2,02/37] examples/multi_process: convert to pkg-config-based build [v2,03/37] examples/server_node_efd: convert to pkg-config-based build [v2,04/37] examples/ka-agent: convert to pkg-config-based build [v2,05/37] examples/pthread: convert to pkg-config-based build [v2,06/37] examples/vm_power_manager: convert to use DPDK pkg-config [v2,07/37] examples/vm_power_manager: convert guest cli to pkg-config [v2,08/37] examples/ethtool: convert to pkg-config-based build [v2,09/37] build: create dummy Makefile [v2,10/37] build: remove makefiles and mk directory [v2,11/37] config: remove all config files used by make [v2,12/37] examples: remove old build system references [v2,13/37] buildtools: remove all scripts for use with make [v2,14/37] devtools: remove use of make in scripts [v2,15/37] app/test: remove references to make [v2,16/37] drivers: remove references to make config options [v2,17/37] lib: remove references to make config options [v2,18/37] doc/guides: remove use of DPDK make build system [v2,19/37] doc: remove deprecation notice for make [v2,20/37] doc: remove references to make in bbdev guides [v2,21/37] doc: remove references to make in compressdev guides [v2,22/37] doc: remove references to make in contributing guides [v2,23/37] doc: remove references to make in cryptodev guides [v2,24/37] doc: remove references to make in eventdev guides [v2,25/37] doc: remove references to make in FreeBSD gsg guide [v2,26/37] doc: remove references to make in howto guides [v2,27/37] doc: remove references to make in Linux gsg guides [v2,28/37] doc: remove references to make in mempool guides [v2,29/37] doc: remove references to make in NIC guides [v2,30/37] doc: remove references to make in platform guides [v2,31/37] doc: remove references to make in prog guides [v2,32/37] doc: remove references to make in rawdev guides [v2,33/37] doc: remove references to make in sample app guides [v2,34/37] doc: remove references to make in vdpadevs guides [v2,35/37] doc: remove reference to make in tools guides [v2,36/37] doc: remove references to make in testpmd guides [v2,37/37] doc: update quick build doc to remove make references

Checks

Context	Check	Description
ci/checkpatch	success	coding style OK

Commit Message

Power, Ciara Aug. 20, 2020, 12:41 p.m. UTC

  From: Bruce Richardson <bruce.richardson@intel.com>

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 have the version info
passed in from meson itself.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 buildtools/call-sphinx-build.py | 5 ++++-
 doc/guides/conf.py              | 7 +------
 doc/guides/meson.build          | 3 ++-
 3 files changed, 7 insertions(+), 8 deletions(-)

diff mbox series

Patch

diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py
index 85c9e01563..fa6f26b376 100755
--- a/buildtools/call-sphinx-build.py
+++ b/buildtools/call-sphinx-build.py
@@ -9,7 +9,10 @@ 
 from subprocess import run, PIPE, STDOUT
 from distutils.version import StrictVersion
 
-(sphinx, src, dst) = sys.argv[1:]  # assign parameters to variables
+(sphinx, version, src, dst) = sys.argv[1:]  # assign parameters to variables
+
+# set the version in environment for sphinx to pick up
+os.environ['DPDK_VERSION'] = version
 
 # for sphinx version >= 1.7 add parallelism using "-j auto"
 ver = run([sphinx, '--version'], stdout=PIPE,
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index d8fe5cccd7..9ebc26ed3f 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,11 +37,7 @@ 
 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()
-release = version
+release = environ['DPDK_VERSION']
 
 master_doc = 'index'
 
diff --git a/doc/guides/meson.build b/doc/guides/meson.build
index 732e7ad3a9..daab139c4e 100644
--- a/doc/guides/meson.build
+++ b/doc/guides/meson.build
@@ -11,7 +11,8 @@  htmldir = join_paths(get_option('datadir'), 'doc', 'dpdk')
 html_guides = custom_target('html_guides',
 	input: files('index.rst'),
 	output: 'html',
-	command: [sphinx_wrapper, sphinx, meson.current_source_dir(), meson.current_build_dir()],
+	command: [sphinx_wrapper, sphinx, meson.project_version(),
+		meson.current_source_dir(), meson.current_build_dir()],
 	depfile: '.html.d',
 	build_by_default: get_option('enable_docs'),
 	install: get_option('enable_docs'),