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