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