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 gpu.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 ###
  37 # The targets that may be used.
  38 PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
  39
  40 targets += $(DOCBOOKS)
  41 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
  42 xmldocs: $(BOOKS)
  43 sgmldocs: xmldocs
  44
  45 PS := $(patsubst %.xml, %.ps, $(BOOKS))
  46 psdocs: $(PS)
  47
  48 PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
  49 pdfdocs: $(PDF)
  50
  51 HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
  52 htmldocs: $(HTML)
  53         $(call build_main_index)
  54         $(call build_images)
  55         $(call install_media_images)
  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 ###
  68 #External programs used
  69 KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
  70 KERNELDOC       = $(srctree)/scripts/kernel-doc
  71 DOCPROC         = $(objtree)/scripts/docproc
  72 CHECK_LC_CTYPE = $(objtree)/scripts/check-lc_ctype
  73
  74 # Use a fixed encoding - UTF-8 if the C library has support built-in
  75 # or ASCII if not
  76 LC_CTYPE := $(call try-run, LC_CTYPE=C.UTF-8 $(CHECK_LC_CTYPE),C.UTF-8,C)
  77 export LC_CTYPE
  78
  79 XMLTOFLAGS = -m $(srctree)/$(src)/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 $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE
 102         $(call if_changed_rule,docproc)
 103
 104 # Tell kbuild to always build the programs
 105 always := $(hostprogs-y)
 106
 107 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
 108                    exit 1
 109 db2xtemplate = db2TYPE -o $(dir $@) $<
 110 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
 111
 112 # determine which methods are available
 113 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
 114         use-db2x = db2x
 115         prefer-db2x = db2x
 116 else
 117         use-db2x = notfound
 118         prefer-db2x = $(use-xmlto)
 119 endif
 120 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
 121         use-xmlto = xmlto
 122         prefer-xmlto = xmlto
 123 else
 124         use-xmlto = notfound
 125         prefer-xmlto = $(use-db2x)
 126 endif
 127
 128 # the commands, generated from the chosen template
 129 quiet_cmd_db2ps = PS      $@
 130       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
 131 %.ps : %.xml
 132         $(call cmd,db2ps)
 133
 134 quiet_cmd_db2pdf = PDF     $@
 135       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
 136 %.pdf : %.xml
 137         $(call cmd,db2pdf)
 138
 139
 140 index = index.html
 141 main_idx = $(obj)/$(index)
 142 build_main_index = rm -rf $(main_idx); \
 143                    echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
 144                    echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
 145                    cat $(HTML) >> $(main_idx)
 146
 147 quiet_cmd_db2html = HTML    $@
 148       cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
 149                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
 150                 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
 151
 152 ###
 153 # Rules to create an aux XML and .db, and use them to re-process the DocBook XML
 154 # to fill internal hyperlinks
 155        gen_aux_xml = :
 156  quiet_gen_aux_xml = echo '  XMLREF  $@'
 157 silent_gen_aux_xml = :
 158 %.aux.xml: %.xml
 159         @$($(quiet)gen_aux_xml)
 160         @rm -rf $@
 161         @(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db)
 162         @$(KERNELDOCXMLREF) -db $<.db $< > $@
 163 .PRECIOUS: %.aux.xml
 164
 165 %.html: %.aux.xml
 166         @(which xmlto > /dev/null 2>&1) || \
 167          (echo "*** You need to install xmlto ***"; \
 168           exit 1)
 169         @rm -rf $@ $(patsubst %.html,%,$@)
 170         $(call cmd,db2html)
 171         @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
 172             cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
 173
 174 quiet_cmd_db2man = MAN     $@
 175       cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
 176 %.9 : %.xml
 177         @(which xmlto > /dev/null 2>&1) || \
 178          (echo "*** You need to install xmlto ***"; \
 179           exit 1)
 180         $(Q)mkdir -p $(obj)/man/$(*F)
 181         $(call cmd,db2man)
 182         @touch $@
 183
 184 ###
 185 # Rules to generate postscripts and PNG images from .fig format files
 186 quiet_cmd_fig2eps = FIG2EPS $@
 187       cmd_fig2eps = fig2dev -Leps $< $@
 188
 189 %.eps: %.fig
 190         @(which fig2dev > /dev/null 2>&1) || \
 191          (echo "*** You need to install transfig ***"; \
 192           exit 1)
 193         $(call cmd,fig2eps)
 194
 195 quiet_cmd_fig2png = FIG2PNG $@
 196       cmd_fig2png = fig2dev -Lpng $< $@
 197
 198 %.png: %.fig
 199         @(which fig2dev > /dev/null 2>&1) || \
 200          (echo "*** You need to install transfig ***"; \
 201           exit 1)
 202         $(call cmd,fig2png)
 203
 204 ###
 205 # Rule to convert a .c file to inline XML documentation
 206        gen_xml = :
 207  quiet_gen_xml = echo '  GEN     $@'
 208 silent_gen_xml = :
 209 %.xml: %.c
 210         @$($(quiet)gen_xml)
 211         @(                            \
 212            echo "<programlisting>";   \
 213            expand --tabs=8 < $< |     \
 214            sed -e "s/&/\\&amp;/g"     \
 215                -e "s/</\\&lt;/g"      \
 216                -e "s/>/\\&gt;/g";     \
 217            echo "</programlisting>")  > $@
 218
 219 ###
 220 # Help targets as used by the top-level makefile
 221 dochelp:
 222         @echo  ' Linux kernel internal documentation in different formats:'
 223         @echo  '  htmldocs        - HTML'
 224         @echo  '  pdfdocs         - PDF'
 225         @echo  '  psdocs          - Postscript'
 226         @echo  '  xmldocs         - XML DocBook'
 227         @echo  '  mandocs         - man pages'
 228         @echo  '  installmandocs  - install man pages generated by mandocs'
 229         @echo  '  cleandocs       - clean all generated DocBook files'
 230
 231 ###
 232 # Temporary files left by various tools
 233 clean-files := $(DOCBOOKS) \
 234         $(patsubst %.xml, %.dvi,     $(DOCBOOKS)) \
 235         $(patsubst %.xml, %.aux,     $(DOCBOOKS)) \
 236         $(patsubst %.xml, %.tex,     $(DOCBOOKS)) \
 237         $(patsubst %.xml, %.log,     $(DOCBOOKS)) \
 238         $(patsubst %.xml, %.out,     $(DOCBOOKS)) \
 239         $(patsubst %.xml, %.ps,      $(DOCBOOKS)) \
 240         $(patsubst %.xml, %.pdf,     $(DOCBOOKS)) \
 241         $(patsubst %.xml, %.html,    $(DOCBOOKS)) \
 242         $(patsubst %.xml, %.9,       $(DOCBOOKS)) \
 243         $(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
 244         $(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
 245         $(patsubst %.xml, %.xml,     $(DOCBOOKS)) \
 246         $(index)
 247
 248 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 249
 250 cleandocs: cleanmediadocs
 251         $(Q)rm -f $(call objectify, $(clean-files))
 252         $(Q)rm -rf $(call objectify, $(clean-dirs))
 253
 254 # Declare the contents of the .PHONY variable as phony.  We keep that
 255 # information in a variable se we can use it in if_changed and friends.
 256
 257 .PHONY: $(PHONY)