OSCL-LXR

0001 # -*- makefile -*-
0002 # Makefile for Sphinx documentation
0003 #
0004
0005 # for cleaning
0006 subdir- := devicetree/bindings
0007
0008 # Check for broken documentation file references
0009 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
0010 $(shell $(srctree)/scripts/documentation-file-ref-check --warn)
0011 endif
0012
0013 # Check for broken ABI files
0014 ifeq ($(CONFIG_WARN_ABI_ERRORS),y)
0015 $(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI)
0016 endif
0017
0018 # You can set these variables from the command line.
0019 SPHINXBUILD   = sphinx-build
0020 SPHINXOPTS    =
0021 SPHINXDIRS    = .
0022 DOCS_THEME    =
0023 DOCS_CSS      =
0024 _SPHINXDIRS   = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
0025 SPHINX_CONF   = conf.py
0026 PAPER         =
0027 BUILDDIR      = $(obj)/output
0028 PDFLATEX      = xelatex
0029 LATEXOPTS     = -interaction=batchmode -no-shell-escape
0030
0031 ifeq ($(KBUILD_VERBOSE),0)
0032 SPHINXOPTS    += "-q"
0033 endif
0034
0035 # User-friendly check for sphinx-build
0036 HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
0037
0038 ifeq ($(HAVE_SPHINX),0)
0039
0040 .DEFAULT:
0041         $(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.)
0042         @echo
0043         @$(srctree)/scripts/sphinx-pre-install
0044         @echo "  SKIP    Sphinx $@ target."
0045
0046 else # HAVE_SPHINX
0047
0048 # User-friendly check for pdflatex and latexmk
0049 HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi)
0050 HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi)
0051
0052 ifeq ($(HAVE_LATEXMK),1)
0053         PDFLATEX := latexmk -$(PDFLATEX)
0054 endif #HAVE_LATEXMK
0055
0056 # Internal variables.
0057 PAPEROPT_a4     = -D latex_paper_size=a4
0058 PAPEROPT_letter = -D latex_paper_size=letter
0059 KERNELDOC       = $(srctree)/scripts/kernel-doc
0060 KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
0061 ALLSPHINXOPTS   =  $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
0062 # the i18n builder cannot share the environment and doctrees with the others
0063 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
0064
0065 # commands; the 'cmd' from scripts/Kbuild.include is not *loopable*
0066 loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;
0067
0068 # $2 sphinx builder e.g. "html"
0069 # $3 name of the build subfolder / e.g. "userspace-api/media", used as:
0070 #    * dest folder relative to $(BUILDDIR) and
0071 #    * cache folder relative to $(BUILDDIR)/.doctrees
0072 # $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man
0073 # $5 reST source folder relative to $(srctree)/$(src),
0074 #    e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
0075
0076 quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
0077       cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \
0078         PYTHONDONTWRITEBYTECODE=1 \
0079         BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
0080         $(PYTHON3) $(srctree)/scripts/jobserver-exec \
0081         $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
0082         $(SPHINXBUILD) \
0083         -b $2 \
0084         -c $(abspath $(srctree)/$(src)) \
0085         -d $(abspath $(BUILDDIR)/.doctrees/$3) \
0086         -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
0087         $(ALLSPHINXOPTS) \
0088         $(abspath $(srctree)/$(src)/$5) \
0089         $(abspath $(BUILDDIR)/$3/$4) && \
0090         if [ "x$(DOCS_CSS)" != "x" ]; then \
0091                 cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \
0092         fi
0093
0094 htmldocs:
0095         @$(srctree)/scripts/sphinx-pre-install --version-check
0096         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
0097
0098 linkcheckdocs:
0099         @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
0100
0101 latexdocs:
0102         @$(srctree)/scripts/sphinx-pre-install --version-check
0103         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))
0104
0105 ifeq ($(HAVE_PDFLATEX),0)
0106
0107 pdfdocs:
0108         $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.)
0109         @echo "  SKIP    Sphinx $@ target."
0110
0111 else # HAVE_PDFLATEX
0112
0113 pdfdocs: latexdocs
0114         @$(srctree)/scripts/sphinx-pre-install --version-check
0115         $(foreach var,$(SPHINXDIRS), \
0116            $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \
0117            mkdir -p $(BUILDDIR)/$(var)/pdf; \
0118            mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \
0119         )
0120
0121 endif # HAVE_PDFLATEX
0122
0123 epubdocs:
0124         @$(srctree)/scripts/sphinx-pre-install --version-check
0125         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
0126
0127 xmldocs:
0128         @$(srctree)/scripts/sphinx-pre-install --version-check
0129         @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
0130
0131 endif # HAVE_SPHINX
0132
0133 # The following targets are independent of HAVE_SPHINX, and the rules should
0134 # work or silently pass without Sphinx.
0135
0136 refcheckdocs:
0137         $(Q)cd $(srctree);scripts/documentation-file-ref-check
0138
0139 cleandocs:
0140         $(Q)rm -rf $(BUILDDIR)
0141         $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
0142
0143 dochelp:
0144         @echo  ' Linux kernel internal documentation in different formats from ReST:'
0145         @echo  '  htmldocs        - HTML'
0146         @echo  '  latexdocs       - LaTeX'
0147         @echo  '  pdfdocs         - PDF'
0148         @echo  '  epubdocs        - EPUB'
0149         @echo  '  xmldocs         - XML'
0150         @echo  '  linkcheckdocs   - check for broken external links'
0151         @echo  '                    (will connect to external hosts)'
0152         @echo  '  refcheckdocs    - check for references to non-existing files under'
0153         @echo  '                    Documentation'
0154         @echo  '  cleandocs       - clean all generated files'
0155         @echo
0156         @echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
0157         @echo  '  valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
0158         @echo
0159         @echo  '  make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
0160         @echo  '  configuration. This is e.g. useful to build with nit-picking config.'
0161         @echo
0162         @echo  '  make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
0163         @echo
0164         @echo  '  make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
0165         @echo
0166         @echo  '  Default location for the generated documents is Documentation/output'