From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.52]) (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 62D723EC83B for ; Fri, 14 Aug 2026 21:44:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.52 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786743878; cv=none; b=JxQ9R8JVatje80uNXBhscAiVcN/M3/DuQi3JWDCvuFY17i23FPXA3tswGvtaGdQ1J2E4W7/t5pmri2p/jRcwwFLauhnW/rHy62/SP0eiXgTEFqrnfY3aaORr0YH0OgNCyvruX98rWfihjppayjvwxl7LVBkDJ0c+98MfKkMyiwY= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786743878; c=relaxed/simple; bh=xKFZ9Vz8OJAAmvPW1EGN8mwA1pKRyL+4q+f5g03vOI0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=kgN7UeUwYMt9B37shGgWBTaakZSWD/nEktXAG5e3lbksFFnHwbK8VqM6VQsPKw322l8MoJKuiZNJFgKSeRFa0/ddEwzEbWk8tVi2GJqzczCkYetgCQs8YT5c5qp4z1lq/k9s5I2ff1of0rmWbSLyyqtC3M6cMobnhnejqlAGr6k= 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=YsZt6QNy; arc=none smtp.client-ip=209.85.216.52 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="YsZt6QNy" Received: by mail-pj1-f52.google.com with SMTP id 98e67ed59e1d1-38759bcd877so1956479a91.2 for ; Fri, 14 Aug 2026 14:44:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1786743877; x=1787348677; 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=Fsj/ChwjVSroo4iHvgI4/yCeHJiG8xSqz51KIR6jdP0=; b=YsZt6QNyg0P5lH8WNlyT8fRiVEbOfiAW5heHOsxOJ8wDXLRNu+5BuMy9oT0qqFR5Tx 0hkkjigJjaPcMGL1tHz9snu0dfEHGKYZlJz1aowUTaNhCF3SiawkmnL2FH2SzQBYFc7P O4ewsyILdIqwrJATIic3qsljy4R2yAgJlDh1YMA8MWQ0MGPDsVoNacKz/FzcUijH3o07 92Z8MpQAJqLO7lnaswgFi6lGEQUpLaY2q7OebZ5EuWtGnh/Yn0schYSWLdRwQzs8XTeP q/uX1Y3N7ykovRECV9N65wCp/WOr43QoVrgohjUtdPDoy2h1LTPNU4BdEkJx0AD8cBH5 Ga3Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786743877; x=1787348677; 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=Fsj/ChwjVSroo4iHvgI4/yCeHJiG8xSqz51KIR6jdP0=; b=pcXRAbwBM9ouzuBduO6W4Tt0ZK6Ob7GkYgIFPj0I1i6p7oODfcYTRruikJhUlaPZNL gKU/f5kuEYhtRDuEu4NCplwbIn1bjpgZrdYmV3gfidp9s8HdCtgz3e35kWI+fk7KFqcn XBKrFeFfpgf8jjg8ZJhzMBbBXm12xjIj8B8QqY9sMBanWcskkUKuL8mau4gI6Vh9j9Ev 2rZoDP7lwXpy2eUI08pNURZwnkuc8EpEkAKV+AOHJ93dlimOlbUlz18GFLHrGKX4JzIp GPClt3D16fUcQXjGDa82XpkhEfztC52PyipSIrwkDlklaGvCK7y2WgxatGnYsfPtAHDT BH7w== X-Forwarded-Encrypted: i=1; AHgh+Rpln40zZlzd2Vkw4OdQX4tOBIG+x4ro/kCE9hWbaSurPO7zE47kIugjPREmR/9WEhmgv0rdIGMWbLdw1qw=@vger.kernel.org X-Gm-Message-State: AOJu0YyiNJy7dc2d2UQqf3vC2QW+dRU4XLcGtaHhxmmx4GzUZepXH8lx Jb0UtrcWlcfCC4wiQYSr/cP35OHra2WwJQn7TNEJqKGxq6EvsgQ/kDGo X-Gm-Gg: AR+sD109eBDWDBXqRl6RWqxecr3//yD8NaemEqKSngJYzD2GO6qwylzcCDrUy3/7s+c LSjpP4lk93/JUsJDW/DILIfnLM8knCUTM6IrGrD6hYtvWfqk88o3G2P3TuiTzKGqBrIeHz7Wh5b 0+AfZ7+10Abw5QV/x+kWluM/ZpdLfSMb68DBxgWriY095pEqhNmlulZpo6XU1+8S2Rg6HQGz6CH ix/XX8hJNyr97iShaOn3EeXyufFFI8LAP3nxSwiVrA3cuDaoL7wkZP7XdrS7OdNKnwvtoarDzxm hcOsaYXo18FfnwIXjOjDlNO5fU/F0gt0mEd/pOeoufpHqWnlkTuRjvyf1Eg//sA2VW2OMZgN6lV rFb8gEY3lJoPTqkwPzup3o4ogZKNSRzMDi/wpGI/Rw/APKDQ8KqFdW9MaFRHsJ5Wk0tqy6+InNl iaC0JIZWaaDfwcJBiUik2Pdzchke+VJSf0mi6I4i0VZfQw1PAoLnI5ZCE6OIOaksmG6oJYk73wi DI= X-Received: by 2002:a05:6a20:a11d:b0:3b4:e4f6:4f15 with SMTP id adf61e73a8af0-3cc71d5545dmr9768406637.5.1786743876482; Fri, 14 Aug 2026 14:44:36 -0700 (PDT) Received: from localhost.localdomain ([64.186.250.142]) by smtp.gmail.com with ESMTPSA id 5a478bee46e88-320d5bd918fsm8083617eec.2.2026.08.14.14.44.33 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Fri, 14 Aug 2026 14:44:36 -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 , Mauro Carvalho Chehab Subject: [PATCH v4 3/6] docs: sphinx-pre-install: check GNU Make version Date: Sat, 15 Aug 2026 05:44:15 +0800 Message-ID: <20260814214419.49925-4-chenmiao.ku@gmail.com> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20260814214419.49925-1-chenmiao.ku@gmail.com> References: <20260814214419.49925-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 Reviewed-by: Mauro Carvalho Chehab --- 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)