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 drm.xml media_api.xml w1.xml \
  18             writing_musb_glue_layer.xml crypto-API.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 KERNELDOC = $(srctree)/scripts/kernel-doc
  70 DOCPROC   = $(objtree)/scripts/docproc
  71
  72 XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
  73 XMLTOFLAGS += --skip-validation
  74
  75 ###
  76 # DOCPROC is used for two purposes:
  77 # 1) To generate a dependency list for a .tmpl file
  78 # 2) To preprocess a .tmpl file and call kernel-doc with
  79 #     appropriate parameters.
  80 # The following rules are used to generate the .xml documentation
  81 # required to generate the final targets. (ps, pdf, html).
  82 quiet_cmd_docproc = DOCPROC $@
  83       cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
  84 define rule_docproc
  85         set -e;                                                         \
  86         $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';)         \
  87         $(cmd_$(1));                                                    \
  88         (                                                               \
  89           echo 'cmd_$@ := $(cmd_$(1))';                                 \
  90           echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`;           \
  91         ) > $(dir $@).$(notdir $@).cmd
  92 endef
  93
  94 %.xml: %.tmpl $(KERNELDOC) $(DOCPROC) FORCE
  95         $(call if_changed_rule,docproc)
  96
  97 # Tell kbuild to always build the programs
  98 always := $(hostprogs-y)
  99
 100 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
 101                    exit 1
 102 db2xtemplate = db2TYPE -o $(dir $@) $<
 103 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
 104
 105 # determine which methods are available
 106 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
 107         use-db2x = db2x
 108         prefer-db2x = db2x
 109 else
 110         use-db2x = notfound
 111         prefer-db2x = $(use-xmlto)
 112 endif
 113 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
 114         use-xmlto = xmlto
 115         prefer-xmlto = xmlto
 116 else
 117         use-xmlto = notfound
 118         prefer-xmlto = $(use-db2x)
 119 endif
 120
 121 # the commands, generated from the chosen template
 122 quiet_cmd_db2ps = PS      $@
 123       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
 124 %.ps : %.xml
 125         $(call cmd,db2ps)
 126
 127 quiet_cmd_db2pdf = PDF     $@
 128       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
 129 %.pdf : %.xml
 130         $(call cmd,db2pdf)
 131
 132
 133 index = index.html
 134 main_idx = $(obj)/$(index)
 135 build_main_index = rm -rf $(main_idx); \
 136                    echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
 137                    echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
 138                    cat $(HTML) >> $(main_idx)
 139
 140 quiet_cmd_db2html = HTML    $@
 141       cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
 142                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
 143                 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
 144
 145 %.html: %.xml
 146         @(which xmlto > /dev/null 2>&1) || \
 147          (echo "*** You need to install xmlto ***"; \
 148           exit 1)
 149         @rm -rf $@ $(patsubst %.html,%,$@)
 150         $(call cmd,db2html)
 151         @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
 152             cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
 153
 154 quiet_cmd_db2man = MAN     $@
 155       cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
 156 %.9 : %.xml
 157         @(which xmlto > /dev/null 2>&1) || \
 158          (echo "*** You need to install xmlto ***"; \
 159           exit 1)
 160         $(Q)mkdir -p $(obj)/man/$(*F)
 161         $(call cmd,db2man)
 162         @touch $@
 163
 164 ###
 165 # Rules to generate postscripts and PNG images from .fig format files
 166 quiet_cmd_fig2eps = FIG2EPS $@
 167       cmd_fig2eps = fig2dev -Leps $< $@
 168
 169 %.eps: %.fig
 170         @(which fig2dev > /dev/null 2>&1) || \
 171          (echo "*** You need to install transfig ***"; \
 172           exit 1)
 173         $(call cmd,fig2eps)
 174
 175 quiet_cmd_fig2png = FIG2PNG $@
 176       cmd_fig2png = fig2dev -Lpng $< $@
 177
 178 %.png: %.fig
 179         @(which fig2dev > /dev/null 2>&1) || \
 180          (echo "*** You need to install transfig ***"; \
 181           exit 1)
 182         $(call cmd,fig2png)
 183
 184 ###
 185 # Rule to convert a .c file to inline XML documentation
 186        gen_xml = :
 187  quiet_gen_xml = echo '  GEN     $@'
 188 silent_gen_xml = :
 189 %.xml: %.c
 190         @$($(quiet)gen_xml)
 191         @(                            \
 192            echo "<programlisting>";   \
 193            expand --tabs=8 < $< |     \
 194            sed -e "s/&/\\&amp;/g"     \
 195                -e "s/</\\&lt;/g"      \
 196                -e "s/>/\\&gt;/g";     \
 197            echo "</programlisting>")  > $@
 198
 199 ###
 200 # Help targets as used by the top-level makefile
 201 dochelp:
 202         @echo  ' Linux kernel internal documentation in different formats:'
 203         @echo  '  htmldocs        - HTML'
 204         @echo  '  pdfdocs         - PDF'
 205         @echo  '  psdocs          - Postscript'
 206         @echo  '  xmldocs         - XML DocBook'
 207         @echo  '  mandocs         - man pages'
 208         @echo  '  installmandocs  - install man pages generated by mandocs'
 209         @echo  '  cleandocs       - clean all generated DocBook files'
 210
 211 ###
 212 # Temporary files left by various tools
 213 clean-files := $(DOCBOOKS) \
 214         $(patsubst %.xml, %.dvi,  $(DOCBOOKS)) \
 215         $(patsubst %.xml, %.aux,  $(DOCBOOKS)) \
 216         $(patsubst %.xml, %.tex,  $(DOCBOOKS)) \
 217         $(patsubst %.xml, %.log,  $(DOCBOOKS)) \
 218         $(patsubst %.xml, %.out,  $(DOCBOOKS)) \
 219         $(patsubst %.xml, %.ps,   $(DOCBOOKS)) \
 220         $(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \
 221         $(patsubst %.xml, %.html, $(DOCBOOKS)) \
 222         $(patsubst %.xml, %.9,    $(DOCBOOKS)) \
 223         $(index)
 224
 225 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
 226
 227 cleandocs: cleanmediadocs
 228         $(Q)rm -f $(call objectify, $(clean-files))
 229         $(Q)rm -rf $(call objectify, $(clean-dirs))
 230
 231 # Declare the contents of the .PHONY variable as phony.  We keep that
 232 # information in a variable se we can use it in if_changed and friends.
 233
 234 .PHONY: $(PHONY)