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