From nobody Sat Oct 4 19:19:13 2025 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 945D33093D9; Wed, 13 Aug 2025 21:32:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=45.79.88.28 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755120758; cv=none; b=MkStagalTgRFhbwy4sdb8fqhAKeoWWS5spGnsRBr6lBDpbCyk5X2KCRJkrTDwH+Rgf0yioI70P5H5sApBP1S9WEUmrR/obDsz4Tu2SSdpEWm9R+XxPq9sYcq1XIZ3Nw17NxM45SAupeAcZ8ixFN5GcdtLtw8eAiX32/bXhS0ppI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1755120758; c=relaxed/simple; bh=EhNf0jiEtdDWAQPcaEI9GyJeZ6PI01pY8P9MzP0ffXA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=EA9zK3PqU1gYC/FfpLs//9NGI+n2c9Jbm61DRl9SySrwRRvQKJdv9qnQTYFiH5aeWNcJnm16eZVyaQCOgNrQ/cooZs+b29Jf9eUmqN885PlXlAl8KW46Wm3yMz4NkUy73lsTEhU5jXk1yFtOtEIMJA6z59s+DanbNKQ3VTnhQuc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net; spf=pass smtp.mailfrom=lwn.net; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b=OFm9wmCp; arc=none smtp.client-ip=45.79.88.28 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="OFm9wmCp" DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 6ED7A40AFA DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1755120751; bh=jUgpkfrm8XLsvgYXsY28qPmnnuIaoJZxaMVlOOoZBdQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=OFm9wmCp9vjZFfQTqIyViyS0j9mkr7RsADNIt4/9qID0crcrJ1hL3z834zAI0iAKl RKA1uD84evJQjsQ0bwhTJNLQf2jimZjKPTppmnENFCb1mwJsA7FP+PspodzvwYMe6b jJjjuBT7FyHPbzQeLqLcEA8Oqbr9F73edaCEpJWgppnt6pytKxwn/5joQ74zKd8N+9 pWjg5whpukHcqtU58MwXP+RcYtkVq7hLHYwca6g94uggtIkacL9TOBCN9aoe8yYdEN tTtvi5y2Y6Gs2YVu7FlPgsGBEzyLfB4MX4FtTGzPrFLn6DRhVX58ikWyksUtWJzTcC XjUQUCmgD6Mig== Received: from trenco.lwn.net (unknown [IPv6:2601:280:4600:2da9::1fe]) by ms.lwn.net (Postfix) with ESMTPA id 6ED7A40AFA; Wed, 13 Aug 2025 21:32:31 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Mauro Carvalho Chehab , Akira Yokosawa , Randy Dunlap , Jonathan Corbet Subject: [PATCH 07/13] docs: move sphinx-pre-install to tools/doc Date: Wed, 13 Aug 2025 15:32:06 -0600 Message-ID: <20250813213218.198582-8-corbet@lwn.net> X-Mailer: git-send-email 2.50.1 In-Reply-To: <20250813213218.198582-1-corbet@lwn.net> References: <20250813213218.198582-1-corbet@lwn.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Put this tool with the other documentation-related scripts. Signed-off-by: Jonathan Corbet --- Documentation/Makefile | 14 +++++++------- Documentation/doc-guide/sphinx.rst | 4 ++-- Documentation/sphinx/kerneldoc-preamble.sty | 2 +- .../translations/it_IT/doc-guide/sphinx.rst | 4 ++-- .../translations/zh_CN/doc-guide/sphinx.rst | 4 ++-- Documentation/translations/zh_CN/how-to.rst | 2 +- MAINTAINERS | 2 -- {scripts =3D> tools/doc}/sphinx-pre-install | 0 8 files changed, 15 insertions(+), 17 deletions(-) rename {scripts =3D> tools/doc}/sphinx-pre-install (100%) diff --git a/Documentation/Makefile b/Documentation/Makefile index eef5decb79b8..818d866756b0 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -46,7 +46,7 @@ ifeq ($(HAVE_SPHINX),0) .DEFAULT: $(warning The '$(SPHINXBUILD)' command was not found. Make sure you have = Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point= to the full path of the '$(SPHINXBUILD)' executable.) @echo - @$(srctree)/scripts/sphinx-pre-install + @$(srctree)/tools/doc/sphinx-pre-install @echo " SKIP Sphinx $@ target." =20 else # HAVE_SPHINX @@ -105,7 +105,7 @@ quiet_cmd_sphinx =3D SPHINX $@ --> file://$(abspath $(= BUILDDIR)/$3/$4) fi =20 htmldocs: - @$(srctree)/scripts/sphinx-pre-install --version-check + @$(srctree)/tools/doc/sphinx-pre-install --version-check @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) =20 # If Rust support is available and .config exists, add rustdoc generated c= ontents. @@ -119,7 +119,7 @@ endif endif =20 texinfodocs: - @$(srctree)/scripts/sphinx-pre-install --version-check + @$(srctree)/tools/doc/sphinx-pre-install --version-check @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texin= fo,$(var))) =20 # Note: the 'info' Make target is generated by sphinx itself when @@ -131,7 +131,7 @@ linkcheckdocs: @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(v= ar))) =20 latexdocs: - @$(srctree)/scripts/sphinx-pre-install --version-check + @$(srctree)/tools/doc/sphinx-pre-install --version-check @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$= (var))) =20 ifeq ($(HAVE_PDFLATEX),0) @@ -144,7 +144,7 @@ else # HAVE_PDFLATEX =20 pdfdocs: DENY_VF =3D XDG_CONFIG_HOME=3D$(FONTS_CONF_DENY_VF) pdfdocs: latexdocs - @$(srctree)/scripts/sphinx-pre-install --version-check + @$(srctree)/tools/doc/sphinx-pre-install --version-check $(foreach var,$(SPHINXDIRS), \ $(MAKE) PDFLATEX=3D"$(PDFLATEX)" LATEXOPTS=3D"$(LATEXOPTS)" $(DENY_VF)= -C $(BUILDDIR)/$(var)/latex || sh $(srctree)/tools/doc/check-variable-font= s.sh || exit; \ mkdir -p $(BUILDDIR)/$(var)/pdf; \ @@ -154,11 +154,11 @@ pdfdocs: latexdocs endif # HAVE_PDFLATEX =20 epubdocs: - @$(srctree)/scripts/sphinx-pre-install --version-check + @$(srctree)/tools/doc/sphinx-pre-install --version-check @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(v= ar))) =20 xmldocs: - @$(srctree)/scripts/sphinx-pre-install --version-check + @$(srctree)/tools/doc/sphinx-pre-install --version-check @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var= ))) =20 endif # HAVE_SPHINX diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/s= phinx.rst index 607589592bfb..2a0fc6c39cf4 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -106,7 +106,7 @@ There's a script that automatically checks for Sphinx d= ependencies. If it can recognize your distribution, it will also give a hint about the install command line options for your distro:: =20 - $ ./scripts/sphinx-pre-install + $ ./tools/doc/sphinx-pre-install Checking if the needed tools for Fedora release 26 (Twenty Six) are avail= able Warning: better to also install "texlive-luatex85". You should run: @@ -116,7 +116,7 @@ command line options for your distro:: . sphinx_2.4.4/bin/activate pip install -r Documentation/sphinx/requirements.txt =20 - Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-= install line 468. + Can't build as 1 mandatory dependency is missing at ./tools/doc/sphinx-pr= e-install line 468. =20 By default, it checks all the requirements for both html and PDF, including the requirements for images, math expressions and LaTeX build, and assumes diff --git a/Documentation/sphinx/kerneldoc-preamble.sty b/Documentation/sp= hinx/kerneldoc-preamble.sty index 5d68395539fe..736c2568377e 100644 --- a/Documentation/sphinx/kerneldoc-preamble.sty +++ b/Documentation/sphinx/kerneldoc-preamble.sty @@ -220,7 +220,7 @@ If you want them, please install non-variable ``Noto Sans CJK'' font families along with the texlive-xecjk package by following instructions from - \sphinxcode{./scripts/sphinx-pre-install}. + \sphinxcode{./tools/doc/sphinx-pre-install}. Having optional non-variable ``Noto Serif CJK'' font families will improve the looks of those translations. \end{sphinxadmonition}} diff --git a/Documentation/translations/it_IT/doc-guide/sphinx.rst b/Docume= ntation/translations/it_IT/doc-guide/sphinx.rst index 1f513bc33618..104aa159c1ce 100644 --- a/Documentation/translations/it_IT/doc-guide/sphinx.rst +++ b/Documentation/translations/it_IT/doc-guide/sphinx.rst @@ -109,7 +109,7 @@ Sphinx. Se lo script riesce a riconoscere la vostra dis= tribuzione, allora sar=C3=A0 in grado di darvi dei suggerimenti su come procedere per complet= are l'installazione:: =20 - $ ./scripts/sphinx-pre-install + $ ./tools/doc/sphinx-pre-install Checking if the needed tools for Fedora release 26 (Twenty Six) are avail= able Warning: better to also install "texlive-luatex85". You should run: @@ -119,7 +119,7 @@ l'installazione:: . sphinx_2.4.4/bin/activate pip install -r Documentation/sphinx/requirements.txt =20 - Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-= install line 468. + Can't build as 1 mandatory dependency is missing at ./tools/doc/sphinx-pr= e-install line 468. =20 L'impostazione predefinita prevede il controllo dei requisiti per la gener= azione di documenti html e PDF, includendo anche il supporto per le immagini, le diff --git a/Documentation/translations/zh_CN/doc-guide/sphinx.rst b/Docume= ntation/translations/zh_CN/doc-guide/sphinx.rst index 23eac67fbc30..3d2c4e262bb5 100644 --- a/Documentation/translations/zh_CN/doc-guide/sphinx.rst +++ b/Documentation/translations/zh_CN/doc-guide/sphinx.rst @@ -84,7 +84,7 @@ PDF=E5=92=8CLaTeX=E6=9E=84=E5=BB=BA =E8=BF=99=E6=9C=89=E4=B8=80=E4=B8=AA=E8=84=9A=E6=9C=AC=E5=8F=AF=E4=BB=A5= =E8=87=AA=E5=8A=A8=E6=A3=80=E6=9F=A5Sphinx=E4=BE=9D=E8=B5=96=E9=A1=B9=E3=80= =82=E5=A6=82=E6=9E=9C=E5=AE=83=E8=AE=A4=E5=BE=97=E6=82=A8=E7=9A=84=E5=8F=91= =E8=A1=8C=E7=89=88=EF=BC=8C=E8=BF=98=E4=BC=9A=E6=8F=90=E7=A4=BA=E6=82=A8=E6= =89=80=E7=94=A8=E5=8F=91=E8=A1=8C =E7=89=88=E7=9A=84=E5=AE=89=E8=A3=85=E5=91=BD=E4=BB=A4:: =20 - $ ./scripts/sphinx-pre-install + $ ./tools/doc/sphinx-pre-install Checking if the needed tools for Fedora release 26 (Twenty Six) are avail= able Warning: better to also install "texlive-luatex85". You should run: @@ -94,7 +94,7 @@ PDF=E5=92=8CLaTeX=E6=9E=84=E5=BB=BA . sphinx_2.4.4/bin/activate pip install -r Documentation/sphinx/requirements.txt =20 - Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-= install line 468. + Can't build as 1 mandatory dependency is missing at ./tools/doc/sphinx-pr= e-install line 468. =20 =E9=BB=98=E8=AE=A4=E6=83=85=E5=86=B5=E4=B8=8B=EF=BC=8C=E5=AE=83=E4=BC=9A= =E6=A3=80=E6=9F=A5html=E5=92=8CPDF=E7=9A=84=E6=89=80=E6=9C=89=E4=BE=9D=E8= =B5=96=E9=A1=B9=EF=BC=8C=E5=8C=85=E6=8B=AC=E5=9B=BE=E5=83=8F=E3=80=81=E6=95= =B0=E5=AD=A6=E8=A1=A8=E8=BE=BE=E5=BC=8F=E5=92=8CLaTeX=E6=9E=84=E5=BB=BA=E7= =9A=84 =E9=9C=80=E6=B1=82=EF=BC=8C=E5=B9=B6=E5=81=87=E8=AE=BE=E5=B0=86=E4=BD=BF= =E7=94=A8=E8=99=9A=E6=8B=9FPython=E7=8E=AF=E5=A2=83=E3=80=82html=E6=9E=84= =E5=BB=BA=E6=89=80=E9=9C=80=E7=9A=84=E4=BE=9D=E8=B5=96=E9=A1=B9=E8=A2=AB=E8= =AE=A4=E4=B8=BA=E6=98=AF=E5=BF=85=E9=9C=80=E7=9A=84=EF=BC=8C=E5=85=B6=E4=BB= =96=E4=BE=9D diff --git a/Documentation/translations/zh_CN/how-to.rst b/Documentation/tr= anslations/zh_CN/how-to.rst index cf66c72ee0c5..77da507d29cf 100644 --- a/Documentation/translations/zh_CN/how-to.rst +++ b/Documentation/translations/zh_CN/how-to.rst @@ -64,7 +64,7 @@ Linux =E5=8F=91=E8=A1=8C=E7=89=88=E5=92=8C=E7=AE=80=E5=8D= =95=E5=9C=B0=E4=BD=BF=E7=94=A8 Linux =E5=91=BD=E4=BB=A4=E8=A1=8C=EF=BC=8C= =E9=82=A3=E4=B9=88=E5=8F=AF=E4=BB=A5=E8=BF=85=E9=80=9F=E5=BC=80=E5=A7=8B=E4= =BA=86 :: =20 cd linux - ./scripts/sphinx-pre-install + ./tools/doc/sphinx-pre-install =20 =E4=BB=A5 Fedora =E4=B8=BA=E4=BE=8B=EF=BC=8C=E5=AE=83=E7=9A=84=E8=BE=93=E5= =87=BA=E6=98=AF=E8=BF=99=E6=A0=B7=E7=9A=84:: =20 diff --git a/MAINTAINERS b/MAINTAINERS index b41b78215035..2f1374130240 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -7306,7 +7306,6 @@ F: scripts/kernel-doc* F: scripts/lib/abi/* F: scripts/lib/kdoc/* F: tools/net/ynl/pyynl/lib/doc_generator.py -F: scripts/sphinx-pre-install X: Documentation/ABI/ X: Documentation/admin-guide/media/ X: Documentation/devicetree/ @@ -7341,7 +7340,6 @@ L: linux-doc@vger.kernel.org S: Maintained F: Documentation/sphinx/parse-headers.pl F: tools/doc/ -F: scripts/sphinx-pre-install =20 DOCUMENTATION/ITALIAN M: Federico Vaga diff --git a/scripts/sphinx-pre-install b/tools/doc/sphinx-pre-install similarity index 100% rename from scripts/sphinx-pre-install rename to tools/doc/sphinx-pre-install --=20 2.50.1