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