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