~ [ 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-2.6.0)


  1 # -*- makefile -*-                                
  2 # Makefile for Sphinx documentation               
  3 #                                                 
  4                                                   
  5 # for cleaning                                    
  6 subdir- := devicetree/bindings                    
  7                                                   
  8 # Check for broken documentation file referenc    
  9 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)         
 10 $(shell $(srctree)/scripts/documentation-file-    
 11 endif                                             
 12                                                   
 13 # Check for broken ABI files                      
 14 ifeq ($(CONFIG_WARN_ABI_ERRORS),y)                
 15 $(shell $(srctree)/scripts/get_abi.pl validate    
 16 endif                                             
 17                                                   
 18 # You can set these variables from the command    
 19 SPHINXBUILD   = sphinx-build                      
 20 SPHINXOPTS    =                                   
 21 SPHINXDIRS    = .                                 
 22 DOCS_THEME    =                                   
 23 DOCS_CSS      =                                   
 24 _SPHINXDIRS   = $(sort $(patsubst $(srctree)/D    
 25 SPHINX_CONF   = conf.py                           
 26 PAPER         =                                   
 27 BUILDDIR      = $(obj)/output                     
 28 PDFLATEX      = xelatex                           
 29 LATEXOPTS     = -interaction=batchmode -no-she    
 30                                                   
 31 # For denylisting "variable font" files           
 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"                             
 37 endif                                             
 38                                                   
 39 # User-friendly check for sphinx-build            
 40 HAVE_SPHINX := $(shell if which $(SPHINXBUILD)    
 41                                                   
 42 ifeq ($(HAVE_SPHINX),0)                           
 43                                                   
 44 .DEFAULT:                                         
 45         $(warning The '$(SPHINXBUILD)' command    
 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)     
 54 HAVE_LATEXMK := $(shell if which latexmk >/dev    
 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 KERNELDOC       = $(srctree)/scripts/kernel-do    
 64 KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctr    
 65 ALLSPHINXOPTS   =  $(KERNELDOC_CONF) $(PAPEROP    
 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    
 73 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHIN    
 74                                                   
 75 # commands; the 'cmd' from scripts/Kbuild.incl    
 76 loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;       
 77                                                   
 78 # $2 sphinx builder e.g. "html"                   
 79 # $3 name of the build subfolder / e.g. "users    
 80 #    * dest folder relative to $(BUILDDIR) and    
 81 #    * cache folder relative to $(BUILDDIR)/.d    
 82 # $4 dest subfolder e.g. "man" for man pages a    
 83 # $5 reST source folder relative to $(src),       
 84 #    e.g. "userspace-api/media" for the linux-    
 85                                                   
 86 quiet_cmd_sphinx = SPHINX  $@ --> file://$(abs    
 87       cmd_sphinx = $(MAKE) BUILDDIR=$(abspath     
 88         PYTHONDONTWRITEBYTECODE=1 \               
 89         BUILDDIR=$(abspath $(BUILDDIR)) SPHINX    
 90         $(PYTHON3) $(srctree)/scripts/jobserve    
 91         $(CONFIG_SHELL) $(srctree)/Documentati    
 92         $(SPHINXBUILD) \                          
 93         -b $2 \                                   
 94         -c $(abspath $(src)) \                    
 95         -d $(abspath $(BUILDDIR)/.doctrees/$3)    
 96         -D version=$(KERNELVERSION) -D release    
 97         $(ALLSPHINXOPTS) \                        
 98         $(abspath $(src)/$5) \                    
 99         $(abspath $(BUILDDIR)/$3/$4) && \         
100         if [ "x$(DOCS_CSS)" != "x" ]; then \      
101                 cp $(if $(patsubst /%,,$(DOCS_    
102         fi                                        
103                                                   
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:                                         
121         @$(srctree)/scripts/sphinx-pre-install    
122         @+$(foreach var,$(SPHINXDIRS),$(call l    
123                                                   
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:                                    
144         @$(foreach var,$(SPHINXDIRS),$(call lo    
145                                                   
146 latexdocs:                                        
147         @$(srctree)/scripts/sphinx-pre-install    
148         @+$(foreach var,$(SPHINXDIRS),$(call l    
149                                                   
150 ifeq ($(HAVE_PDFLATEX),0)                         
151                                                   
152 pdfdocs:                                          
153         $(warning The '$(PDFLATEX)' command wa    
154         @echo "  SKIP    Sphinx $@ target."       
155                                                   
156 else # HAVE_PDFLATEX                              
157                                                   
158 pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CON    
159 pdfdocs: latexdocs                                
160         @$(srctree)/scripts/sphinx-pre-install    
161         $(foreach var,$(SPHINXDIRS), \            
162            $(MAKE) PDFLATEX="$(PDFLATEX)" LATE    
163            mkdir -p $(BUILDDIR)/$(var)/pdf; \     
164            mv $(subst .tex,.pdf,$(wildcard $(B    
165         )                                         
166                                                   
167 endif # HAVE_PDFLATEX                             
168                                                   
169 epubdocs:                                         
170         @$(srctree)/scripts/sphinx-pre-install    
171         @+$(foreach var,$(SPHINXDIRS),$(call l    
172                                                   
173 xmldocs:                                          
174         @$(srctree)/scripts/sphinx-pre-install    
175         @+$(foreach var,$(SPHINXDIRS),$(call l    
176                                                   
177 endif # HAVE_SPHINX                               
178                                                   
179 # The following targets are independent of HAV    
180 # work or silently pass without Sphinx.           
181                                                   
182 refcheckdocs:                                     
183         $(Q)cd $(srctree);scripts/documentatio    
184                                                   
185 cleandocs:                                        
186         $(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES    
187         $(Q)rm -rf $(BUILDDIR)                    
188         $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILD    
189                                                   
190 dochelp:                                          
191         @echo  ' Linux kernel internal documen    
192         @echo  '  htmldocs        - HTML'         
193         @echo  '  texinfodocs     - Texinfo'      
194         @echo  '  infodocs        - Info'         
195         @echo  '  latexdocs       - LaTeX'        
196         @echo  '  pdfdocs         - PDF'          
197         @echo  '  epubdocs        - EPUB'         
198         @echo  '  xmldocs         - XML'          
199         @echo  '  linkcheckdocs   - check for     
200         @echo  '                    (will conn    
201         @echo  '  refcheckdocs    - check for     
202         @echo  '                    Documentat    
203         @echo  '  cleandocs       - clean all     
204         @echo                                     
205         @echo  '  make SPHINXDIRS="s1 s2" [tar    
206         @echo  '  valid values for SPHINXDIRS     
207         @echo                                     
208         @echo  '  make SPHINX_CONF={conf-file}    
209         @echo  '  configuration. This is e.g.     
210         @echo                                     
211         @echo  '  make DOCS_THEME={sphinx-them    
212         @echo                                     
213         @echo  '  make DOCS_CSS={a .css file}     
214         @echo                                     
215         @echo  '  Default location for the gen    
                                                      

~ [ 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