Skip to content

docs: sphinx-pre-install: improve dependency checks

Chen Miao linux-doc lkml 4 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest6 patches 5 repliesIn review
  2. v36 patches 14 repliesSuperseded
  3. v25 patches 5 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v12 patches10 repliesSuperseded

Changes in v4 from the cover letter

- always pass LLVM=1 when invoking rustdoc, since Rust documentation requires LLVM even when the outer documentation build does not use it;

Patches in v4 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6docs: kdoc: add GNU Make detectiontools/lib/python/kdoc/gmake_detect.py+62 -00 replies
2/6docs: sphinx-pre-install: add macOS Homebrew supportDocumentation/doc-guide/sphinx.rst tools/docs/sphinx-pre-install+128 -00 replies
3/6docs: sphinx-pre-install: check GNU Make versionDocumentation/doc-guide/sphinx.rst tools/docs/sphinx-pre-install+12 -20 replies
4/6docs: sphinx-build-wrapper: prefer gmaketools/docs/sphinx-build-wrapper+13 -70 replies
5/6docs/zh_CN: doc-guide: document macOS Sphinx setupDocumentation/translations/zh_CN/doc-guide/sphinx.rst+16 -14 replies
6/6docs/zh_CN: how-to: document case-sensitive APFS setupDocumentation/translations/zh_CN/how-to.rst+8 -01 reply

Reviews trailers per patch

4 of 6 patches have a Reviewed-by or Acked-by.

PatchMauro Carvalho ChehabWeijie YuanDongliang Mu
1/6
2/6A-b
3/6R-b
4/6
5/6A-b
6/6A-b R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v4 thread

Cover letter [PATCH v4 0/6] docs: sphinx-pre-install: improve dependency checks

Hi all,

The Sphinx dependency checker currently does not provide useful installation guidance on macOS and only checks whether a make executable exists. This can leave macOS users without a clear setup path and allow an incompatible make implementation to pass the dependency check before the documentation build fails.

This series:

- documents the case-sensitive APFS volume needed for a kernel tree on macOS;
- adds macOS/Homebrew dependency handling, including command-line-only MacTeX support, required PDF font casks, and a PATH refresh hint;
- checks for GNU Make 4.0 or newer and honors an exported MAKE before preferring Homebrew gmake;
- teaches sphinx-build-wrapper to select a compatible GNU Make lazily for Info and Rust docs; and
- updates the zh_CN documentation in separate patches, including the APFS guidance in the contributor how-to.

Changes in v4:

- always pass LLVM=1 when invoking rustdoc, since Rust documentation requires LLVM even when the outer documentation build does not use it;

Thanks,
Chen Miao

Chen Miao (6):
docs: kdoc: add GNU Make detection
docs: sphinx-pre-install: add macOS Homebrew support
docs: sphinx-pre-install: check GNU Make version
docs: sphinx-build-wrapper: prefer gmake docs/zh_CN: doc-guide: document macOS Sphinx setup docs/zh_CN: how-to: document case-sensitive APFS setup

 Documentation/doc-guide/sphinx.rst            |  20 +++
 .../translations/zh_CN/doc-guide/sphinx.rst   |  17 ++-
 Documentation/translations/zh_CN/how-to.rst   |   8 ++
 tools/docs/sphinx-build-wrapper               |  20 ++-
 tools/docs/sphinx-pre-install                 | 120 +++++++++++++++++-
 tools/lib/python/kdoc/gmake_detect.py         |  62 +++++++++
 6 files changed, 238 insertions(+), 9 deletions(-)
 create mode 100644 tools/lib/python/kdoc/gmake_detect.py

base-commit: 8492d4e6bb7b9b1e78f2d17c4dda5272f25ec118

Signature · 1 line
2.50.1 (Apple Git-155)