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
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Chen Miao <chenmiao.ku@gmail.com>
Subject: [PATCH v1 0/2] docs: sphinx-pre-install: improve dependency checks
Date: Sun,  9 Aug 2026 18:19:19 +0800	[thread overview]
Message-ID: <20260809101923.13176-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:

  - adds macOS/Homebrew dependency handling, including MacTeX cask support;
  - checks for GNU Make 4.0 or newer and recognizes Homebrew's ``gmake``; and
  - avoids printing an empty installation command when only PyYAML is missing.

Thanks,

Chen Miao

Chen Miao (2):
  docs: sphinx-pre-install: add macOS Homebrew support
  docs: sphinx-pre-install: check GNU Make version

 Documentation/doc-guide/sphinx.rst            |   9 ++
 .../translations/zh_CN/doc-guide/sphinx.rst   |   7 +
 Documentation/translations/zh_CN/how-to.rst   |   7 +
 tools/docs/sphinx-pre-install                 | 141 +++++++++++++++++-
 4 files changed, 162 insertions(+), 2 deletions(-)

-- 
2.50.1 (Apple Git-155)

             reply	other threads:[~2026-08-09 10:19 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-09 10:19 Chen Miao [this message]
2026-08-09 10:19 ` [PATCH v1 1/2] docs: sphinx-pre-install: add macOS Homebrew support Chen Miao
2026-08-09 13:02   ` Weijie Yuan
2026-08-09 13:21     ` Dongliang Mu
2026-08-09 14:11       ` Weijie Yuan
2026-08-09 19:07         ` Chen Miao
2026-08-09 22:34           ` Jonathan Corbet
2026-08-10  3:47             ` Weijie Yuan
2026-08-10  5:12               ` Chen Miao
2026-08-09 18:59     ` Chen Miao
2026-08-09 10:19 ` [PATCH v1 2/2] docs: sphinx-pre-install: check GNU Make version Chen Miao
2026-08-09 17:18   ` Mauro Carvalho Chehab
2026-08-09 19:11     ` 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=20260809101923.13176-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 \
    /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