[PATCH v5 04/18] scripts: sphinx-pre-install: move it to tools/docs

Updated
From:Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date:
Message-ID:<7fff5adc2045818ec14179ab6db43e1460abd61a.1757677427.git.mchehab+huawei@kernel.org>
Patch:v5 · 4/18
Language:zh_CN
Patch-ID:84ddc1908a90c709f4b153d6008c72740236f05f
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-install

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 5c20c68be89a..deb2029228ed 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 || sh $(srctree)/scripts/check-variable-fonts.sh || 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\u548cLaTeX\u6784\u5efa \u8fd9\u6709\u4e00\u4e2a\u811a\u672c\u53ef\u4ee5\u81ea\u52a8\u68c0\u67e5Sphinx\u4f9d\u8d56\u9879\u3002\u5982\u679c\u5b83\u8ba4\u5f97\u60a8\u7684\u53d1\u884c\u7248\uff0c\u8fd8\u4f1a\u63d0\u793a\u60a8\u6240\u7528\u53d1\u884c \u7248\u7684\u5b89\u88c5\u547d\u4ee4:: -	$ ./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\u548cLaTeX\u6784\u5efa 		. 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.  \u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0c\u5b83\u4f1a\u68c0\u67e5html\u548cPDF\u7684\u6240\u6709\u4f9d\u8d56\u9879\uff0c\u5305\u62ec\u56fe\u50cf\u3001\u6570\u5b66\u8868\u8fbe\u5f0f\u548cLaTeX\u6784\u5efa\u7684 \u9700\u6c42\uff0c\u5e76\u5047\u8bbe\u5c06\u4f7f\u7528\u865a\u62dfPython\u73af\u5883\u3002html\u6784\u5efa\u6240\u9700\u7684\u4f9d\u8d56\u9879\u88ab\u8ba4\u4e3a\u662f\u5fc5\u9700\u7684\uff0c\u5176\u4ed6\u4f9ddiff --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 \u53d1\u884c\u7248\u548c\u7b80\u5355\u5730\u4f7f\u7528 Linux \u547d\u4ee4\u884c\uff0c\u90a3\u4e48\u53ef\u4ee5\u8fc5\u901f\u5f00\u59cb\u4e86 ::  	cd linux-	./scripts/sphinx-pre-install+	./tools/docs/sphinx-pre-install  \u4ee5 Fedora \u4e3a\u4f8b\uff0c\u5b83\u7684\u8f93\u51fa\u662f\u8fd9\u6837\u7684:: diff --git a/MAINTAINERS b/MAINTAINERSindex ef87548b8f88..06bbed30b788 100644--- a/MAINTAINERS+++ b/MAINTAINERS@@ -7310,7 +7310,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/@@ -7345,7 +7344,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