From: Thomas Monjalon <thomas@monjalon.net>
To: spp@dpdk.org
Subject: [spp] [PATCH] docs: fix version in guides
Date: Tue, 11 Dec 2018 07:44:02 +0100 [thread overview]
Message-ID: <20181211064402.15983-1-thomas@monjalon.net> (raw)
When building HTML guides, the type of the version string was wrong:
WARNING: The config value `version' has type `bytes', defaults to `str'.
WARNING: The config value `release' has type `bytes', defaults to `str'.
[...]
Exception occurred:
File "/usr/lib/python3.7/site-packages/sphinx/builders/html.py", line 479, in prepare_writing
release = return_codes_re.sub('', self.config.release),
TypeError: cannot use a string pattern on a bytes-like object
The version number is also updated to match the latest tag.
The option --no-print-directory is added to make showversion command,
so only the version number is printed in the doc.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
GNUmakefile | 5 ++---
docs/guides/conf.py | 3 ++-
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/GNUmakefile b/GNUmakefile
index 206a4c6..8984335 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -1,7 +1,7 @@
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2018 Nippon Telegraph and Telephone Corporation
-VERSION := 18.05.1
+VERSION := 18.08
ifneq ($(RTE_SDK),)
# Default target, can be overriden by command line or environment
@@ -16,8 +16,7 @@ endif
.PHONY: showversion
showversion:
- @set -- ;\
- printf $(VERSION);\
+ @echo $(VERSION)
# Compile RST documents
DOC_ROOT = docs/guides
diff --git a/docs/guides/conf.py b/docs/guides/conf.py
index c8d00b4..f7f0655 100644
--- a/docs/guides/conf.py
+++ b/docs/guides/conf.py
@@ -40,7 +40,8 @@ author = ''
# |version| and |release|, also used in various other places throughout the
# built documents.
-version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'])
+version = subprocess.check_output(['make', '-C', '../../',
+ '--no-print-directory', 'showversion']).decode('utf-8').rstrip()
# The full version, including alpha/beta/rc tags.
release = version
--
2.19.0
next reply other threads:[~2018-12-11 6:44 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-11 6:44 Thomas Monjalon [this message]
2018-12-12 6:25 ` Yasufumi Ogawa
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=20181211064402.15983-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=spp@dpdk.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).