All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: John McNamara <john.mcnamara@intel.com>,
	Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH] doc/guides: remove dependency on make build system
Date: Tue, 21 Jul 2020 16:42:24 +0100	[thread overview]
Message-ID: <20200721154224.GH735@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <20200721153950.748927-1-bruce.richardson@intel.com>

On Tue, Jul 21, 2020 at 04:39:50PM +0100, Bruce Richardson wrote:
> 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@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'
> -- 

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

  reply	other threads:[~2020-07-21 15:42 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-21 15:39 [dpdk-dev] [PATCH] doc/guides: remove dependency on make build system Bruce Richardson
2020-07-21 15:42 ` Bruce Richardson [this message]
2020-07-22 12:45 ` Thomas Monjalon
2020-07-22 12:59   ` Bruce Richardson
2020-08-20 15:54     ` Bruce Richardson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200721154224.GH735@bricha3-MOBL.ger.corp.intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.