[(pushed)] sphinx: stop using parallel mode

Message ID 161b50ae-626e-4e34-e3e8-d00cc4c29e14@suse.cz
State Committed
Commit 08fd14f9589b6e0e3155ba728a5e7031b9250f91
Headers
Series [(pushed)] sphinx: stop using parallel mode |

Commit Message

Martin Liška Nov. 11, 2022, 12:33 p.m. UTC
  Noticed that the documentation build can stuck on a machine with
many cores (160) and I identified a real sphinx problem:
https://github.com/sphinx-doc/sphinx/issues/10969

Note the parallel can help just for some manuals and it is not critical
for us.

ChangeLog:

	* doc/Makefile: Disable -j auto.
---
 doc/Makefile | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
  

Comments

Andrew Pinski Nov. 11, 2022, 4:05 p.m. UTC | #1
On Fri, Nov 11, 2022 at 4:34 AM Martin Liška <mliska@suse.cz> wrote:
>
> Noticed that the documentation build can stuck on a machine with
> many cores (160) and I identified a real sphinx problem:
> https://github.com/sphinx-doc/sphinx/issues/10969
>
> Note the parallel can help just for some manuals and it is not critical
> for us.

This alone should cause us to pause and just revert back to texinfo.
People are not going to upgrade sphinx all the time just to get fixes
for documentation layout.
Texinfo is stable and we should just revert back to it.

Thanks,
Andrew Pinski

>
> ChangeLog:
>
>         * doc/Makefile: Disable -j auto.
> ---
>  doc/Makefile | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/doc/Makefile b/doc/Makefile
> index 9e305a8e7da..e08a43ecf2d 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -2,7 +2,11 @@
>  #
>
>  # You can set these variables from the command line.
> -SPHINXOPTS   ?= -j auto -q
> +
> +# Disable parallel reading as it can be very slow on a machine with CPUs:
> +# https://github.com/sphinx-doc/sphinx/issues/10969
> +
> +SPHINXOPTS   ?= -q
>  SPHINXBUILD  ?= sphinx-build
>  PAPER        ?=
>  SOURCEDIR     = .
> --
> 2.38.1
>
  

Patch

diff --git a/doc/Makefile b/doc/Makefile
index 9e305a8e7da..e08a43ecf2d 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -2,7 +2,11 @@ 
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS   ?= -j auto -q
+
+# Disable parallel reading as it can be very slow on a machine with CPUs:
+# https://github.com/sphinx-doc/sphinx/issues/10969
+
+SPHINXOPTS   ?= -q
 SPHINXBUILD  ?= sphinx-build
 PAPER        ?=
 SOURCEDIR     = .