2020-01-24 20:59:36

by Stephen Kitt

[permalink] [raw]
Subject: [PATCH] Allow git builds of Sphinx

When using a non-release version of Sphinx, from a local build (with
improvements for kernel doc handling, why not),

sphinx-build --version

reports versions of the form

sphinx-build 3.0.0+/4703d9119972

i.e. base version, a plus symbol, slash, and the start of the git hash
of whatever repository the command is run in (no, not the hash that
was used to build Sphinx!).

This patch fixes the installation check in sphinx-pre-install to
recognise such version output.

Signed-off-by: Stephen Kitt <[email protected]>
---
scripts/sphinx-pre-install | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
index 470ccfe678aa..a8f0c002a340 100755
--- a/scripts/sphinx-pre-install
+++ b/scripts/sphinx-pre-install
@@ -272,7 +272,7 @@ sub check_sphinx()

open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error";
while (<IN>) {
- if (m/^\s*sphinx-build\s+([\d\.]+)$/) {
+ if (m/^\s*sphinx-build\s+([\d\.]+)(\+\/[\da-f]+)?$/) {
$cur_version=$1;
last;
}
--
2.24.1


2020-02-05 17:42:54

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] Allow git builds of Sphinx

On Fri, 24 Jan 2020 19:33:16 +0100
Stephen Kitt <[email protected]> wrote:

> When using a non-release version of Sphinx, from a local build (with
> improvements for kernel doc handling, why not),
>
> sphinx-build --version
>
> reports versions of the form
>
> sphinx-build 3.0.0+/4703d9119972
>
> i.e. base version, a plus symbol, slash, and the start of the git hash
> of whatever repository the command is run in (no, not the hash that
> was used to build Sphinx!).
>
> This patch fixes the installation check in sphinx-pre-install to
> recognise such version output.
>
> Signed-off-by: Stephen Kitt <[email protected]>
> ---

Seems useful. Applied, thanks.

jon