Linux Documentation
 help / color / mirror / Atom feed
From: Chen Miao <chenmiao.ku@gmail.com>
To: corbet@lwn.net, alexs@kernel.org, si.yanteng@linux.dev,
	skhan@linuxfoundation.org, dzm91@hust.edu.cn, mchehab@kernel.org,
	wy@wyuan.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Chen Miao <chenmiao.ku@gmail.com>
Subject: [PATCH v2 0/5] docs: sphinx-pre-install: improve dependency checks
Date: Mon, 10 Aug 2026 22:33:04 +0800	[thread overview]
Message-ID: <20260810143311.57775-1-chenmiao.ku@gmail.com> (raw)

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 v2:

- do not treat Homebrew itself as a mandatory build dependency;
- use the mactex-no-gui cask, install the required DejaVu and Noto CJK
  font casks, and document the post-install PATH refresh;
- honor MAKE consistently in the dependency checker and build wrapper;
- prefer a compatible gmake before falling back to make;
- resolve GNU Make only for targets that invoke it;
- add a separate patch for tools/docs/sphinx-build-wrapper;
- split the English changes and zh_CN translations into separate patches;
  and
- document diskutil apfs addVolume diskX APFSX Linux in the English guide,
  its zh_CN translation, and the zh_CN contributor how-to.

Link: https://lore.kernel.org/linux-doc/20260809101923.13176-1-chenmiao.ku@gmail.com/

Thanks,
Chen Miao

Chen Miao (5):
  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               |  55 ++++++-
 tools/docs/sphinx-pre-install                 | 154 +++++++++++++++++-
 5 files changed, 244 insertions(+), 10 deletions(-)


base-commit: 8492d4e6bb7b9b1e78f2d17c4dda5272f25ec118
-- 
2.50.1 (Apple Git-155)

             reply	other threads:[~2026-08-10 14:33 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-10 14:33 Chen Miao [this message]
2026-08-10 14:33 ` [PATCH v2 1/5] docs: sphinx-pre-install: add macOS Homebrew support Chen Miao
2026-08-10 19:56   ` Mauro Carvalho Chehab
2026-08-10 14:33 ` [PATCH v2 2/5] docs: sphinx-pre-install: check GNU Make version Chen Miao
2026-08-11  4:43   ` Mauro Carvalho Chehab
2026-08-10 14:33 ` [PATCH v2 3/5] docs: sphinx-build-wrapper: prefer gmake Chen Miao
2026-08-11  4:51   ` Mauro Carvalho Chehab
2026-08-10 14:33 ` [PATCH v2 4/5] docs/zh_CN: doc-guide: document macOS Sphinx setup Chen Miao
2026-08-10 14:33 ` [PATCH v2 5/5] docs/zh_CN: how-to: document case-sensitive APFS setup Chen Miao

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=20260810143311.57775-1-chenmiao.ku@gmail.com \
    --to=chenmiao.ku@gmail.com \
    --cc=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=si.yanteng@linux.dev \
    --cc=skhan@linuxfoundation.org \
    --cc=wy@wyuan.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox