From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f45.google.com (mail-pj1-f45.google.com [209.85.216.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 46EDE3E0C4C for ; Mon, 10 Aug 2026 14:33:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.45 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786372408; cv=none; b=nT+LmF4pNpz+1CYidPu4GIynAj5Q5OotiV8+loDTEUrvhPX11OASIzXRqWQHuPFo7zsGn4dN5Y/+8OlvUclG84dmJTRpCSd1dr/rg7kX6872FS7a0lFk8YbD2uwvp6x4y6Ru8HIEdNZVSjUwKC9OpEBejxogDNRLE5p6fB38VxQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786372408; c=relaxed/simple; bh=SkWJziYAltGYw0TJ8LmA/O3aXe/nbpzfJr3gzN3OpRc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=rAIA4cgdCMol/GuxlrCbmKoaCksNLble6v6Rlxkt16bj3sb3WZFk+lVdbdGVQBkC4a5LU4A7Hzty0aQQ0GA4hPnb6zmFXDajKexL2XzFfHnf3cOQ8sF1PZnpNO/2Fuu9ENfb1wPwHL+DOj2WzByc+DyedffeXcSbR18d3AZt/hU= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=GNSaq1mL; arc=none smtp.client-ip=209.85.216.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="GNSaq1mL" Received: by mail-pj1-f45.google.com with SMTP id 98e67ed59e1d1-38f620399a0so1674908a91.2 for ; Mon, 10 Aug 2026 07:33:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1786372406; x=1786977206; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to:content-type; bh=3eGPyLBs9QZ3Nwm6ypDb5+mFyEwjns3mEiwXdV8ptF0=; b=GNSaq1mLmI2ROmYXZ/l5mgBpfoPgjNKryi35qJsNK5bTr26ACuah7ZUoDMGEWKWs4Q NLINFVRSM8twcHEk8VlF6IhMFbAZHs+dKcAftF2ay2ahKi8G/IH3fCDYQk3wbwvv7iMW aJ4m+q3vYR8MX50BG/euYuGxEH+P2HiVyXdsvfyVSGCKmZqae3anu38hU4xMuCqSP0Te cAqklaQNJFXVl8GqOHC1MCfkjlQ/JaI3XsJb/fPamwfBHdmW90jc2Z41fEV2EWdtsphc qVrRIbwDB/ec6YMFfmdgKQqXkZ8BNSfCrCl2Q70XQruwA9r4x+k2rxadwqc2zj5jHsy/ CHKA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786372407; x=1786977207; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to:content-type; bh=3eGPyLBs9QZ3Nwm6ypDb5+mFyEwjns3mEiwXdV8ptF0=; b=em9R8HIzvPaD+PXWJAa8myQ9paXIt3G8J11SKrsLIsRuc921FgCOIDq0GDBiAVATjV Ju5YqH5unqErE1Tvw+b+fUS9QUhWktf1nmgKNx6ZZumQysv5ZkwMzECLJ2AjVNVB8NFt j7NrmveWJ63MveKIskBjghy/syrjoyPNiEb5wZ2DceuHdGYrfcd83FySh5aKVMuHpzh7 L8zb+7pJ2NCksuO99BPdNBYaUd7+qE2bv2qJ7tVOT91vKhDbfnqanLnDW1KaOfMVRgRn nMH2ld/G+rra98Ud5ngLlgbKTvU2NNEjzmfeYMfeWjD9kLYU/PwjfX2VYrrJ7eWSKEcI Z4Hw== X-Forwarded-Encrypted: i=1; AHgh+Ro2WZ21qolmuW+n7oIffzF0GfhSuMSwaGLJM+vcDWMpGwoAHYD43mIRNorEw8Y4pDq+Egenl2OHYviRY5Q=@vger.kernel.org X-Gm-Message-State: AOJu0YwS9co/d/2o24iwjndLKM0r+Ag1LCiLx186MVoi3nxA/8tz+frK fGhGuwU0B0hhsaUSlLtmH7sDqw9fIfixiMGlMvwIht7bZ+b3SxLDA5Cc0+FNeDxp X-Gm-Gg: AR+sD11pGuY2mP9SzeghvvOATvLTIqhh+i4cbqIQ0//Z+QOw8TJ06fMx8swXA7F4Shp liKE/EVG40NMpoS/nT8EUMXnMypjfcoM1KLFCA5ldg/aOEeej/QSoDVmIqm83W4xcyfD0a/z/zs 1Xc+cRTbD5awFLmF4fZazoFLvoyJVCz31BmJrYyGvOBG6t3Js1MEtNjULYatZ8+qdU3OPPQw44T gb2i4jUM+pPGt9AIm7rkLg8LtdA1PQKDaz6waOgLITolyQfZKl5mWiwrOPwC2dnRV22JtCpKrhd dwsHmbyT3vfGI/nQLdHr7IZ8LCtgo5GlqLR381n7wi9gco4AdbuNgWD4U3kuhzPySN9h0psQlHu VDHiC+1d8g4pWRXIIRZtwREpi4rvMls0kFbzIelN1441Tle9okRX/6UjyfXJ6871RMeEczqqcdq 9bGqLtmX8O+jJ4y54ZSr8t/t15qidKTnRRkPhWbyOEYS8Sx5LJpRR2w1iJ99T93OCS7O4fpbZH2 J4= X-Received: by 2002:a17:90b:3bcb:b0:392:c868:35af with SMTP id 98e67ed59e1d1-392c8683878mr3727898a91.20.1786372406427; Mon, 10 Aug 2026 07:33:26 -0700 (PDT) Received: from localhost.localdomain ([64.186.250.142]) by smtp.gmail.com with ESMTPSA id a92af1059eb24-1410cc132c1sm22197001c88.8.2026.08.10.07.33.24 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 10 Aug 2026 07:33:26 -0700 (PDT) From: Chen Miao 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 Subject: [PATCH v2 2/5] docs: sphinx-pre-install: check GNU Make version Date: Mon, 10 Aug 2026 22:33:06 +0800 Message-ID: <20260810143311.57775-3-chenmiao.ku@gmail.com> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20260810143311.57775-1-chenmiao.ku@gmail.com> References: <20260810143311.57775-1-chenmiao.ku@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit The kernel documentation build requires GNU Make 4.0 or newer, but the Sphinx dependency checker only verifies that a make executable exists. This lets incompatible make implementations pass the check and fail later during the build. Check the GNU Make version on all supported systems. Prefer a compatible gmake command, which is how Homebrew provides GNU Make on macOS, and fall back to make. Document the requirement and the macOS gmake invocation. Signed-off-by: Chen Miao --- Documentation/doc-guide/sphinx.rst | 4 ++- tools/docs/sphinx-pre-install | 41 +++++++++++++++++++++++++++++- 2 files changed, 43 insertions(+), 2 deletions(-) diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index 1e105542a..4fb716e77 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -147,7 +147,9 @@ documentation. After installing MacTeX, restart the terminal or run ``eval "$(/usr/libexec/path_helper)"`` so its command-line tools are visible. The default virtualenv mode is recommended on macOS because PyYAML is installed from ``Documentation/sphinx/requirements.txt`` rather than from a -Homebrew formula. +Homebrew formula. The script also checks for GNU Make 4.0 or newer; when +Homebrew provides it as ``gmake``, use ``gmake htmldocs`` instead of +``make htmldocs``. Installing Sphinx Minimal Version --------------------------------- diff --git a/tools/docs/sphinx-pre-install b/tools/docs/sphinx-pre-install index 1b9d77ec3..54f36c3b8 100755 --- a/tools/docs/sphinx-pre-install +++ b/tools/docs/sphinx-pre-install @@ -40,6 +40,7 @@ from kdoc.python_version import PythonVersion RECOMMENDED_VERSION = PythonVersion("3.4.3").version MIN_PYTHON_VERSION = PythonVersion("3.7").version +MIN_MAKE_VERSION = PythonVersion("4.0").version class DepManager: @@ -308,6 +309,44 @@ class MissingCheckers(AncillaryMethods): return None + def get_make_version(self, cmd): + """Get the GNU Make version, or None if cmd is not GNU Make.""" + if not cmd: + return None + + try: + result = self.run( + [cmd, "--version"], + capture_output=True, + text=True, + check=True, + ) + except (OSError, subprocess.CalledProcessError): + return None + + match = re.search( + r"^GNU Make\s+([0-9]+(?:\.[0-9]+)*)", result.stdout, re.MULTILINE + ) + if not match: + return None + + return PythonVersion.parse_version(match.group(1)) + + def check_make(self): + """Check for GNU Make 4.0 or newer.""" + candidates = ( + os.environ.get("MAKE"), + self.which("gmake"), + self.which("make"), + ) + + for make in candidates: + version = self.get_make_version(make) + if version and version >= MIN_MAKE_VERSION: + return + + self.deps.add_package("make", DepManager.SYSTEM_MANDATORY) + def check_perl_module(self, prog, dtype): """ Does perl have a dependency? Is it available? @@ -1559,7 +1598,7 @@ class SphinxDependencyChecker(MissingCheckers): # Check for needed programs/tools self.check_perl_module("Pod::Usage", DepManager.SYSTEM_MANDATORY) - self.check_program("make", DepManager.SYSTEM_MANDATORY) + self.check_make() self.check_program("which", DepManager.SYSTEM_MANDATORY) self.check_program("dot", DepManager.SYSTEM_OPTIONAL) -- 2.50.1 (Apple Git-155)