Thread (21 messages) 21 messages, 3 authors, 2025-08-22
STALE325d
Revisions (9)
  1. v1 current
  2. v2 [diff vs current]
  3. v3 [diff vs current]
  4. v3 [diff vs current]
  5. v4 [diff vs current]
  6. v5 [diff vs current]
  7. v6 [diff vs current]
  8. v7 [diff vs current]
  9. v8 [diff vs current]

[PATCH 00/11] Split sphinx call logic from docs Makefile

From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: 2025-08-15 11:51:05
Also in: lkml, rust-for-linux

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

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help