* [spp] [PATCH] docs: fix version in guides
@ 2018-12-11 6:44 Thomas Monjalon
2018-12-12 6:25 ` Yasufumi Ogawa
0 siblings, 1 reply; 2+ messages in thread
From: Thomas Monjalon @ 2018-12-11 6:44 UTC (permalink / raw)
To: spp
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
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [spp] [PATCH] docs: fix version in guides
2018-12-11 6:44 [spp] [PATCH] docs: fix version in guides Thomas Monjalon
@ 2018-12-12 6:25 ` Yasufumi Ogawa
0 siblings, 0 replies; 2+ messages in thread
From: Yasufumi Ogawa @ 2018-12-12 6:25 UTC (permalink / raw)
To: Thomas Monjalon, spp
On 2018/12/11 15:44, Thomas Monjalon wrote:
> 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>
Applied, thanks.
Acked-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> ---
> 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
>
--
Yasufumi Ogawa
NTT Network Service Systems Labs
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-12-12 6:28 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-12-11 6:44 [spp] [PATCH] docs: fix version in guides Thomas Monjalon
2018-12-12 6:25 ` Yasufumi Ogawa
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).