Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

scripts: sphinx-pre-install: move it to tools/docs 

As we're reorganizing the place where doc scripts are located,
move this one to tools/docs.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Message-ID: <5e2c40d3aebfd67b7ac7817f548bd1fa4ff661a8.1758196090.git.mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2025-09-18 13:54:41 +02:00 committed by Jonathan Corbet
parent 92ea342ff6
commit abd61d1ff8
8 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/Makefile
View File

@ -46,7 +46,7 @@ ifeq ($(HAVE_SPHINX),0)
.DEFAULT: .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.) $(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 @echo
@$(srctree)/scripts/sphinx-pre-install @$(srctree)/tools/docs/sphinx-pre-install
@echo " SKIP Sphinx $@ target." @echo " SKIP Sphinx $@ target."
else # HAVE_SPHINX else # HAVE_SPHINX
@ -105,7 +105,7 @@ quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
fi fi
htmldocs: htmldocs:
@$(srctree)/scripts/sphinx-pre-install --version-check @$(srctree)/tools/docs/sphinx-pre-install --version-check
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
htmldocs-redirects: $(srctree)/Documentation/.renames.txt htmldocs-redirects: $(srctree)/Documentation/.renames.txt
@ -122,7 +122,7 @@ endif
endif endif
texinfodocs: texinfodocs:
@$(srctree)/scripts/sphinx-pre-install --version-check @$(srctree)/tools/docs/sphinx-pre-install --version-check
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var))) @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var)))
# Note: the 'info' Make target is generated by sphinx itself when # Note: the 'info' Make target is generated by sphinx itself when
@ -134,7 +134,7 @@ linkcheckdocs:
@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
latexdocs: latexdocs:
@$(srctree)/scripts/sphinx-pre-install --version-check @$(srctree)/tools/docs/sphinx-pre-install --version-check
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))
ifeq ($(HAVE_PDFLATEX),0) ifeq ($(HAVE_PDFLATEX),0)
@ -147,7 +147,7 @@ else # HAVE_PDFLATEX
pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CONF_DENY_VF) pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CONF_DENY_VF)
pdfdocs: latexdocs pdfdocs: latexdocs
@$(srctree)/scripts/sphinx-pre-install --version-check @$(srctree)/tools/docs/sphinx-pre-install --version-check
$(foreach var,$(SPHINXDIRS), \ $(foreach var,$(SPHINXDIRS), \
$(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" $(DENY_VF) -C $(BUILDDIR)/$(var)/latex || $(PYTHON3) $(srctree)/tools/docs/check-variable-fonts.py || exit; \ $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" $(DENY_VF) -C $(BUILDDIR)/$(var)/latex || $(PYTHON3) $(srctree)/tools/docs/check-variable-fonts.py || exit; \
mkdir -p $(BUILDDIR)/$(var)/pdf; \ mkdir -p $(BUILDDIR)/$(var)/pdf; \
@ -157,11 +157,11 @@ pdfdocs: latexdocs
endif # HAVE_PDFLATEX endif # HAVE_PDFLATEX
epubdocs: epubdocs:
@$(srctree)/scripts/sphinx-pre-install --version-check @$(srctree)/tools/docs/sphinx-pre-install --version-check
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
xmldocs: xmldocs:
@$(srctree)/scripts/sphinx-pre-install --version-check @$(srctree)/tools/docs/sphinx-pre-install --version-check
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
endif # HAVE_SPHINX endif # HAVE_SPHINX

4
Documentation/doc-guide/sphinx.rst
View File

@ -106,7 +106,7 @@ There's a script that automatically checks for Sphinx dependencies. If it can
recognize your distribution, it will also give a hint about the install recognize your distribution, it will also give a hint about the install
command line options for your distro:: command line options for your distro::
$ ./scripts/sphinx-pre-install $ ./tools/docs/sphinx-pre-install
Checking if the needed tools for Fedora release 26 (Twenty Six) are available Checking if the needed tools for Fedora release 26 (Twenty Six) are available
Warning: better to also install "texlive-luatex85". Warning: better to also install "texlive-luatex85".
You should run: You should run:
@ -116,7 +116,7 @@ command line options for your distro::
. sphinx_2.4.4/bin/activate . sphinx_2.4.4/bin/activate
pip install -r Documentation/sphinx/requirements.txt pip install -r Documentation/sphinx/requirements.txt
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/docs/sphinx-pre-install line 468.
By default, it checks all the requirements for both html and PDF, including By default, it checks all the requirements for both html and PDF, including
the requirements for images, math expressions and LaTeX build, and assumes the requirements for images, math expressions and LaTeX build, and assumes

2
Documentation/sphinx/kerneldoc-preamble.sty
View File

@ -220,7 +220,7 @@
If you want them, please install non-variable ``Noto Sans CJK'' If you want them, please install non-variable ``Noto Sans CJK''
font families along with the texlive-xecjk package by following font families along with the texlive-xecjk package by following
instructions from instructions from
\sphinxcode{./scripts/sphinx-pre-install}. \sphinxcode{./tools/docs/sphinx-pre-install}.
Having optional non-variable ``Noto Serif CJK'' font families will Having optional non-variable ``Noto Serif CJK'' font families will
improve the looks of those translations. improve the looks of those translations.
\end{sphinxadmonition}} \end{sphinxadmonition}}

4
Documentation/translations/it_IT/doc-guide/sphinx.rst
View File

@ -109,7 +109,7 @@ Sphinx. Se lo script riesce a riconoscere la vostra distribuzione, allora
sarà in grado di darvi dei suggerimenti su come procedere per completare sarà in grado di darvi dei suggerimenti su come procedere per completare
l'installazione:: l'installazione::
$ ./scripts/sphinx-pre-install $ ./tools/docs/sphinx-pre-install
Checking if the needed tools for Fedora release 26 (Twenty Six) are available Checking if the needed tools for Fedora release 26 (Twenty Six) are available
Warning: better to also install "texlive-luatex85". Warning: better to also install "texlive-luatex85".
You should run: You should run:
@ -119,7 +119,7 @@ l'installazione::
. sphinx_2.4.4/bin/activate . sphinx_2.4.4/bin/activate
pip install -r Documentation/sphinx/requirements.txt pip install -r Documentation/sphinx/requirements.txt
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/docs/sphinx-pre-install line 468.
L'impostazione predefinita prevede il controllo dei requisiti per la generazione L'impostazione predefinita prevede il controllo dei requisiti per la generazione
di documenti html e PDF, includendo anche il supporto per le immagini, le di documenti html e PDF, includendo anche il supporto per le immagini, le

4
Documentation/translations/zh_CN/doc-guide/sphinx.rst
View File

@ -84,7 +84,7 @@ PDF和LaTeX构建
这有一个脚本可以自动检查Sphinx依赖项。如果它认得您的发行版，还会提示您所用发行 这有一个脚本可以自动检查Sphinx依赖项。如果它认得您的发行版，还会提示您所用发行
版的安装命令:: 版的安装命令::
$ ./scripts/sphinx-pre-install $ ./tools/docs/sphinx-pre-install
Checking if the needed tools for Fedora release 26 (Twenty Six) are available Checking if the needed tools for Fedora release 26 (Twenty Six) are available
Warning: better to also install "texlive-luatex85". Warning: better to also install "texlive-luatex85".
You should run: You should run:
@ -94,7 +94,7 @@ PDF和LaTeX构建
. sphinx_2.4.4/bin/activate . sphinx_2.4.4/bin/activate
pip install -r Documentation/sphinx/requirements.txt pip install -r Documentation/sphinx/requirements.txt
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/docs/sphinx-pre-install line 468.
默认情况下，它会检查html和PDF的所有依赖项，包括图像、数学表达式和LaTeX构建的 默认情况下，它会检查html和PDF的所有依赖项，包括图像、数学表达式和LaTeX构建的
需求，并假设将使用虚拟Python环境。html构建所需的依赖项被认为是必需的，其他依 需求，并假设将使用虚拟Python环境。html构建所需的依赖项被认为是必需的，其他依

2
Documentation/translations/zh_CN/how-to.rst
View File

@ -64,7 +64,7 @@ Linux 发行版和简单地使用 Linux 命令行，那么可以迅速开始了
:: ::
cd linux cd linux
./scripts/sphinx-pre-install ./tools/docs/sphinx-pre-install
以 Fedora 为例，它的输出是这样的:: 以 Fedora 为例，它的输出是这样的::

3
MAINTAINERS
View File

@ -7309,7 +7309,6 @@ F: scripts/lib/abi/*
F: scripts/lib/kdoc/* F: scripts/lib/kdoc/*
F: tools/docs/* F: tools/docs/*
F: tools/net/ynl/pyynl/lib/doc_generator.py F: tools/net/ynl/pyynl/lib/doc_generator.py
F: scripts/sphinx-pre-install
X: Documentation/ABI/ X: Documentation/ABI/
X: Documentation/admin-guide/media/ X: Documentation/admin-guide/media/
X: Documentation/devicetree/ X: Documentation/devicetree/
@ -7344,7 +7343,7 @@ L: linux-doc@vger.kernel.org
S: Maintained S: Maintained
F: Documentation/sphinx/parse-headers.pl F: Documentation/sphinx/parse-headers.pl
F: scripts/documentation-file-ref-check F: scripts/documentation-file-ref-check
F: scripts/sphinx-pre-install F: tools/docs/sphinx-pre-install
DOCUMENTATION/ITALIAN DOCUMENTATION/ITALIAN
M: Federico Vaga <federico.vaga@vaga.pv.it> M: Federico Vaga <federico.vaga@vaga.pv.it>

0
scripts/sphinx-pre-install → tools/docs/sphinx-pre-install
View File