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