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