From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: "Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Alice Ryhl" <aliceryhl@google.com>,
"Andreas Hindborg" <mchehab+huawei@kernel.org>,
"Benno Lossin" <mchehab+huawei@kernel.org>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Danilo Krummrich" <mchehab+huawei@kernel.org>,
"Gary Guo" <gary@garyguo.net>,
"Miguel Ojeda" <mchehab+huawei@kernel.org>,
"Trevor Gross" <tmgross@umich.edu>,
rust-for-linux@vger.kernel.org
Subject: [PATCH 00/11] Split sphinx call logic from docs Makefile
Date: Fri, 15 Aug 2025 13:50:28 +0200 [thread overview]
Message-ID: <cover.1755258303.git.mchehab+huawei@kernel.org> (raw)
This series does a major cleanup at docs Makefile by moving the
actual doc build logic to a helper script (scripts/sphinx-build-wrapper).
Such script was written in a way that it can be called either
directly or via a makefile. When running via makefile, it will
use GNU jobserver to ensure that, when sphinx-build is
called, the number of jobs will match at most what it is
specified by the "-j" parameter.
The first 3 patches do a cleanup at scripts/jobserver-exec
and moves the actual code to a library. Such library is used
by both the jobserver-exec command line and by
sphinx-build-wrappper.
The change also gets rid of parallel-wrapper.sh, whose
functions are now part of the wrapper code.
Mauro Carvalho Chehab (11):
scripts/jobserver-exec: move the code to a class
scripts/jobserver-exec: move its class to the lib directory
scripts/jobserver-exec: add a help message
scripts: sphinx-build-wrapper: add a wrapper for sphinx-build
docs: Makefile: cleanup the logic by using sphinx-build-wrapper
docs: parallel-wrapper.sh: remove script
docs: Makefile: document latex/PDF PAPER= parameter
scripts/sphinx-build-wrapper: restore SPHINXOPTS parsing
scripts: sphinx-build-wrapper: add an argument for LaTeX interactive
mode
scripts: sphinx-*: prevent sphinx-build crashes
docs: Makefile: cleanup the logic by using sphinx-build-wrapper
.pylintrc | 2 +-
Documentation/Makefile | 140 ++---
Documentation/sphinx/parallel-wrapper.sh | 33 --
scripts/jobserver-exec | 88 +--
scripts/lib/jobserver.py | 149 +++++
scripts/sphinx-build-wrapper | 696 +++++++++++++++++++++++
scripts/sphinx-pre-install | 14 +-
7 files changed, 922 insertions(+), 200 deletions(-)
delete mode 100644 Documentation/sphinx/parallel-wrapper.sh
create mode 100755 scripts/lib/jobserver.py
create mode 100755 scripts/sphinx-build-wrapper
--
2.50.1
next reply other threads:[~2025-08-15 11:51 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-15 11:50 Mauro Carvalho Chehab [this message]
2025-08-15 11:50 ` [PATCH 01/11] scripts/jobserver-exec: move the code to a class Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 02/11] scripts/jobserver-exec: move its class to the lib directory Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 03/11] scripts/jobserver-exec: add a help message Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 04/11] scripts: sphinx-build-wrapper: add a wrapper for sphinx-build Mauro Carvalho Chehab
2025-08-16 1:16 ` Akira Yokosawa
2025-08-16 11:06 ` Mauro Carvalho Chehab
2025-08-21 19:36 ` Jonathan Corbet
2025-08-21 19:43 ` Mauro Carvalho Chehab
2025-08-21 20:18 ` Jonathan Corbet
2025-08-21 20:11 ` Jonathan Corbet
2025-08-22 2:06 ` Mauro Carvalho Chehab
2025-08-22 13:55 ` Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 05/11] docs: Makefile: cleanup the logic by using sphinx-build-wrapper Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 06/11] docs: parallel-wrapper.sh: remove script Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 07/11] docs: Makefile: document latex/PDF PAPER= parameter Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 08/11] scripts/sphinx-build-wrapper: restore SPHINXOPTS parsing Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 09/11] scripts: sphinx-build-wrapper: add an argument for LaTeX interactive mode Mauro Carvalho Chehab
2025-08-15 11:50 ` [PATCH 10/11] scripts: sphinx-*: prevent sphinx-build crashes Mauro Carvalho Chehab
2025-08-21 19:41 ` Jonathan Corbet
2025-08-15 11:50 ` [PATCH 11/11] docs: Makefile: cleanup the logic by using sphinx-build-wrapper Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover.1755258303.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=corbet@lwn.net \
--cc=gary@garyguo.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.