~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/Makefile

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /Documentation/Makefile (Version linux-6.12-rc7) and /Documentation/Makefile (Version linux-6.0.19)


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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php