Documentation/DocBook/Makefile

   1 ###
   2 # This makefile is used to generate the kernel documentation,
   3 # primarily based on in-line comments in various source files.
   4 # See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how
   5 # to document the SRC - and how to read it.
   6 # To add a new book the only step required is to add the book to the
   7 # list of DOCBOOKS.
   8
   9 DOCBOOKS := z8530book.xml  \
  10             kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
  11             writing_usb_driver.xml networking.xml \
  12             kernel-api.xml filesystems.xml lsm.xml kgdb.xml \
  13             gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
  14             genericirq.xml s390-drivers.xml scsi.xml \
  15             sh.xml regulator.xml w1.xml \
  16             writing_musb_glue_layer.xml
  17
  18 ifeq ($(DOCBOOKS),)
  19
  20 # Skip DocBook build if the user explicitly requested no DOCBOOKS.
  21 .DEFAULT:
  22         @echo "  SKIP    DocBook $@ target (DOCBOOKS=\"\" specified)."
  23 else
  24 ifneq ($(SPHINXDIRS),)
  25
  26 # Skip DocBook build if the user explicitly requested a sphinx dir
  27 .DEFAULT:
  28         @echo "  SKIP    DocBook $@ target (SPHINXDIRS specified)."
  29 else
  30
  31
  32 ###
  33 # The build process is as follows (targets):
  34 #              (xmldocs) [by docproc]
  35 # file.tmpl --> file.xml +--> file.ps   (psdocs)   [by db2ps or xmlto]
  36 #                        +--> file.pdf  (pdfdocs)  [by db2pdf or xmlto]
  37 #                        +--> DIR=file  (htmldocs) [by xmlto]
  38 #                        +--> man/      (mandocs)  [by xmlto]
  39
  40
  41 # for PDF and PS output you can choose between xmlto and docbook-utils tools
  42 PDF_METHOD      = $(prefer-db2x)
  43 PS_METHOD       = $(prefer-db2x)
  44
  45
  46 targets += $(DOCBOOKS)
  47 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
  48 xmldocs: $(BOOKS)
  49 sgmldocs: xmldocs
  50
  51 PS := $(patsubst %.xml, %.ps, $(BOOKS))
  52 psdocs: $(PS)
  53
  54 PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
  55 pdfdocs: $(PDF)
  56
  57 HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
  58 htmldocs: $(HTML)
  59         $(call cmd,build_main_index)
  60
  61 MAN := $(patsubst %.xml, %.9, $(BOOKS))
  62 mandocs: $(MAN)
  63         find $(obj)/man -name '*.9' | xargs gzip -nf
  64
  65 installmandocs: mandocs
  66         mkdir -p /usr/local/man/man9/
  67         find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \
  68                 sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \
  69                 xargs install -m 644 -t /usr/local/man/man9/
  70
  71 # no-op for the DocBook toolchain
  72 epubdocs:
  73 latexdocs:
  74 linkcheckdocs:
  75
  76 ###
  77 #External programs used
  78 KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
  79 KERNELDOC       = $(srctree)/scripts/kernel-doc
  80 DOCPROC         = $(objtree)/scripts/docproc
  81 CHECK_LC_CTYPE = $(objtree)/scripts/check-lc_ctype
  82
  83 # Use a fixed encoding - UTF-8 if the C library has support built-in
  84 # or ASCII if not
  85 LC_CTYPE := $(call try-run, LC_CTYPE=C.UTF-8 $(CHECK_LC_CTYPE),C.UTF-8,C)
  86 export LC_CTYPE
  87
  88 XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
  89 XMLTOFLAGS += --skip-validation
  90
  91 ###
  92 # DOCPROC is used for two purposes:
  93 # 1) To generate a dependency list for a .tmpl file
  94 # 2) To preprocess a .tmpl file and call kernel-doc with
  95 #     appropriate parameters.
  96 # The following rules are used to generate the .xml documentation
  97 # required to generate the final targets. (ps, pdf, html).
  98 quiet_cmd_docproc = DOCPROC $@
  99       cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
 100 define rule_docproc
 101         set -e;                                                         \
 102         $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';)         \
 103         $(cmd_$(1));                                                    \
 104         (                                                               \
 105           echo 'cmd_$@ := $(cmd_$(1))';                                 \
 106           echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`;           \
 107         ) > $(dir $@).$(notdir $@).cmd
 108 endef
 109
 110 %.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE
 111         $(call if_changed_rule,docproc)
 112
 113 # Tell kbuild to always build the programs
 114 always := $(hostprogs-y)
 115
 116 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
 117                    exit 1
 118 db2xtemplate = db2TYPE -o $(dir $@) $<
 119 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
 120
 121 # determine which methods are available
 122 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
 123         use-db2x = db2x
 124         prefer-db2x = db2x
 125 else
 126         use-db2x = notfound
 127         prefer-db2x = $(use-xmlto)
 128 endif
 129 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
 130         use-xmlto = xmlto
 131         prefer-xmlto = xmlto
 132 else
 133         use-xmlto = notfound
 134         prefer-xmlto = $(use-db2x)
 135 endif
 136
 137 # the commands, generated from the chosen template
 138 quiet_cmd_db2ps = PS      $@
 139       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
 140 %.ps : %.xml
 141         $(call cmd,db2ps)
 142
 143 quiet_cmd_db2pdf = PDF     $@
 144       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
 145 %.pdf : %.xml
 146         $(call cmd,db2pdf)
 147
 148
 149 index = index.html
 150 main_idx = $(obj)/$(index)
 151 quiet_cmd_build_main_index = HTML    $(main_idx)
 152       cmd_build_main_index = rm -rf $(main_idx); \
 153                    echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
 154                    echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
 155                    cat $(HTML) >> $(main_idx)
 156
 157 quiet_cmd_db2html = HTML    $@
 158       cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
 159                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
 160                 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
 161
 162 ###
 163 # Rules to create an aux XML and .db, and use them to re-process the DocBook XML
 164 # to fill internal hyperlinks
 165        gen_aux_xml = :
 166  quiet_gen_aux_xml = echo '  XMLREF  $@'
 167 silent_gen_aux_xml = :
 168 %.aux.xml: %.xml
 169         @$($(quiet)gen_aux_xml)
 170         @rm -rf $@
 171         @(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db)
 172         @$(KERNELDOCXMLREF) -db $<.db $< > $@
 173 .PRECIOUS: %.aux.xml
 174
 175 %.html: %.aux.xml
 176         @(which xmlto > /dev/null 2>&1) || \
 177          (echo "*** You need to install xmlto ***"; \
 178           exit 1)
 179         @rm -rf $@ $(patsubst %.html,%,$@)
 180         $(call cmd,db2html)
 181         @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
 182             cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
 183
 184 quiet_cmd_db2man = MAN     $@
 185       cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
 186 %.9 : %.xml
 187         @(which xmlto > /dev/null 2>&1) || \
 188          (echo "*** You need to install xmlto ***"; \
 189           exit 1)
 190         $(Q)mkdir -p $(obj)/man/$(*F)
 191         $(call cmd,db2man)
 192         @touch $@
 193
 194 ###
 195 # Rules to generate postscripts and PNG images from .fig format files
 196 quiet_cmd_fig2eps = FIG2EPS $@
 197       cmd_fig2eps = fig2dev -Leps $< $@
 198
 199 %.eps: %.fig
 200         @(which fig2dev > /dev/null 2>&1) || \
 201          (echo "*** You need to install transfig ***"; \
 202           exit 1)
 203         $(call cmd,fig2eps)
 204
 205 quiet_cmd_fig2png = FIG2PNG $@
 206       cmd_fig2png = fig2dev -Lpng $< $@
 207
 208 %.png: %.fig
 209         @(which fig2dev > /dev/null 2>&1) || \
 210          (echo "*** You need to install transfig ***"; \
 211           exit 1)
 212         $(call cmd,fig2png)
 213
 214 ###
 215 # Rule to convert a .c file to inline XML documentation
 216        gen_xml = :
 217  quiet_gen_xml = echo '  GEN     $@'
 218 silent_gen_xml = :
 219 %.xml: %.c
 220         @$($(quiet)gen_xml)
 221         @(                            \
 222            echo "<programlisting>";   \
 223            expand --tabs=8 < $< |     \
 224            sed -e "s/&/\\&amp;/g"     \
 225                -e "s/</\\&lt;/g"      \
 226                -e "s/>/\\&gt;/g";     \
 227            echo "</programlisting>")  > $@
 228
 229 endif # DOCBOOKS=""
 230 endif # SPHINDIR=...
 231
 232 ###
 233 # Help targets as used by the top-level makefile
 234 dochelp:
 235         @echo  ' Linux kernel internal documentation in different formats (DocBook):'
 236         @echo  '  htmldocs        - HTML'
 237         @echo  '  pdfdocs         - PDF'
 238         @echo  '  psdocs          - Postscript'
 239         @echo  '  xmldocs         - XML DocBook'
 240         @echo  '  mandocs         - man pages'
 241         @echo  '  installmandocs  - install man pages generated by mandocs'
 242         @echo  '  cleandocs       - clean all generated DocBook files'
 243         @echo
 244         @echo  '  make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
 245         @echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'
 246         @echo
 247         @echo  "  make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
 248         @echo  '     This is useful to generate only the ReST docs (Sphinx)'
 249
 250
 251 ###
 252 # Temporary files left by various tools
 253 clean-files := $(DOCBOOKS) \
 254         $(patsubst %.xml, %.dvi,     $(DOCBOOKS)) \
 255         $(patsubst %.xml, %.aux,     $(DOCBOOKS)) \
 256         $(patsubst %.xml, %.tex,     $(DOCBOOKS)) \
 257         $(patsubst %.xml, %.log,     $(DOCBOOKS)) \
 258         $(patsubst %.xml, %.out,     $(DOCBOOKS)) \
 259         $(patsubst %.xml, %.ps,      $(DOCBOOKS)) \
 260         $(patsubst %.xml, %.pdf,     $(DOCBOOKS)) \
 261         $(patsubst %.xml, %.html,    $(DOCBOOKS)) \
 262         $(patsubst %.xml, %.9,       $(DOCBOOKS)) \
 263         $(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
 264         $(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
 265         $(patsubst %.xml, %.xml,     $(DOCBOOKS)) \
 266         $(patsubst %.xml, .%.xml.cmd, $(DOCBOOKS)) \
 267         $(index)
 268
 269 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 270
 271 cleandocs:
 272         $(Q)rm -f $(call objectify, $(clean-files))
 273         $(Q)rm -rf $(call objectify, $(clean-dirs))
 274
 275 # Declare the contents of the .PHONY variable as phony.  We keep that
 276 # information in a variable so we can use it in if_changed and friends.
 277
 278 .PHONY: $(PHONY)