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