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             procfs-guide.xml 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             mac80211.xml debugobjects.xml sh.xml regulator.xml \
  16             alsa-driver-api.xml writing-an-alsa-driver.xml \
  17             tracepoint.xml media.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) xmldoclinks
  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 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 $(srctree)/Documentation/DocBook/v4l/*.gif $(objtree)/Documentation/DocBook/media/
  57
  58 xmldoclinks:
  59 ifneq ($(objtree),$(srctree))
  60         for dep in dvb media-entities.tmpl media-indices.tmpl v4l; do \
  61                 rm -f $(objtree)/Documentation/DocBook/$$dep \
  62                 && ln -s $(srctree)/Documentation/DocBook/$$dep $(objtree)/Documentation/DocBook/ \
  63                 || exit; \
  64         done
  65 endif
  66
  67 installmandocs: mandocs
  68         mkdir -p /usr/local/man/man9/
  69         install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
  70
  71 ###
  72 #External programs used
  73 KERNELDOC = $(srctree)/scripts/kernel-doc
  74 DOCPROC   = $(objtree)/scripts/basic/docproc
  75
  76 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/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 FORCE
  99         $(call if_changed_rule,docproc)
 100
 101 ###
 102 #Read in all saved dependency files
 103 cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
 104
 105 ifneq ($(cmd_files),)
 106   include $(cmd_files)
 107 endif
 108
 109 ###
 110 # Changes in kernel-doc force a rebuild of all documentation
 111 $(BOOKS): $(KERNELDOC)
 112
 113 ###
 114 # procfs guide uses a .c file as example code.
 115 # This requires an explicit dependency
 116 C-procfs-example = procfs_example.xml
 117 C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
 118 $(obj)/procfs-guide.xml: $(C-procfs-example2)
 119
 120 # List of programs to build
 121 ##oops, this is a kernel module::hostprogs-y := procfs_example
 122 obj-m += procfs_example.o
 123
 124 # Tell kbuild to always build the programs
 125 always := $(hostprogs-y)
 126
 127 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
 128                    exit 1
 129 db2xtemplate = db2TYPE -o $(dir $@) $<
 130 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
 131
 132 # determine which methods are available
 133 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
 134         use-db2x = db2x
 135         prefer-db2x = db2x
 136 else
 137         use-db2x = notfound
 138         prefer-db2x = $(use-xmlto)
 139 endif
 140 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
 141         use-xmlto = xmlto
 142         prefer-xmlto = xmlto
 143 else
 144         use-xmlto = notfound
 145         prefer-xmlto = $(use-db2x)
 146 endif
 147
 148 # the commands, generated from the chosen template
 149 quiet_cmd_db2ps = PS      $@
 150       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
 151 %.ps : %.xml
 152         $(call cmd,db2ps)
 153
 154 quiet_cmd_db2pdf = PDF     $@
 155       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
 156 %.pdf : %.xml
 157         $(call cmd,db2pdf)
 158
 159
 160 index = index.html
 161 main_idx = Documentation/DocBook/$(index)
 162 build_main_index = rm -rf $(main_idx) && \
 163                    echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
 164                    echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
 165                    cat $(HTML) >> $(main_idx)
 166
 167 quiet_cmd_db2html = HTML    $@
 168       cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
 169                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
 170         $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
 171
 172 %.html: %.xml
 173         @(which xmlto > /dev/null 2>&1) || \
 174          (echo "*** You need to install xmlto ***"; \
 175           exit 1)
 176         @rm -rf $@ $(patsubst %.html,%,$@)
 177         $(call cmd,db2html)
 178         @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
 179             cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
 180
 181 quiet_cmd_db2man = MAN     $@
 182       cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
 183 %.9 : %.xml
 184         @(which xmlto > /dev/null 2>&1) || \
 185          (echo "*** You need to install xmlto ***"; \
 186           exit 1)
 187         $(Q)mkdir -p $(obj)/man
 188         $(call cmd,db2man)
 189         @touch $@
 190
 191 ###
 192 # Rules to generate postscripts and PNG images from .fig format files
 193 quiet_cmd_fig2eps = FIG2EPS $@
 194       cmd_fig2eps = fig2dev -Leps $< $@
 195
 196 %.eps: %.fig
 197         @(which fig2dev > /dev/null 2>&1) || \
 198          (echo "*** You need to install transfig ***"; \
 199           exit 1)
 200         $(call cmd,fig2eps)
 201
 202 quiet_cmd_fig2png = FIG2PNG $@
 203       cmd_fig2png = fig2dev -Lpng $< $@
 204
 205 %.png: %.fig
 206         @(which fig2dev > /dev/null 2>&1) || \
 207          (echo "*** You need to install transfig ***"; \
 208           exit 1)
 209         $(call cmd,fig2png)
 210
 211 ###
 212 # Rule to convert a .c file to inline XML documentation
 213        gen_xml = :
 214  quiet_gen_xml = echo '  GEN     $@'
 215 silent_gen_xml = :
 216 %.xml: %.c
 217         @$($(quiet)gen_xml)
 218         @(                            \
 219            echo "<programlisting>";   \
 220            expand --tabs=8 < $< |     \
 221            sed -e "s/&/\\&amp;/g"     \
 222                -e "s/</\\&lt;/g"      \
 223                -e "s/>/\\&gt;/g";     \
 224            echo "</programlisting>")  > $@
 225
 226 ###
 227 # Help targets as used by the top-level makefile
 228 dochelp:
 229         @echo  ' Linux kernel internal documentation in different formats:'
 230         @echo  '  htmldocs        - HTML'
 231         @echo  '  pdfdocs         - PDF'
 232         @echo  '  psdocs          - Postscript'
 233         @echo  '  xmldocs         - XML DocBook'
 234         @echo  '  mandocs         - man pages'
 235         @echo  '  installmandocs  - install man pages generated by mandocs'
 236         @echo  '  cleandocs       - clean all generated DocBook files'
 237
 238 ###
 239 # Temporary files left by various tools
 240 clean-files := $(DOCBOOKS) \
 241         $(patsubst %.xml, %.dvi,  $(DOCBOOKS)) \
 242         $(patsubst %.xml, %.aux,  $(DOCBOOKS)) \
 243         $(patsubst %.xml, %.tex,  $(DOCBOOKS)) \
 244         $(patsubst %.xml, %.log,  $(DOCBOOKS)) \
 245         $(patsubst %.xml, %.out,  $(DOCBOOKS)) \
 246         $(patsubst %.xml, %.ps,   $(DOCBOOKS)) \
 247         $(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \
 248         $(patsubst %.xml, %.html, $(DOCBOOKS)) \
 249         $(patsubst %.xml, %.9,    $(DOCBOOKS)) \
 250         $(C-procfs-example) $(index)
 251
 252 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 253
 254 cleandocs:
 255         $(Q)rm -f $(call objectify, $(clean-files))
 256         $(Q)rm -rf $(call objectify, $(clean-dirs))
 257
 258 # Declare the contents of the .PHONY variable as phony.  We keep that
 259 # information in a variable se we can use it in if_changed and friends.
 260
 261 .PHONY: $(PHONY)