[PATCH v7 07/24] scripts: sphinx-pre-install: move it to tools/docs
#UpdatedFrom:Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date:
Message-ID:<3069b4cdc1cfdc8dfafe2998c4a69235203b855d.1758111077.git.mchehab+huawei@kernel.org>
Patch:v7 · 7/24
Language:zh_CN
Patch-ID:75e7c8bb2b7c5860424e24f5ca72b7eb9c98865b
Files:
Documentation/MakefileDocumentation/doc-guide/sphinx.rstDocumentation/sphinx/kerneldoc-preamble.styDocumentation/translations/it_IT/doc-guide/sphinx.rstDocumentation/translations/zh_CN/doc-guide/sphinx.rstDocumentation/translations/zh_CN/how-to.rstMAINTAINERStools/docs/sphinx-pre-installLinks:lore message ↗ · raw mail ↗
Patch content 8 changed files
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>--- 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 | 3 +-- {scripts => tools/docs}/sphinx-pre-install | 0 8 files changed, 16 insertions(+), 17 deletions(-) rename {scripts => tools/docs}/sphinx-pre-install (100%) diff --git a/Documentation/Makefile b/Documentation/Makefileindex 6e11d0593742..fd6399c79fab 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/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))) # If Rust support is available and .config exists, add rustdoc generated contents.@@ -119,7 +119,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@@ -131,7 +131,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)@@ -144,7 +144,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; \@@ -154,11 +154,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_SPHINXdiff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rstindex 607589592bfb..932f68c53075 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 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 assumesdiff --git a/Documentation/sphinx/kerneldoc-preamble.sty b/Documentation/sphinx/kerneldoc-preamble.styindex 5d68395539fe..16d9ff46fdf6 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/docs/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/Documentation/translations/it_IT/doc-guide/sphinx.rstindex 1f513bc33618..a5c5d935febf 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 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, lediff --git a/Documentation/translations/zh_CN/doc-guide/sphinx.rst b/Documentation/translations/zh_CN/doc-guide/sphinx.rstindex 23eac67fbc30..3375c6f3a811 100644--- a/Documentation/translations/zh_CN/doc-guide/sphinx.rst+++ b/Documentation/translations/zh_CN/doc-guide/sphinx.rst@@ -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构建所需的依赖项被认为是必需的,其他依diff --git a/Documentation/translations/zh_CN/how-to.rst b/Documentation/translations/zh_CN/how-to.rstindex ddd99c0f9b4d..714664fec308 100644--- a/Documentation/translations/zh_CN/how-to.rst+++ b/Documentation/translations/zh_CN/how-to.rst@@ -64,7 +64,7 @@ Linux 发行版和简单地使用 Linux 命令行,那么可以迅速开始了 :: cd linux- ./scripts/sphinx-pre-install+ ./tools/docs/sphinx-pre-install 以 Fedora 为例,它的输出是这样的:: diff --git a/MAINTAINERS b/MAINTAINERSindex 76dd823bfcc4..16a5d6ab627d 100644--- a/MAINTAINERS+++ b/MAINTAINERS@@ -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>diff --git a/scripts/sphinx-pre-install b/tools/docs/sphinx-pre-installsimilarity index 100%rename from scripts/sphinx-pre-installrename to tools/docs/sphinx-pre-install-- 2.51.0