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