docs-xml/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
  13 # Lists of files to process
  14 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR3)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES3))
  15 DBLATEX_OPTIONS = -p xslt/latex.xsl -i xslt/latex
  16
  17 DATETIME := $(shell date +%Y%m%d%H%M%S)
  18
  19 ifeq ($(PROFILE), Y)
  20 XSLTPROC += --profile --load-trace --timing
  21 endif
  22
  23 ifndef OUTPUTDIR
  24 Makefile.settings: configure
  25         ./configure
  26
  27 configure: configure.ac
  28         autoreconf
  29 endif
  30
  31 help:
  32         @echo "Supported make targets:"
  33         @echo " release - Build the docs needed for a Samba release"
  34         @echo " all - Build all docs that can be build using the utilities found by configure"
  35         @echo " everything - Build all of the above"
  36         @echo " pdf,tex,ps,manpages3,txt,pearson,htmlhelp - Build specific output format"
  37         @echo " html - Build multi-file HTML versions"
  38         @echo " html-single - Build single-file HTML versions"
  39         @echo " htmlman3 - Build HTML version of manpages"
  40         @echo " undocumented - Output list of undocumented smb.conf options"
  41         @echo " samples - Extract examples"
  42
  43 $(DOCBOOKDIR)/Samba3-ByExample.xml: $(filter-out Samba3-ByExample/index.xml,$(wildcard Samba3-ByExample/*.xml))
  44 $(DOCBOOKDIR)/Samba3-HOWTO.xml: $(filter-out Samba3-HOWTO/index.xml,$(wildcard Samba3-HOWTO/*.xml)) Samba3-HOWTO-attributions.xml
  45 Samba3-HOWTO/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 pdf html-single html htmlman3 txt ps fo htmlhelp pearson
  52 release:: manpages3 htmlman3 html pdf
  53 clean::
  54         @echo "Cleaning up..."
  55         rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
  56         rm -f $(patsubst %.svg,%.png,$(wildcard */images/*.svg)) \
  57                   $(patsubst %.svg,%.eps,$(wildcard */images/*.svg)) \
  58                   $(patsubst %.png,%.eps,$(wildcard */images/*.png))
  59         rm -f *-attributions.xml *.tpt *.tex *.loc *.toc *.lof *.glo *.idx *.aux
  60         rm -f $(SMBDOTCONFDOC)/parameters.*.xml
  61         rm -f $(addsuffix .*,$(MAIN_DOCS))
  62         rm -f build/catalog.xml
  63
  64 # Output format targets
  65 pdf:: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
  66 ps:: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS))
  67 txt:: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS))
  68 tex:: $(addsuffix .tex,$(MAIN_DOCS))
  69 texi:: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
  70 texiinfo:: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
  71 manpages3:: $(patsubst $(MANPAGEDIR3)/%.xml,$(OUTPUTDIR)/manpages-3/%,$(MANPAGES3))
  72 pearson:: $(PEARSONDIR)/Samba3-HOWTO.xml
  73 pearson-verify:: $(PEARSONDIR)/Samba3-HOWTO.report.html
  74 plucker:: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
  75 htmlman3:: $(patsubst $(MANPAGEDIR3)/%.xml,$(HTMLDIR)/manpages-3/%.html,$(MANPAGES3)) $(HTMLDIR)/manpages-3/index.html
  76 html-single:: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
  77 html:: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
  78 htmlhelp:: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS))
  79 validate:: $(addsuffix -validate,$(MAIN_DOCS))
  80
  81 test:: validate
  82 check:: validate
  83
  84 .PHONY: test check validate
  85
  86 # Intermediate docbook docs
  87 #
  88 $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
  89         @echo "Converting Samba-specific tags for $*..."
  90         @mkdir -p $(@D)
  91         @$(XSLTPROC) --stringparam latex.imagebasedir "$*/"  --stringparam noreference 0  --xinclude --output $@ xslt/expand-sambadoc.xsl $<
  92
  93 $(DOCBOOKDIR)/manpages-3/%.xml: $(MANPAGEDIR3)/%.xml xslt/expand-sambadoc.xsl
  94         @mkdir -p $(@D)
  95         $(XSLTPROC) --xinclude --stringparam noreference 0 --output $@ xslt/expand-sambadoc.xsl $<
  96
  97 $(DOCBOOKDIR)/manpages-3/index.xml: $(MANPAGES3) xslt/manpage-summary.xsl
  98         @mkdir -p $(@D)
  99         echo "<article><variablelist>" > $@
 100         $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@
 101         @echo "</variablelist></article>" >> $@
 102
 103 # HTML docs
 104 $(HTMLDIR)/index.html: htmldocs.html
 105         @mkdir -p $(@D)
 106         cp $< $@
 107
 108 $(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl
 109         @mkdir -p $(@D)
 110         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
 111
 112 # Single large HTML files
 113 $(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
 114         @mkdir -p $(@D)
 115         cp $< $@
 116
 117 $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-png
 118
 119 define IMAGES_TEMPLATE
 120 $(1)-images-png:: $$(patsubst %.svg,%.png,$$(wildcard $(1)/images/*.svg)) ;
 121 $(1)-images-eps:: $$(patsubst %.svg,%.eps,$$(wildcard $(1)/images/*.svg)) ;
 122 $(1)-images-eps:: $$(patsubst %.png,%.eps,$$(wildcard $(1)/images/*.png)) ;
 123
 124 endef
 125
 126 $(eval $(foreach DOC, $(MAIN_DOCS),$(call IMAGES_TEMPLATE,$(DOC))))
 127
 128 $(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl
 129         $(XSLTPROC) --output $@ xslt/html.xsl $<
 130
 131 # Attributions
 132 %-attributions.xml:
 133         @echo "Generating attributions file $@ from $*/"
 134         @cp -f templates/attributions.xml $@
 135         @$(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml
 136
 137 # Text files
 138 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
 139         @mkdir -p $(@D)
 140         $(HTML2TEXT) -nobs -style pretty -o $@ $<
 141
 142 # Tex files
 143 %.tex: %/index.xml xslt/latex.xsl
 144         @echo "Generating $@..."
 145         @mkdir -p $(@D)
 146         @$(DBLATEX) $(DBLATEX_OPTIONS) -t tex -o $@ $<
 147
 148 # Adobe PDF files
 149 $(PDFDIR)/%.pdf: %/index.xml $(PDFDIR) xslt/latex.xsl %-images-png
 150         $(DBLATEX) $(DBLATEX_OPTIONS) -I $*/images -t pdf -o $@ $<
 151
 152 # PostScript files
 153 $(PSDIR)/%.ps: %/index.xml $(PSDIR) xslt/latex.xsl %-images-eps
 154         $(DBLATEX) $(DBLATEX_OPTIONS) -I $*/images -t ps -o $@ $<
 155
 156 %.eps: %.svg
 157         $(INKSCAPE) -z -f $< --export-eps=$@
 158
 159 %.png: %.svg
 160         $(INKSCAPE) -z -f $< --export-png=$@
 161
 162 %.eps: %.png
 163         $(PNGTOPNM) $< | $(PNMTOPS) > $@
 164
 165 $(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-png
 166         $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
 167                                 --stringparam manifest.in.base.dir "$@/" \
 168                                 --stringparam base.dir "$@/" \
 169         http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
 170
 171 # Plucker docs
 172 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
 173         @mkdir -p $(@D)
 174         $(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$<
 175
 176 # Texinfo docs
 177 $(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml
 178         @mkdir -p $(@D)
 179         cd $(@D) && $(DB2TEXI) $(shell pwd)/$<
 180
 181 $(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi
 182         $(MAKEINFO) --no-validate --force -o $@ "$<"
 183
 184 # Manpages
 185 $(MANPAGEDIR3)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
 186
 187 $(SMBDOTCONFDOC)/parameters.all.xml: $(wildcard $(SMBDOTCONFDOC)/*/*.xml) $(SMBDOTCONFDOC)/generate-file-list.sh
 188         $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@
 189
 190 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 191         @echo "Generating list of global smb.conf options"
 192         $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
 193
 194 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 195         @echo "Generating list of share-mode smb.conf options"
 196         $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
 197
 198 $(OUTPUTDIR):
 199         test -d $@ || mkdir $@
 200
 201 $(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
 202         @mkdir -p $(@D)
 203         $(XSLTPROC) --output $@ xslt/man.xsl $<
 204
 205 # Individual smb.conf parameters
 206 smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml))
 207
 208 $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
 209         @mkdir -p $(@D)
 210         $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
 211
 212 # Pearson compatible XML
 213 $(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
 214         @mkdir -p $(@D)
 215         $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
 216
 217 $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
 218         @mkdir -p $(@D)
 219         -$(XMLLINT) --valid --noout $< 2> $@
 220
 221 # Validation verification
 222 %-validate: %/index.xml
 223         cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
 224
 225 # Find undocumented parameters
 226 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl
 227         $(PERL) scripts/find_missing_doc.pl $(SRCDIR)
 228         $(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
 229
 230 samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
 231         @mkdir -p examples
 232         $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
 233         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
 234
 235 # Archiving
 236 archive: pdf
 237         @mkdir -p $(ARCHIVEDIR)
 238         cp $(PDFDIR)/Samba3-HOWTO.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf
 239         cp $(PDFDIR)/Samba3-ByExample.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf
 240
 241 # XSL scripts
 242 xslt/html.xsl: xslt/html-common.xsl
 243 xslt/html-chunk.xsl: xslt/html-common.xsl
 244
 245 distclean clobber:: clean
 246         rm -f Makefile.settings config.status config.log
 247
 248 realdistclean:: distclean
 249         rm -f configure
 250         rm -rf autom4te.cache
 251
 252 # Always keep intermediate files if we can
 253 .SECONDARY:
 254 .PHONY: clean clobber archive release everything all