]> Gentwo Git Trees - linux/.git/commitdiff
scripts: sphinx-pre-install: move it to tools/docs
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 18 Sep 2025 11:54:41 +0000 (13:54 +0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 18 Sep 2025 17:17:18 +0000 (11:17 -0600)
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>
Documentation/Makefile
Documentation/doc-guide/sphinx.rst
Documentation/sphinx/kerneldoc-preamble.sty
Documentation/translations/it_IT/doc-guide/sphinx.rst
Documentation/translations/zh_CN/doc-guide/sphinx.rst
Documentation/translations/zh_CN/how-to.rst
MAINTAINERS
tools/docs/sphinx-pre-install [moved from scripts/sphinx-pre-install with 100% similarity]

index 0b71f82f73f69781ca25d613eb540eba500b2a41..0e8698fa52ef814c1913dc673052312ab60139ad 100644 (file)
@@ -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/docs/sphinx-pre-install
        @echo "  SKIP    Sphinx $@ target."
 
 else # HAVE_SPHINX
@@ -105,7 +105,7 @@ quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
        fi
 
 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)))
 
 htmldocs-redirects: $(srctree)/Documentation/.renames.txt
@@ -122,7 +122,7 @@ endif
 endif
 
 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)))
 
 # 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)))
 
 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)))
 
 ifeq ($(HAVE_PDFLATEX),0)
@@ -147,7 +147,7 @@ else # HAVE_PDFLATEX
 
 pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CONF_DENY_VF)
 pdfdocs: latexdocs
-       @$(srctree)/scripts/sphinx-pre-install --version-check
+       @$(srctree)/tools/docs/sphinx-pre-install --version-check
        $(foreach var,$(SPHINXDIRS), \
           $(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; \
@@ -157,11 +157,11 @@ pdfdocs: latexdocs
 endif # HAVE_PDFLATEX
 
 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)))
 
 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)))
 
 endif # HAVE_SPHINX
index 607589592bfbde740a498334974cbefa8bb3a430..932f68c530753886230da32a5d0962ae80d90032 100644 (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
 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
        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
 
-       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
 the requirements for images, math expressions and LaTeX build, and assumes
index 5d68395539fe92610c515c4f5f41abe8aff07889..16d9ff46fdf680dd5bd141fa50168d4fa4d21f9e 100644 (file)
            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/docs/sphinx-pre-install}.
            Having optional non-variable ``Noto Serif CJK'' font families will
            improve the looks of those translations.
        \end{sphinxadmonition}}
index 1f513bc336187c6c58d0a10e50d9edff40393bf8..a5c5d935febf3c2e4a6a504c9810fece714c2512 100644 (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
 l'installazione::
 
-       $ ./scripts/sphinx-pre-install
+       $ ./tools/docs/sphinx-pre-install
        Checking if the needed tools for Fedora release 26 (Twenty Six) are available
        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
 
-       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
 di documenti html e PDF, includendo anche il supporto per le immagini, le
index 23eac67fbc30b837f6eeb1a0e6bfffed0c8639e0..3375c6f3a811abeb63156119bdb4adf7b7580b08 100644 (file)
@@ -84,7 +84,7 @@ PDF和LaTeX构建
 这有一个脚本可以自动检查Sphinx依赖项。如果它认得您的发行版,还会提示您所用发行
 版的安装命令::
 
-       $ ./scripts/sphinx-pre-install
+       $ ./tools/docs/sphinx-pre-install
        Checking if the needed tools for Fedora release 26 (Twenty Six) are available
        Warning: better to also install "texlive-luatex85".
        You should run:
@@ -94,7 +94,7 @@ PDF和LaTeX构建
                . sphinx_2.4.4/bin/activate
                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构建的
 需求,并假设将使用虚拟Python环境。html构建所需的依赖项被认为是必需的,其他依
index ddd99c0f9b4d19da7cdcda50df65b855acb732f0..714664fec3083370b613c0460132df9663aa5f85 100644 (file)
@@ -64,7 +64,7 @@ Linux 发行版和简单地使用 Linux 命令行,那么可以迅速开始了
 ::
 
        cd linux
-       ./scripts/sphinx-pre-install
+       ./tools/docs/sphinx-pre-install
 
 以 Fedora 为例,它的输出是这样的::
 
index 473152720b171ad9e0cd71629d5be27a564a992d..30d39a5befdb140893f394e986fce67f7b6c2259 100644 (file)
@@ -7309,7 +7309,6 @@ F:        scripts/lib/abi/*
 F:     scripts/lib/kdoc/*
 F:     tools/docs/*
 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/
@@ -7344,7 +7343,7 @@ L:        linux-doc@vger.kernel.org
 S:     Maintained
 F:     Documentation/sphinx/parse-headers.pl
 F:     scripts/documentation-file-ref-check
-F:     scripts/sphinx-pre-install
+F:     tools/docs/sphinx-pre-install
 
 DOCUMENTATION/ITALIAN
 M:     Federico Vaga <federico.vaga@vaga.pv.it>