maintainer-scripts: Fix jit documentation build with update_web_docs_git

Message ID 20200312121646.GO2156@tucnak
State New
Headers show
Series
  • maintainer-scripts: Fix jit documentation build with update_web_docs_git
Related show

Commit Message

Jakub Jelinek via Gcc-patches March 12, 2020, 12:16 p.m.
Hi!

scripts/update_web_docs_git -r 9.3.0 -d gcc-9.3.0
failed after the sourceware upgrade, there is no python-sphinx10 package and
python3-sphinx is new enough that the docs build succeeded.

Ok for trunk?

2020-03-12  Jakub Jelinek  <jakub@redhat.com>

	* update_web_docs_git: Use SPHINXBUILD=/usr/bin/sphinx-build rather
	than SPHINXBUILD=/usr/bin/sphinx-1.0-build.


	Jakub

Comments

Jakub Jelinek via Gcc-patches March 12, 2020, 1:41 p.m. | #1
On Thu, 2020-03-12 at 13:16 +0100, Jakub Jelinek wrote:
> Hi!

> 

> scripts/update_web_docs_git -r 9.3.0 -d gcc-9.3.0

> failed after the sourceware upgrade, there is no python-sphinx10

> package and

> python3-sphinx is new enough that the docs build succeeded.

> 

> Ok for trunk?

> 

> 2020-03-12  Jakub Jelinek  <jakub@redhat.com>

> 

> 	* update_web_docs_git: Use SPHINXBUILD=/usr/bin/sphinx-build

> rather

> 	than SPHINXBUILD=/usr/bin/sphinx-1.0-build.

> 

> --- maintainer-scripts/update_web_docs_git.jj	2020-01-14

> 09:23:17.677789918 +0100

> +++ maintainer-scripts/update_web_docs_git	2020-03-12

> 13:12:47.052639530 +0100

> @@ -183,15 +183,16 @@ done

>  # defaulting to "sphinx-build".

>  #

>  # sphinx is packaged in Fedora and EPEL 6 within "python-sphinx",

> +# in RHEL 8 within "python3-sphinx",

>  # and in openSUSE within "python-Sphinx".

>  #

>  # For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various

>  # directives (e.g. ":c:macro:"), so we need the variant

>  # python-sphinx10 package.  The latter installs its executable as

>  #   /usr/bin/sphinx-1.0-build

> -# so we need to override SPHINXBUILD with this when invoking "make".

> +# so we needed to override SPHINXBUILD with this when invoking

> "make".

>  pushd gcc/gcc/jit/docs

> -make SPHINXBUILD=/usr/bin/sphinx-1.0-build html || true

> +make SPHINXBUILD=/usr/bin/sphinx-build html || true


The Makefile in question has:
  SPHINXBUILD   = sphinx-build
so presumably the SPHINXBUILD=something here is only in case someone
wants to override it.

There's a case for removing it altogether, but I think the patch is OK
as is (depends on whether we want to keep that historical information
in the script, or just in the git history, I suppose)

Dave

>  popd

>  cp -a gcc/gcc/jit/docs/_build/html jit

>  mkdir -p $DOCSDIR/jit

> 

> 	Jakub

Patch

--- maintainer-scripts/update_web_docs_git.jj	2020-01-14 09:23:17.677789918 +0100
+++ maintainer-scripts/update_web_docs_git	2020-03-12 13:12:47.052639530 +0100
@@ -183,15 +183,16 @@  done
 # defaulting to "sphinx-build".
 #
 # sphinx is packaged in Fedora and EPEL 6 within "python-sphinx",
+# in RHEL 8 within "python3-sphinx",
 # and in openSUSE within "python-Sphinx".
 #
 # For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various
 # directives (e.g. ":c:macro:"), so we need the variant
 # python-sphinx10 package.  The latter installs its executable as
 #   /usr/bin/sphinx-1.0-build
-# so we need to override SPHINXBUILD with this when invoking "make".
+# so we needed to override SPHINXBUILD with this when invoking "make".
 pushd gcc/gcc/jit/docs
-make SPHINXBUILD=/usr/bin/sphinx-1.0-build html || true
+make SPHINXBUILD=/usr/bin/sphinx-build html || true
 popd
 cp -a gcc/gcc/jit/docs/_build/html jit
 mkdir -p $DOCSDIR/jit