1 # -*- makefile -*- 1 # -*- makefile -*-
2 # Makefile for Sphinx documentation 2 # Makefile for Sphinx documentation
3 # 3 #
4 4
5 # for cleaning 5 # for cleaning
6 subdir- := devicetree/bindings 6 subdir- := devicetree/bindings
7 7
8 # Check for broken documentation file referenc 8 # Check for broken documentation file references
9 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y) 9 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
10 $(shell $(srctree)/scripts/documentation-file- 10 $(shell $(srctree)/scripts/documentation-file-ref-check --warn)
11 endif 11 endif
12 12
13 # Check for broken ABI files 13 # Check for broken ABI files
14 ifeq ($(CONFIG_WARN_ABI_ERRORS),y) 14 ifeq ($(CONFIG_WARN_ABI_ERRORS),y)
15 $(shell $(srctree)/scripts/get_abi.pl validate 15 $(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI)
16 endif 16 endif
17 17
18 # You can set these variables from the command 18 # You can set these variables from the command line.
19 SPHINXBUILD = sphinx-build 19 SPHINXBUILD = sphinx-build
20 SPHINXOPTS = 20 SPHINXOPTS =
21 SPHINXDIRS = . 21 SPHINXDIRS = .
22 DOCS_THEME = <<
23 DOCS_CSS = <<
24 _SPHINXDIRS = $(sort $(patsubst $(srctree)/D 22 _SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
25 SPHINX_CONF = conf.py 23 SPHINX_CONF = conf.py
26 PAPER = 24 PAPER =
27 BUILDDIR = $(obj)/output 25 BUILDDIR = $(obj)/output
28 PDFLATEX = xelatex 26 PDFLATEX = xelatex
29 LATEXOPTS = -interaction=batchmode -no-she !! 27 LATEXOPTS = -interaction=batchmode
30 28
31 # For denylisting "variable font" files !! 29 ifeq ($(KBUILD_VERBOSE),0)
32 # Can be overridden by setting as an env varia <<
33 FONTS_CONF_DENY_VF ?= $(HOME)/deny-vf <<
34 <<
35 ifeq ($(findstring 1, $(KBUILD_VERBOSE)),) <<
36 SPHINXOPTS += "-q" 30 SPHINXOPTS += "-q"
37 endif 31 endif
38 32
39 # User-friendly check for sphinx-build 33 # User-friendly check for sphinx-build
40 HAVE_SPHINX := $(shell if which $(SPHINXBUILD) 34 HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
41 35
42 ifeq ($(HAVE_SPHINX),0) 36 ifeq ($(HAVE_SPHINX),0)
43 37
44 .DEFAULT: 38 .DEFAULT:
45 $(warning The '$(SPHINXBUILD)' command 39 $(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.)
46 @echo 40 @echo
47 @$(srctree)/scripts/sphinx-pre-install 41 @$(srctree)/scripts/sphinx-pre-install
48 @echo " SKIP Sphinx $@ target." 42 @echo " SKIP Sphinx $@ target."
49 43
50 else # HAVE_SPHINX 44 else # HAVE_SPHINX
51 45
52 # User-friendly check for pdflatex and latexmk 46 # User-friendly check for pdflatex and latexmk
53 HAVE_PDFLATEX := $(shell if which $(PDFLATEX) 47 HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi)
54 HAVE_LATEXMK := $(shell if which latexmk >/dev 48 HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi)
55 49
56 ifeq ($(HAVE_LATEXMK),1) 50 ifeq ($(HAVE_LATEXMK),1)
57 PDFLATEX := latexmk -$(PDFLATEX) 51 PDFLATEX := latexmk -$(PDFLATEX)
58 endif #HAVE_LATEXMK 52 endif #HAVE_LATEXMK
59 53
60 # Internal variables. 54 # Internal variables.
61 PAPEROPT_a4 = -D latex_paper_size=a4 55 PAPEROPT_a4 = -D latex_paper_size=a4
62 PAPEROPT_letter = -D latex_paper_size=letter 56 PAPEROPT_letter = -D latex_paper_size=letter
63 KERNELDOC = $(srctree)/scripts/kernel-do 57 KERNELDOC = $(srctree)/scripts/kernel-doc
64 KERNELDOC_CONF = -D kerneldoc_srctree=$(srctr 58 KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
65 ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROP 59 ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
66 ifneq ($(wildcard $(srctree)/.config),) <<
67 ifeq ($(CONFIG_RUST),y) <<
68 # Let Sphinx know we will include rust <<
69 ALLSPHINXOPTS += -t rustdoc <<
70 endif <<
71 endif <<
72 # the i18n builder cannot share the environmen 60 # the i18n builder cannot share the environment and doctrees with the others
73 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHIN 61 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
74 62
75 # commands; the 'cmd' from scripts/Kbuild.incl 63 # commands; the 'cmd' from scripts/Kbuild.include is not *loopable*
76 loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; 64 loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;
77 65
78 # $2 sphinx builder e.g. "html" 66 # $2 sphinx builder e.g. "html"
79 # $3 name of the build subfolder / e.g. "users 67 # $3 name of the build subfolder / e.g. "userspace-api/media", used as:
80 # * dest folder relative to $(BUILDDIR) and 68 # * dest folder relative to $(BUILDDIR) and
81 # * cache folder relative to $(BUILDDIR)/.d 69 # * cache folder relative to $(BUILDDIR)/.doctrees
82 # $4 dest subfolder e.g. "man" for man pages a 70 # $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man
83 # $5 reST source folder relative to $(src), !! 71 # $5 reST source folder relative to $(srctree)/$(src),
84 # e.g. "userspace-api/media" for the linux- 72 # e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
85 73
86 quiet_cmd_sphinx = SPHINX $@ --> file://$(abs 74 quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
87 cmd_sphinx = $(MAKE) BUILDDIR=$(abspath 75 cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \
88 PYTHONDONTWRITEBYTECODE=1 \ 76 PYTHONDONTWRITEBYTECODE=1 \
89 BUILDDIR=$(abspath $(BUILDDIR)) SPHINX !! 77 BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
90 $(PYTHON3) $(srctree)/scripts/jobserve 78 $(PYTHON3) $(srctree)/scripts/jobserver-exec \
91 $(CONFIG_SHELL) $(srctree)/Documentati 79 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
92 $(SPHINXBUILD) \ 80 $(SPHINXBUILD) \
93 -b $2 \ 81 -b $2 \
94 -c $(abspath $(src)) \ !! 82 -c $(abspath $(srctree)/$(src)) \
95 -d $(abspath $(BUILDDIR)/.doctrees/$3) 83 -d $(abspath $(BUILDDIR)/.doctrees/$3) \
96 -D version=$(KERNELVERSION) -D release 84 -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
97 $(ALLSPHINXOPTS) \ 85 $(ALLSPHINXOPTS) \
98 $(abspath $(src)/$5) \ !! 86 $(abspath $(srctree)/$(src)/$5) \
99 $(abspath $(BUILDDIR)/$3/$4) && \ !! 87 $(abspath $(BUILDDIR)/$3/$4)
100 if [ "x$(DOCS_CSS)" != "x" ]; then \ <<
101 cp $(if $(patsubst /%,,$(DOCS_ <<
102 fi <<
103 <<
104 YNL_INDEX:=$(srctree)/Documentation/networking <<
105 YNL_RST_DIR:=$(srctree)/Documentation/networki <<
106 YNL_YAML_DIR:=$(srctree)/Documentation/netlink <<
107 YNL_TOOL:=$(srctree)/tools/net/ynl/ynl-gen-rst <<
108 <<
109 YNL_RST_FILES_TMP := $(patsubst %.yaml,%.rst,$ <<
110 YNL_RST_FILES := $(patsubst $(YNL_YAML_DIR)%,$ <<
111 <<
112 $(YNL_INDEX): $(YNL_RST_FILES) <<
113 $(Q)$(YNL_TOOL) -o $@ -x <<
114 <<
115 $(YNL_RST_DIR)/%.rst: $(YNL_YAML_DIR)/%.yaml $ <<
116 $(Q)$(YNL_TOOL) -i $< -o $@ <<
117 <<
118 htmldocs texinfodocs latexdocs epubdocs xmldoc <<
119 88
120 htmldocs: 89 htmldocs:
121 @$(srctree)/scripts/sphinx-pre-install 90 @$(srctree)/scripts/sphinx-pre-install --version-check
122 @+$(foreach var,$(SPHINXDIRS),$(call l 91 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
123 92
124 # If Rust support is available and .config exi <<
125 # If there are any, the errors from this make <<
126 # won't stop the execution of htmldocs <<
127 <<
128 ifneq ($(wildcard $(srctree)/.config),) <<
129 ifeq ($(CONFIG_RUST),y) <<
130 $(Q)$(MAKE) rustdoc || true <<
131 endif <<
132 endif <<
133 <<
134 texinfodocs: <<
135 @$(srctree)/scripts/sphinx-pre-install <<
136 @+$(foreach var,$(SPHINXDIRS),$(call l <<
137 <<
138 # Note: the 'info' Make target is generated by <<
139 # running the texinfodocs target define above. <<
140 infodocs: texinfodocs <<
141 $(MAKE) -C $(BUILDDIR)/texinfo info <<
142 <<
143 linkcheckdocs: 93 linkcheckdocs:
144 @$(foreach var,$(SPHINXDIRS),$(call lo 94 @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
145 95
146 latexdocs: 96 latexdocs:
147 @$(srctree)/scripts/sphinx-pre-install 97 @$(srctree)/scripts/sphinx-pre-install --version-check
148 @+$(foreach var,$(SPHINXDIRS),$(call l 98 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))
149 99
150 ifeq ($(HAVE_PDFLATEX),0) 100 ifeq ($(HAVE_PDFLATEX),0)
151 101
152 pdfdocs: 102 pdfdocs:
153 $(warning The '$(PDFLATEX)' command wa 103 $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.)
154 @echo " SKIP Sphinx $@ target." 104 @echo " SKIP Sphinx $@ target."
155 105
156 else # HAVE_PDFLATEX 106 else # HAVE_PDFLATEX
157 107
158 pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CON <<
159 pdfdocs: latexdocs 108 pdfdocs: latexdocs
160 @$(srctree)/scripts/sphinx-pre-install 109 @$(srctree)/scripts/sphinx-pre-install --version-check
161 $(foreach var,$(SPHINXDIRS), \ 110 $(foreach var,$(SPHINXDIRS), \
162 $(MAKE) PDFLATEX="$(PDFLATEX)" LATE !! 111 $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \
163 mkdir -p $(BUILDDIR)/$(var)/pdf; \ 112 mkdir -p $(BUILDDIR)/$(var)/pdf; \
164 mv $(subst .tex,.pdf,$(wildcard $(B 113 mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \
165 ) 114 )
166 115
167 endif # HAVE_PDFLATEX 116 endif # HAVE_PDFLATEX
168 117
169 epubdocs: 118 epubdocs:
170 @$(srctree)/scripts/sphinx-pre-install 119 @$(srctree)/scripts/sphinx-pre-install --version-check
171 @+$(foreach var,$(SPHINXDIRS),$(call l 120 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
172 121
173 xmldocs: 122 xmldocs:
174 @$(srctree)/scripts/sphinx-pre-install 123 @$(srctree)/scripts/sphinx-pre-install --version-check
175 @+$(foreach var,$(SPHINXDIRS),$(call l 124 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
176 125
177 endif # HAVE_SPHINX 126 endif # HAVE_SPHINX
178 127
179 # The following targets are independent of HAV 128 # The following targets are independent of HAVE_SPHINX, and the rules should
180 # work or silently pass without Sphinx. 129 # work or silently pass without Sphinx.
181 130
182 refcheckdocs: 131 refcheckdocs:
183 $(Q)cd $(srctree);scripts/documentatio 132 $(Q)cd $(srctree);scripts/documentation-file-ref-check
184 133
185 cleandocs: 134 cleandocs:
186 $(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES <<
187 $(Q)rm -rf $(BUILDDIR) 135 $(Q)rm -rf $(BUILDDIR)
188 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILD 136 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
189 137
190 dochelp: 138 dochelp:
191 @echo ' Linux kernel internal documen 139 @echo ' Linux kernel internal documentation in different formats from ReST:'
192 @echo ' htmldocs - HTML' 140 @echo ' htmldocs - HTML'
193 @echo ' texinfodocs - Texinfo' <<
194 @echo ' infodocs - Info' <<
195 @echo ' latexdocs - LaTeX' 141 @echo ' latexdocs - LaTeX'
196 @echo ' pdfdocs - PDF' 142 @echo ' pdfdocs - PDF'
197 @echo ' epubdocs - EPUB' 143 @echo ' epubdocs - EPUB'
198 @echo ' xmldocs - XML' 144 @echo ' xmldocs - XML'
199 @echo ' linkcheckdocs - check for 145 @echo ' linkcheckdocs - check for broken external links'
200 @echo ' (will conn 146 @echo ' (will connect to external hosts)'
201 @echo ' refcheckdocs - check for 147 @echo ' refcheckdocs - check for references to non-existing files under'
202 @echo ' Documentat 148 @echo ' Documentation'
203 @echo ' cleandocs - clean all 149 @echo ' cleandocs - clean all generated files'
204 @echo 150 @echo
205 @echo ' make SPHINXDIRS="s1 s2" [tar 151 @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
206 @echo ' valid values for SPHINXDIRS 152 @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
207 @echo 153 @echo
208 @echo ' make SPHINX_CONF={conf-file} 154 @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
209 @echo ' configuration. This is e.g. 155 @echo ' configuration. This is e.g. useful to build with nit-picking config.'
210 @echo <<
211 @echo ' make DOCS_THEME={sphinx-them <<
212 @echo <<
213 @echo ' make DOCS_CSS={a .css file} <<
214 @echo 156 @echo
215 @echo ' Default location for the gen 157 @echo ' Default location for the generated documents is Documentation/output'
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.