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