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