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 mcabook.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.xml drm.xml
  18
  19 ###
  20 # The build process is as follows (targets):
  21 #              (xmldocs) [by docproc]
  22 # file.tmpl --> file.xml +--> file.ps   (psdocs)   [by db2ps or xmlto]
  23 #                        +--> file.pdf  (pdfdocs)  [by db2pdf or xmlto]
  24 #                        +--> DIR=file  (htmldocs) [by xmlto]
  25 #                        +--> man/      (mandocs)  [by xmlto]
  26
  27
  28 # for PDF and PS output you can choose between xmlto and docbook-utils tools
  29 PDF_METHOD      = $(prefer-db2x)
  30 PS_METHOD       = $(prefer-db2x)
  31
  32
  33 ###
  34 # The targets that may be used.
  35 PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs xmldoclinks
  36
  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) xmldoclinks
  49         $(call build_main_index)
  50         $(call build_images)
  51
  52 MAN := $(patsubst %.xml, %.9, $(BOOKS))
  53 mandocs: $(MAN)
  54
  55 build_images = mkdir -p $(objtree)/Documentation/DocBook/media/ && \
  56                cp $(srctree)/Documentation/DocBook/dvb/*.png \
  57                   $(srctree)/Documentation/DocBook/v4l/*.gif \
  58                   $(srctree)/Documentation/DocBook/v4l/*.png \
  59                   $(objtree)/Documentation/DocBook/media/
  60
  61 xmldoclinks:
  62 ifneq ($(objtree),$(srctree))
  63         for dep in dvb media-entities.tmpl media-indices.tmpl v4l; do \
  64                 rm -f $(objtree)/Documentation/DocBook/$$dep \
  65                 && ln -s $(srctree)/Documentation/DocBook/$$dep $(objtree)/Documentation/DocBook/ \
  66                 || exit; \
  67         done
  68 endif
  69
  70 installmandocs: mandocs
  71         mkdir -p /usr/local/man/man9/
  72         install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
  73
  74 ###
  75 #External programs used
  76 KERNELDOC = $(srctree)/scripts/kernel-doc
  77 DOCPROC   = $(objtree)/scripts/basic/docproc
  78
  79 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
  80 XMLTOFLAGS += --skip-validation
  81
  82 ###
  83 # DOCPROC is used for two purposes:
  84 # 1) To generate a dependency list for a .tmpl file
  85 # 2) To preprocess a .tmpl file and call kernel-doc with
  86 #     appropriate parameters.
  87 # The following rules are used to generate the .xml documentation
  88 # required to generate the final targets. (ps, pdf, html).
  89 quiet_cmd_docproc = DOCPROC $@
  90       cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
  91 define rule_docproc
  92         set -e;                                                         \
  93         $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';)         \
  94         $(cmd_$(1));                                                    \
  95         (                                                               \
  96           echo 'cmd_$@ := $(cmd_$(1))';                                 \
  97           echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`;           \
  98         ) > $(dir $@).$(notdir $@).cmd
  99 endef
 100
 101 %.xml: %.tmpl xmldoclinks FORCE
 102         $(call if_changed_rule,docproc)
 103
 104 ###
 105 #Read in all saved dependency files
 106 cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
 107
 108 ifneq ($(cmd_files),)
 109   include $(cmd_files)
 110 endif
 111
 112 ###
 113 # Changes in kernel-doc force a rebuild of all documentation
 114 $(BOOKS): $(KERNELDOC)
 115
 116 # Tell kbuild to always build the programs
 117 always := $(hostprogs-y)
 118
 119 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
 120                    exit 1
 121 db2xtemplate = db2TYPE -o $(dir $@) $<
 122 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
 123
 124 # determine which methods are available
 125 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
 126         use-db2x = db2x
 127         prefer-db2x = db2x
 128 else
 129         use-db2x = notfound
 130         prefer-db2x = $(use-xmlto)
 131 endif
 132 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
 133         use-xmlto = xmlto
 134         prefer-xmlto = xmlto
 135 else
 136         use-xmlto = notfound
 137         prefer-xmlto = $(use-db2x)
 138 endif
 139
 140 # the commands, generated from the chosen template
 141 quiet_cmd_db2ps = PS      $@
 142       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
 143 %.ps : %.xml
 144         $(call cmd,db2ps)
 145
 146 quiet_cmd_db2pdf = PDF     $@
 147       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
 148 %.pdf : %.xml
 149         $(call cmd,db2pdf)
 150
 151
 152 index = index.html
 153 main_idx = Documentation/DocBook/$(index)
 154 build_main_index = rm -rf $(main_idx) && \
 155                    echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
 156                    echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
 157                    cat $(HTML) >> $(main_idx)
 158
 159 quiet_cmd_db2html = HTML    $@
 160       cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
 161                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
 162         $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
 163
 164 %.html: %.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 $< ; gzip -f $(obj)/man/*.9; 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
 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
 230 ###
 231 # Temporary files left by various tools
 232 clean-files := $(DOCBOOKS) \
 233         $(patsubst %.xml, %.dvi,  $(DOCBOOKS)) \
 234         $(patsubst %.xml, %.aux,  $(DOCBOOKS)) \
 235         $(patsubst %.xml, %.tex,  $(DOCBOOKS)) \
 236         $(patsubst %.xml, %.log,  $(DOCBOOKS)) \
 237         $(patsubst %.xml, %.out,  $(DOCBOOKS)) \
 238         $(patsubst %.xml, %.ps,   $(DOCBOOKS)) \
 239         $(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \
 240         $(patsubst %.xml, %.html, $(DOCBOOKS)) \
 241         $(patsubst %.xml, %.9,    $(DOCBOOKS)) \
 242         $(index)
 243
 244 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 245
 246 cleandocs:
 247         $(Q)rm -f $(call objectify, $(clean-files))
 248         $(Q)rm -rf $(call objectify, $(clean-dirs))
 249
 250 # Declare the contents of the .PHONY variable as phony.  We keep that
 251 # information in a variable se we can use it in if_changed and friends.
 252
 253 .PHONY: $(PHONY)