Merge tag 'for-5.18/block-2022-04-01' of git://git.kernel.dk/linux-block
[platform/kernel/linux-starfive.git] / Documentation / Makefile
1 # -*- makefile -*-
2 # Makefile for Sphinx documentation
3 #
4
5 # for cleaning
6 subdir- := devicetree/bindings
7
8 # Check for broken documentation file references
9 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
10 $(shell $(srctree)/scripts/documentation-file-ref-check --warn)
11 endif
12
13 # Check for broken ABI files
14 ifeq ($(CONFIG_WARN_ABI_ERRORS),y)
15 $(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI)
16 endif
17
18 # You can set these variables from the command line.
19 SPHINXBUILD   = sphinx-build
20 SPHINXOPTS    =
21 SPHINXDIRS    = .
22 DOCS_THEME    =
23 DOCS_CSS      =
24 _SPHINXDIRS   = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
25 SPHINX_CONF   = conf.py
26 PAPER         =
27 BUILDDIR      = $(obj)/output
28 PDFLATEX      = xelatex
29 LATEXOPTS     = -interaction=batchmode -no-shell-escape
30
31 ifeq ($(KBUILD_VERBOSE),0)
32 SPHINXOPTS    += "-q"
33 endif
34
35 # User-friendly check for sphinx-build
36 HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
37
38 ifeq ($(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
46 else # HAVE_SPHINX
47
48 # User-friendly check for pdflatex and latexmk
49 HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi)
50 HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi)
51
52 ifeq ($(HAVE_LATEXMK),1)
53         PDFLATEX := latexmk -$(PDFLATEX)
54 endif #HAVE_LATEXMK
55
56 # Internal variables.
57 PAPEROPT_a4     = -D latex_paper_size=a4
58 PAPEROPT_letter = -D latex_paper_size=letter
59 KERNELDOC       = $(srctree)/scripts/kernel-doc
60 KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
61 ALLSPHINXOPTS   =  $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
62 # the i18n builder cannot share the environment and doctrees with the others
63 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
64
65 # commands; the 'cmd' from scripts/Kbuild.include is not *loopable*
66 loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;
67
68 # $2 sphinx builder e.g. "html"
69 # $3 name of the build subfolder / e.g. "userspace-api/media", used as:
70 #    * dest folder relative to $(BUILDDIR) and
71 #    * cache folder relative to $(BUILDDIR)/.doctrees
72 # $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man
73 # $5 reST source folder relative to $(srctree)/$(src),
74 #    e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
75
76 quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
77       cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \
78         PYTHONDONTWRITEBYTECODE=1 \
79         BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
80         $(PYTHON3) $(srctree)/scripts/jobserver-exec \
81         $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
82         $(SPHINXBUILD) \
83         -b $2 \
84         -c $(abspath $(srctree)/$(src)) \
85         -d $(abspath $(BUILDDIR)/.doctrees/$3) \
86         -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
87         $(ALLSPHINXOPTS) \
88         $(abspath $(srctree)/$(src)/$5) \
89         $(abspath $(BUILDDIR)/$3/$4) && \
90         if [ "x$(DOCS_CSS)" != "x" ]; then \
91                 cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \
92         fi
93
94 htmldocs:
95         @$(srctree)/scripts/sphinx-pre-install --version-check
96         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
97
98 linkcheckdocs:
99         @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
100
101 latexdocs:
102         @$(srctree)/scripts/sphinx-pre-install --version-check
103         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))
104
105 ifeq ($(HAVE_PDFLATEX),0)
106
107 pdfdocs:
108         $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.)
109         @echo "  SKIP    Sphinx $@ target."
110
111 else # HAVE_PDFLATEX
112
113 pdfdocs: latexdocs
114         @$(srctree)/scripts/sphinx-pre-install --version-check
115         $(foreach var,$(SPHINXDIRS), \
116            $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \
117            mkdir -p $(BUILDDIR)/$(var)/pdf; \
118            mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \
119         )
120
121 endif # HAVE_PDFLATEX
122
123 epubdocs:
124         @$(srctree)/scripts/sphinx-pre-install --version-check
125         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
126
127 xmldocs:
128         @$(srctree)/scripts/sphinx-pre-install --version-check
129         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
130
131 endif # HAVE_SPHINX
132
133 # The following targets are independent of HAVE_SPHINX, and the rules should
134 # work or silently pass without Sphinx.
135
136 refcheckdocs:
137         $(Q)cd $(srctree);scripts/documentation-file-ref-check
138
139 cleandocs:
140         $(Q)rm -rf $(BUILDDIR)
141         $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
142
143 dochelp:
144         @echo  ' Linux kernel internal documentation in different formats from ReST:'
145         @echo  '  htmldocs        - HTML'
146         @echo  '  latexdocs       - LaTeX'
147         @echo  '  pdfdocs         - PDF'
148         @echo  '  epubdocs        - EPUB'
149         @echo  '  xmldocs         - XML'
150         @echo  '  linkcheckdocs   - check for broken external links'
151         @echo  '                    (will connect to external hosts)'
152         @echo  '  refcheckdocs    - check for references to non-existing files under'
153         @echo  '                    Documentation'
154         @echo  '  cleandocs       - clean all generated files'
155         @echo
156         @echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
157         @echo  '  valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
158         @echo
159         @echo  '  make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
160         @echo  '  configuration. This is e.g. useful to build with nit-picking config.'
161         @echo
162         @echo  '  make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
163         @echo
164         @echo  '  make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
165         @echo
166         @echo  '  Default location for the generated documents is Documentation/output'