From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f181.google.com (mail-pl1-f181.google.com [209.85.214.181]) (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 F2731483BFE for ; Wed, 12 Aug 2026 18:23:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.181 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786559027; cv=none; b=cDK2vW/oAWOVy2dWsfZqiQnWem39PfZj6KE2Fy6bREvK+mnHggxxQYeJjKsUydTdfyijtCaYCN8D5fjGidZCq/NLLgqUpGK8oD0fPGFiNFbF1HstkiozWDWq0aPv4ASMePWZ3vftn9AZYvPONlloXsmCCsdRtLnu7GDY3xW+i9U= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786559027; c=relaxed/simple; bh=JjjMb2uu1YODGgc9Ljh3eGSqXYdCYd1Db9x2dvf0KKg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=GxpqEBLnE7XDbuoHZGHupzm5e2fB5Qlaju8wacKm0zbMTvdleQ0MSXFJyqSp0h7FCu/20BQC5URk+IWgznjQ+mf3rQPWCFX2c9jzw8zZ7+PsAOK9qetsJX5VZOq96Llt/L7GtwcBWXMvjQH4v5y9uGYGEJqtBbmps8nUnbM98M4= 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=ZopdtSgm; arc=none smtp.client-ip=209.85.214.181 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="ZopdtSgm" Received: by mail-pl1-f181.google.com with SMTP id d9443c01a7336-2cace91f112so16645255ad.0 for ; Wed, 12 Aug 2026 11:23:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1786559025; x=1787163825; 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=Cr17zKegf0CAV0ad1vKq8vQpyQFYqiFtNOs4y/ElO2E=; b=ZopdtSgm4PPqhGGjA/j9UpWu22cdVW7ectT34IFAjTd9lDx4FcnPoZ3bVF9fGFH5B/ Ih9DFcl4ASeUBIrAY9Y2EV63eRUvypfCiWRaDPpHENun/t6DPETYXLIml4uujFNuXYmI HUXFxgiLPa+otP8fP7OyuoZKNsJGFLDiyOaCSbF7Bd/N0qViuMfDpM5n0oomeWMQdYQC /32cLZaUdHvVWrihFeR3irMvRNtgWLo04pqdAuLgizSJ9wtRYWn6z9vZ7le8Yn4u3MLf speOVMNRcWAdOXsEph4M6f/wg4Qxw4aX0uD7LZawmDbxe6Nej/JvUyFDZn5Vwn3prHKn 3WoA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786559025; x=1787163825; 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=Cr17zKegf0CAV0ad1vKq8vQpyQFYqiFtNOs4y/ElO2E=; b=fWybx9XKb1ZJ506GdJk7S2v38Q3CSf17sY0qDvO7Y4xQ7umC+wbBFicQ8LRqADrcyo fwrh1/Vw07CYK1qKVg/lkD+EgGoBza8X5gCDkFTeML9S7GKS7MdVY4IyR6d5w6yknYQM n0/I/zmBz4D50cgauRAg0uq+mySAWqApsXZGw29WnLOM2rcZRRjUi/76EOkd7mfOhC3s ju9Wv5T7LATqJqiOF7DRMrddynn99omZrPVnHN02j5Ty6eKf/Juh9qXpPfuxqHmyK1rC 3b7ghkmhQY/2FRXrGt7glBW9/NoFsG1Q64Z9pNlggVncIkqNJrSBVnfquqwNFHMovMpQ I6Hg== X-Forwarded-Encrypted: i=1; AHgh+RqRLzdme3bpx+IqNiPjP1wdDtKKw8BYSj+6FvzhuR8ScygkaOkISJ/RrUJwRfINOKA+t7Hvj4xfHw9Zaig=@vger.kernel.org X-Gm-Message-State: AOJu0YzVD21REs+Y22PmxlVFRO51w7j1LZA9TmLNTygDWR3YPgOwHN5e 9/z8/Pksg5RErQvRyTFQ9xaW42Er1wZXYTOc2KpXYR5O5ZtYDx63D2w6 X-Gm-Gg: AR+sD11W1IJO+Z14V5igUmY6sifHqmS7GrRXWz6xtPLNRadbuYwTiGw3Xd1Jcs9owMs z/TfpLB7+Epo9eerUOAKH0qPUDWZVPZtFEu1V0LDPrk56KuiEcsityVy1NUkK5tB9lIcAau78hl Xarqe3wfTye6gGr/fVt0dr7DeYdfNOAVKNEgyP8ZLStUWPoSRaIwEHUdrh72W2G1qMbUcKlheZb Rcruy6vv88Kaf1Uonu8i2A7bfTP6WfVnjMfxu55D/6Yxx47lCr5BHdOihcybn/19LII0sQGU1lI Rg1irDBd7dSsqivHvhj4HeGBl01YwjQO6fL8418lgYgOen/DwT6EvVX76ErvWr0lYLe8srmIZSv YS6SyCfLI/Z8AYn7KgC51/ukQpDbx5xGDxRmW/Hf3D7zYQb3RjDoi1h4D+d1XI2suAowCYKAdRa CnPy+If/bU+LLg49EXViI2dnCRfpQ7xel1TIyqSD2cw1RiMXUHxoEAJdzDqS90WBozNlAzVAjzM E8= X-Received: by 2002:a05:6a21:3949:b0:3b1:a9ce:507e with SMTP id adf61e73a8af0-3cc55423418mr433328637.32.1786559025024; Wed, 12 Aug 2026 11:23:45 -0700 (PDT) Received: from localhost.localdomain ([64.186.250.142]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-31cf3c08163sm12127695eec.7.2026.08.12.11.23.42 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 12 Aug 2026 11:23:44 -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 v3 3/6] docs: sphinx-pre-install: check GNU Make version Date: Thu, 13 Aug 2026 02:23:20 +0800 Message-ID: <20260812182327.53694-4-chenmiao.ku@gmail.com> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20260812182327.53694-1-chenmiao.ku@gmail.com> References: <20260812182327.53694-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. Use the common kdoc detector so the dependency checker and build wrapper apply the same selection logic. Document the requirement and the macOS gmake invocation. Signed-off-by: Chen Miao --- Documentation/doc-guide/sphinx.rst | 4 +++- tools/docs/sphinx-pre-install | 10 +++++++++- 2 files changed, 12 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 1956f1369..7625ac5a4 100755 --- a/tools/docs/sphinx-pre-install +++ b/tools/docs/sphinx-pre-install @@ -37,6 +37,7 @@ import os.path src_dir = os.path.dirname(os.path.realpath(__file__)) sys.path.insert(0, os.path.join(src_dir, '../lib/python')) from kdoc.python_version import PythonVersion +from kdoc.gmake_detect import find_gmake RECOMMENDED_VERSION = PythonVersion("3.4.3").version MIN_PYTHON_VERSION = PythonVersion("3.7").version @@ -308,6 +309,13 @@ class MissingCheckers(AncillaryMethods): return None + def check_make(self): + """Check for GNU Make 4.0 or newer.""" + if find_gmake(os.environ.get("MAKE")): + 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 +1567,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)