Commit e161f691 authored by Michał Kępień's avatar Michał Kępień
Browse files

Do not use parallel make jobs for building docs

Concurrently running sphinx-build instances started in the same working
directory are not separated from each other in any way.  This can cause
intermittent problems which we failed to notice before because they only
trigger Sphinx warnings, not errors, e.g.:

    WARNING: toctree contains ref to nonexisting file 'reference'

The message above is not triggered because doc/arm/reference.rst is
actually missing from disk at any point, but rather because a temporary
file created by one sphinx-build instance gets truncated by another one
working in parallel (the confusing message quoted above is logged
because of an overly broad "except" statement in Sphinx code).

Drop the -j command line switch from the make invocation used for
building documentation to prevent intermittent problems caused by
multiple sphinx-build instances running simultaneously in the same
working directory.

Also drop the -k command line switch from the same make invocation while
we are at it as that switch does not bring any practical value in this
parent 778d0c03
Pipeline #62441 canceled with stages
in 2 minutes and 26 seconds
......@@ -560,7 +560,7 @@ docs:
- test -w "${CCACHE_DIR}" && export PATH="/usr/lib/ccache:${PATH}"
- *configure
- make -j${BUILD_PARALLEL_JOBS:-1} -k doc V=1
- make doc V=1
- job: autoreconf
artifacts: true
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment