docs/Makefile

   1 #################################################################
   2 # Makefile for Samba Documentation
   3 # Authors:
   4 #               James Moore <jmoore@php.net>
   5 #               Gerald Carter <jerry@samba.org>
   6 #               Jelmer Vernooij <jelmer@samba.org>
   7 include Makefile.settings
   8
   9 # Docs to build
  10 MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
  11 MANPAGES = $(wildcard $(MANPAGEDIR)/*.?.xml)
  12
  13 # Lists of files to process
  14 LATEX_FIGURES = xslt/figures/caution.pdf xslt/figures/important.pdf xslt/figures/note.pdf xslt/figures/tip.pdf xslt/figures/warning.pdf
  15 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES))
  16
  17 DATETIME := $(shell date +%Y%m%d%H%M%S)
  18
  19 ifndef OUTPUTDIR
  20 Makefile.settings: configure
  21         @echo Makefile.settings not present, trying to run configure...
  22         @./configure
  23
  24 configure: configure.in
  25         @echo configure not present, trying to generate
  26         @autoreconf
  27 endif
  28
  29 help:
  30         @echo "Supported make targets:"
  31         @echo " release - Build the docs needed for a Samba release"
  32         @echo " all - Build all docs that can be build using the utilities found by configure"
  33         @echo " everything - Build all of the above"
  34         @echo " pdf,tex,dvi,ps,manpages,txt,pearson,fo,htmlhelp - Build specific output format"
  35         @echo " html - Build multi-file HTML versions"
  36         @echo " html-single - Build single-file HTML versions"
  37         @echo " htmlman - Build HTML version of manpages"
  38         @echo " undocumented - Output list of undocumented smb.conf options"
  39         @echo " samples - Extract examples"
  40         @echo " files - Extract other files"
  41
  42 $(DOCBOOKDIR)/Samba-Guide.xml: $(filter-out Samba-Guide/index.xml,$(wildcard Samba-Guide/*.xml))
  43 $(DOCBOOKDIR)/Samba-HOWTO-Collection.xml: $(filter-out Samba-HOWTO-Collection/index.xml,$(wildcard Samba-HOWTO-Collection/*.xml)) Samba-HOWTO-Collection-attributions.xml
  44 Samba-HOWTO-Collection/manpages.xml: $(MANPAGEDIR)/smb.conf.5.xml
  45 $(DOCBOOKDIR)/Samba-Developers-Guide.xml: $(filter-out Samba-Developers-Guide/index.xml,$(wildcard Samba-Developers-Guide/*.xml)) Samba-Developers-Guide-attributions.xml
  46
  47 # Pseudo targets
  48 all: $(TARGETS)
  49 everything: manpages pdf html-single html htmlman txt ps fo htmlhelp pearson
  50 release: manpages htmlman html pdf
  51
  52 # Output format targets
  53 pdf: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
  54 dvi: $(patsubst %,$(DVIDIR)/%.dvi,$(MAIN_DOCS))
  55 ps: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS))
  56 txt: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS))
  57 txt-chunks: $(addsuffix -txt-chunks,$(MAIN_DOCS))
  58 fo: $(patsubst %,$(FODIR)/%.fo,$(MAIN_DOCS))
  59 fo-pdf: $(patsubst %,$(FOPDFDIR)/%.pdf,$(MAIN_DOCS))
  60 tex: $(addsuffix .tex,$(MAIN_DOCS))
  61 texi: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
  62 texiinfo: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
  63 manpages: $(patsubst $(MANPAGEDIR)/%.xml,$(MANDIR)/%,$(MANPAGES))
  64 pearson: $(PEARSONDIR)/Samba-HOWTO-Collection.xml
  65 pearson-verify: $(PEARSONDIR)/Samba-HOWTO-Collection.report.html
  66 plucker: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
  67 htmlman: $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/%.html,$(MANPAGES)) $(HTMLDIR)/manpages.html
  68 html-single: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
  69 html: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
  70 htmlhelp: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS))
  71 validate: $(addsuffix -validate,$(MAIN_DOCS))
  72
  73 # Intermediate docbook docs
  74 #
  75 $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
  76         mkdir -p $(@D)
  77         $(XSLTPROC) --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
  78
  79 $(DOCBOOKDIR)/%.xml: $(MANPAGEDIR)/%.xml xslt/expand-sambadoc.xsl
  80         mkdir -p $(@D)
  81         $(XSLTPROC) --xinclude --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
  82
  83 $(DOCBOOKDIR)/manpages.xml: $(MANPAGES) xslt/manpage-summary.xsl
  84         mkdir -p $(@D)
  85         echo "<article><variablelist>" > $@
  86         $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES) >> $@
  87         echo "</variablelist></article>" >> $@
  88
  89 # HTML docs
  90
  91 $(HTMLDIR)/index.html: htmldocs.html
  92         mkdir -p $(@D)
  93         cp $< $@
  94
  95 $(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks
  96         mkdir -p $(@D)
  97         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
  98
  99 # Single large HTML files
 100 $(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
 101         mkdir -p $(@D)
 102         cp $< $@
 103
 104 $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single
 105
 106 $(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl
 107         $(XSLTPROC) --output $@ xslt/html.xsl $<
 108
 109 # Attributions
 110 %-attributions.xml:
 111         $(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml
 112
 113 # Text files
 114 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
 115         mkdir -p $(@D)
 116         $(HTML2TEXT) -nobs -style pretty -o $@ $<
 117
 118 # Tex files
 119 %.tex: $(DOCBOOKDIR)/%.xml xslt/latex.xsl
 120         mkdir -p $(@D)
 121         $(XSLTPROC) --output $@ xslt/latex.xsl $<
 122
 123 latexfigures: $(LATEX_FIGURES)
 124         touch $@
 125
 126 $(PDFDIR)/%.pdf: %.pdf
 127         mkdir -p $(@D)
 128         cp $< $@
 129
 130 %.idx: %.tex latexfigures
 131         -$(PDFLATEX) $<
 132
 133 %.ind: %.idx
 134         $(MAKEINDEX) $<
 135
 136 # Dependency files
 137 %.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl
 138         $(XSLTPROC) \
 139                 --novalid \
 140                 --stringparam txtbasedir "$(TXTDIR)/$*/" \
 141                 --stringparam target "$*" \
 142                 -o $@ xslt/generate-dependencies.xsl $<
 143         @echo "$*-images-latex-png: \$$(addsuffix .png, \$$($*-images-latex))" >> $@
 144         @echo " touch \$$@" >> $@
 145         @echo >> $@
 146         @echo "$*-images-latex-eps: \$$(addsuffix .eps, \$$($*-images-latex))" >> $@
 147         @echo " touch \$$@" >> $@
 148         @echo >> $@
 149         @echo "\$$(HTMLDIR)/%: $*/%" >> $@
 150         @echo " mkdir -p \$$(@D)" >> $@
 151         @echo " cp \$$< \$$@" >> $@
 152         @echo >> $@
 153         @echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@
 154         @echo " mkdir -p \$$(@D)" >> $@
 155         @echo " cp \$$< \$$@" >> $@
 156         @echo >> $@
 157         @echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@
 158         @echo " mkdir -p \$$(@D)" >> $@
 159         @echo " cp \$$< \$$@" >> $@
 160         @echo >> $@
 161         @echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@
 162         @echo " touch \$$@" >> $@
 163         @echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@
 164         @echo " touch \$$@" >> $@
 165         @echo "$*-images-htmlhelp: \$$(addprefix \$$(HTMLHELPDIR)/$*/, \$$($*-images-html))" >> $@
 166         @echo " touch \$$@" >> $@
 167
 168 ifdef OUTPUTDIR
 169 ifneq ($(MAKECMDGOALS),clobber)
 170 include $(addsuffix .d,$(MAIN_DOCS))
 171 endif
 172 endif
 173
 174 # Adobe PDF files
 175 %.pdf: %.tex %.ind latexfigures %-images-latex-png
 176         -$(PDFLATEX) $<
 177         $(THUMBPDF) --quiet $*.pdf
 178         -$(PDFLATEX) $<
 179
 180 # DVI files
 181 $(DVIDIR)/%.dvi: %.dvi
 182         mkdir -p $(@D)
 183         cp $< $@
 184
 185 %.dvi: %.tex %.idx %-images-latex-eps
 186         -$(LATEX) $<
 187
 188 %.png: %.dia
 189         $(DIA) -e $@ $<
 190
 191 %.eps: %.png
 192         $(PNGTOPNM) $< | $(PNMTOPS) > $@
 193
 194 # PostScript files
 195 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
 196         mkdir -p $(@D)
 197         $(DVIPS) -o $@ $<
 198
 199 xslt/figures/%.pdf: xslt/figures/%.eps
 200         $(EPSTOPDF) $<
 201
 202 # Fo
 203 $(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml
 204         mkdir -p $(@D)
 205         $(XSLTPROC) --output $@ xslt/fo.xsl $<
 206
 207 # PDF thru Fo
 208 $(FOPDFDIR)/%.pdf: $(FODIR)/%.fo
 209         mkdir -p $(@D)
 210         JAVA_OPTS=-Xmx250m $(FOP) -q -d $< -pdf $@
 211
 212 $(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
 213         $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
 214                                 --stringparam manifest.in.base.dir "$@/" \
 215                                 --stringparam base.dir "$@/" \
 216         http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
 217
 218 # Plucker docs
 219 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
 220         mkdir -p $(@D)
 221         $(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$<
 222
 223 # Texinfo docs
 224 $(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml
 225         mkdir -p $(@D)
 226         cd $(@D) && $(DB2TEXI) $(shell pwd)/$<
 227
 228 $(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi
 229         $(MAKEINFO) --no-validate --force -o $@ "$<"
 230
 231 # Manpages
 232 $(MANPAGEDIR)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
 233
 234 $(SMBDOTCONFDOC)/parameters.all.xml: $(shell find $(SMBDOTCONFDOC) -type f -name '*.xml' -mindepth 2 | sort -t/ -k3 | xargs) $(SMBDOTCONFDOC)/generate-file-list.sh
 235         $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@
 236
 237 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 238         $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
 239
 240 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 241         $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
 242
 243 $(MANDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
 244         mkdir -p $(@D)
 245         $(XSLTPROC) --output $@ xslt/man.xsl $<
 246
 247 # Individual smb.conf parameters
 248 smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml))
 249
 250 $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
 251         mkdir -p $(@D)
 252         $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
 253
 254 # Pearson compatible XML
 255 $(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
 256         mkdir -p $(@D)
 257         $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
 258
 259 $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
 260         mkdir -p $(@D)
 261         -$(XMLLINT) --valid --noout $< 2> $@
 262
 263 # Validation verification
 264 %-validate: %/index.xml
 265         cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
 266
 267 # Find undocumented parameters
 268 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl
 269         @$(PERL) scripts/find_missing_doc.pl $(SRCDIR)
 270         @$(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
 271
 272 # Examples and the like
 273 files: Samba-HOWTO-Collection/index.xml xslt/extract-smbfiles.xsl
 274         $(XSLTPROC) xslt/extract-smbfiles.xsl $< > /dev/null
 275
 276 samples: $(DOCBOOKDIR)/Samba-HOWTO-Collection.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
 277         mkdir -p $(EXAMPLESDIR)
 278         $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
 279         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
 280
 281 # Archiving
 282 archive: pdf
 283         mkdir -p $(ARCHIVEDIR)
 284         cp $(PDFDIR)/Samba-HOWTO-Collection.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf
 285         cp $(PDFDIR)/Samba-Guide.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf
 286
 287 # XSL scripts
 288 xslt/html.xsl: xslt/html-common.xsl settings.xsl
 289 xslt/html-chunk.xsl: xslt/html-common.xsl settings.xsl
 290 xslt/latex.xsl: settings.xsl
 291 xslt/expand-sambadoc.xsl: settings.xsl
 292 xslt/generate-attributions.xsl:
 293 xslt/man.xsl:
 294 xslt/pearson.xsl:
 295
 296 clobber: clean
 297         rm Makefile.settings settings.xsl config.status config.log configure
 298
 299 clean:
 300         rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
 301         rm -f *.xml *.d
 302         rm -f xslt/figures/*pdf
 303         rm -f $(SMBDOTCONFDOC)/parameters.*.xml
 304         rm -f $(addsuffix .*,$(MAIN_DOCS))
 305
 306 # Always keep intermediate files if we can
 307 .SECONDARY:
 308 .PHONY: clean clobber archive release everything all $(TARGETS)