diff options
Diffstat (limited to 'docs-xml/Makefile')
| -rw-r--r-- | docs-xml/Makefile | 329 |
1 files changed, 329 insertions, 0 deletions
diff --git a/docs-xml/Makefile b/docs-xml/Makefile new file mode 100644 index 0000000000..1e4121053d --- /dev/null +++ b/docs-xml/Makefile @@ -0,0 +1,329 @@ +################################################################# +# Makefile for Samba Documentation +# Authors: +# James Moore <jmoore@php.net> +# Gerald Carter <jerry@samba.org> +# Jelmer Vernooij <jelmer@samba.org> +include Makefile.settings + +# Docs to build +MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml)) +MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml) +export TEXINPUTS=xslt/latex:.: + +# Lists of files to process +LATEX_FIGURES = xslt/figures/caution.pdf xslt/figures/important.pdf xslt/figures/note.pdf xslt/figures/tip.pdf xslt/figures/warning.pdf +MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR3)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES3)) + +DATETIME := $(shell date +%Y%m%d%H%M%S) + +ifeq ($(PROFILE), Y) +XSLTPROC += --profile --load-trace --timing +endif + +ifndef OUTPUTDIR +Makefile.settings: configure + @echo Makefile.settings not present, trying to run configure... + ./configure + +configure: configure.ac + @echo configure not present, trying to regenerate it... + autoreconf +endif + +help: + @echo "Supported make targets:" + @echo " release - Build the docs needed for a Samba release" + @echo " all - Build all docs that can be build using the utilities found by configure" + @echo " everything - Build all of the above" + @echo " pdf,tex,dvi,ps,manpages3,txt,pearson,fo,htmlhelp - Build specific output format" + @echo " html - Build multi-file HTML versions" + @echo " html-single - Build single-file HTML versions" + @echo " htmlman3 - Build HTML version of manpages" + @echo " undocumented - Output list of undocumented smb.conf options" + @echo " samples - Extract examples" + +$(DOCBOOKDIR)/Samba3-ByExample.xml: $(filter-out Samba3-ByExample/index.xml,$(wildcard Samba3-ByExample/*.xml)) +$(DOCBOOKDIR)/Samba3-HOWTO.xml: $(filter-out Samba3-HOWTO/index.xml,$(wildcard Samba3-HOWTO/*.xml)) Samba3-HOWTO-attributions.xml +Samba3-HOWTO/manpages.xml: $(MANPAGEDIR3)/smb.conf.5.xml +$(DOCBOOKDIR)/Samba3-Developers-Guide.xml: $(filter-out Samba3-Developers-Guide/index.xml,$(wildcard Samba3-Developers-Guide/*.xml)) Samba3-Developers-Guide-attributions.xml +$(DOCBOOKDIR)/Samba4-HOWTO.xml: $(filter-out Samba4-HOWTO/index.xml,$(wildcard Samba4-HOWTO/*.xml)) Samba4-HOWTO-attributions.xml + +# Pseudo targets +all: $(TARGETS) +everything: manpages3 pdf html-single html htmlman3 txt ps fo htmlhelp pearson +release: manpages3 htmlman3 html pdf +clean: + @echo "Cleaning up..." + rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR) + rm -f $(patsubst %.svg,%.png,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-dia))) \ + $(patsubst %.svg,%.pdf,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg))) \ + $(patsubst %.svg,%.eps,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg))) + rm -f *.xml *.d *.tpt *.tex *.loc *.toc *.lof *.glo *.idx *.aux + rm -f *-images-html* + rm -f *-images-latex-* latexfigures + rm -f xslt/figures/*pdf + rm -f $(SMBDOTCONFDOC)/parameters.*.xml + rm -f $(addsuffix .*,$(MAIN_DOCS)) + +# Output format targets +pdf: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS)) +dvi: $(patsubst %,$(DVIDIR)/%.dvi,$(MAIN_DOCS)) +ps: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS)) +txt: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS)) +txt-chunks: $(addsuffix -txt-chunks,$(MAIN_DOCS)) +fo: $(patsubst %,$(FODIR)/%.fo,$(MAIN_DOCS)) +fo-pdf: $(patsubst %,$(FOPDFDIR)/%.pdf,$(MAIN_DOCS)) +tex: $(addsuffix .tex,$(MAIN_DOCS)) +texi: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS)) +texiinfo: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS)) +manpages3: $(patsubst $(MANPAGEDIR3)/%.xml,$(OUTPUTDIR)/manpages-3/%,$(MANPAGES3)) +pearson: $(PEARSONDIR)/Samba3-HOWTO.xml +pearson-verify: $(PEARSONDIR)/Samba3-HOWTO.report.html +plucker: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS)) +htmlman3: $(patsubst $(MANPAGEDIR3)/%.xml,$(HTMLDIR)/manpages-3/%.html,$(MANPAGES3)) $(HTMLDIR)/manpages-3/index.html +html-single: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)) +html: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html +htmlhelp: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS)) +validate: $(addsuffix -validate,$(MAIN_DOCS)) + +# Intermediate docbook docs +# +$(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl + @echo "Converting Samba-specific tags for $*..." + @mkdir -p $(@D) + $(XSLTPROC) --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $< + +$(DOCBOOKDIR)/manpages-3/%.xml: $(MANPAGEDIR3)/%.xml xslt/expand-sambadoc.xsl + @mkdir -p $(@D) + $(XSLTPROC) --xinclude --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $< + +$(DOCBOOKDIR)/manpages-3/index.xml: $(MANPAGES3) xslt/manpage-summary.xsl + @mkdir -p $(@D) + echo "<article><variablelist>" > $@ + $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@ + @echo "</variablelist></article>" >> $@ + +# HTML docs + +$(HTMLDIR)/index.html: htmldocs.html + @mkdir -p $(@D) + cp $< $@ + +$(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks + @mkdir -p $(@D) + $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $< + +# Single large HTML files +$(OUTPUTDIR)/%/samba.css: xslt/html/samba.css + @mkdir -p $(@D) + cp $< $@ + +$(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single + +$(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl + $(XSLTPROC) --output $@ xslt/html.xsl $< + +# Attributions +%-attributions.xml: + @echo "Generating attributions file $@ from $*/" + @cp -f templates/attributions.xml $@ + $(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml + +# Text files +$(TXTDIR)/%.txt: $(HTMLDIR)/%.html + @mkdir -p $(@D) + $(HTML2TEXT) -nobs -style pretty -o $@ $< + +# Tex files +%.tex: %/index.xml xslt/latex.xsl + @echo "Generating $@..." + @mkdir -p $(@D) + $(XSLTPROC) $(DB2LATEX_ARGS) --stringparam latex.imagebasedir "$*/" --xinclude --output $@ xslt/latex.xsl $< + +latexfigures: $(LATEX_FIGURES) + +$(PDFDIR)/%.pdf: %.pdf + @mkdir -p $(@D) + cp $< $@ + +%.idx: %.tex latexfigures + -$(PDFLATEX) $< + +%.ind: %.idx + $(MAKEINDEX) $< + +# Dependency files +%.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl + @echo "Generating dependency file for $*" + $(XSLTPROC) \ + --novalid \ + --stringparam txtbasedir "$(TXTDIR)/$*/" \ + --stringparam target "$*" \ + -o $@ xslt/generate-dependencies.xsl $< + @echo "$*-images-latex-svg = \$$(wildcard \$$(addsuffix .svg, \$$($*-images-latex)))" >> $@ + @echo "$*-images-latex-eps: \$$(addsuffix .eps, \$$($*-images-latex))" >> $@ + @echo "$*-images-latex-pdf: \$$(patsubst %.svg, %.pdf, \$$($*-images-latex-svg))" >> $@ + @echo "$*-images-latex-png: \$$(filter-out \$$(patsubst %.svg,%.png,\$$($*-images-latex-svg)), \$$(addsuffix .png, \$$($*-images-latex)))" >> $@ + + @echo >> $@ + @echo "\$$(HTMLDIR)/%: $*/%" >> $@ + @echo " @mkdir -p \$$(@D)" >> $@ + @echo " @cp \$$< \$$@" >> $@ + @echo >> $@ + @echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@ + @echo " @mkdir -p \$$(@D)" >> $@ + @echo " @cp \$$< \$$@" >> $@ + @echo >> $@ + @echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@ + @echo " @mkdir -p \$$(@D)" >> $@ + @echo " @cp \$$< \$$@" >> $@ + @echo >> $@ + @echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@ + @echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@ + @echo "$*-images-htmlhelp: \$$(addprefix \$$(HTMLHELPDIR)/$*/, \$$($*-images-html))" >> $@ + +ifdef OUTPUTDIR +ifneq ($(MAKECMDGOALS),clobber) +-include $(addsuffix .d,$(MAIN_DOCS)) +endif +endif + +# Adobe PDF files +%.pdf: %.tex %.ind latexfigures %-images-latex-png %-images-latex-pdf + -$(PDFLATEX) $< + -$(PDFLATEX) $< + -$(PDFLATEX) $< + -$(PDFLATEX) $< + $(THUMBPDF) --quiet $*.pdf + -$(PDFLATEX) $< + +# DVI files +$(DVIDIR)/%.dvi: %.dvi + @mkdir -p $(@D) + cp $< $@ + +%.dvi: %.tex %.idx %-images-latex-eps + -$(LATEX) $< + +%.eps: %.svg + $(INKSCAPE) -z -f $< --export-eps=$@ + +%.png: %.svg + $(INKSCAPE) -z -f $< --export-png=$@ + +#%.pdf: %.svg +# $(INKSCAPE) -z -f $< --export-pdf=$@ + +%.pdf: %.eps + $(EPSTOPDF) $< + +%.eps: %.png + $(PNGTOPNM) $< | $(PNMTOPS) > $@ + +# PostScript files +$(PSDIR)/%.ps: $(DVIDIR)/%.dvi + @mkdir -p $(@D) + $(DVIPS) -o $@ $< + +# Fo +$(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml + @mkdir -p $(@D) + $(XSLTPROC) --output $@ xslt/fo.xsl $< + +# PDF thru Fo +$(FOPDFDIR)/%.pdf: $(FODIR)/%.fo + @mkdir -p $(@D) + JAVA_OPTS=-Xmx250m $(FOP) -q -d $< -pdf $@ + +$(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp + $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \ + --stringparam manifest.in.base.dir "$@/" \ + --stringparam base.dir "$@/" \ + http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $< + +# Plucker docs +$(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html + @mkdir -p $(@D) + $(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$< + +# Texinfo docs +$(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml + @mkdir -p $(@D) + cd $(@D) && $(DB2TEXI) $(shell pwd)/$< + +$(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi + $(MAKEINFO) --no-validate --force -o $@ "$<" + +# Manpages +$(MANPAGEDIR3)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml + +$(SMBDOTCONFDOC)/parameters.all.xml: $(wildcard $(SMBDOTCONFDOC)/*/*.xml) $(SMBDOTCONFDOC)/generate-file-list.sh + $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@ + +$(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl + @echo "Generating list of global smb.conf options" + $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $< + +$(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl + @echo "Generating list of share-mode smb.conf options" + $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $< + +$(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl + @mkdir -p $(@D) + $(XSLTPROC) --output $@ xslt/man.xsl $< + +# Individual smb.conf parameters +smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml)) + +$(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml + @mkdir -p $(@D) + $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $< + +# Pearson compatible XML +$(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl + @mkdir -p $(@D) + $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $< + +$(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml + @mkdir -p $(@D) + -$(XMLLINT) --valid --noout $< 2> $@ + +# Validation verification +%-validate: %/index.xml + cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F) + +# Find undocumented parameters +undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl + $(PERL) scripts/find_missing_doc.pl $(SRCDIR) + $(PERL) scripts/find_missing_manpages.pl $(SRCDIR) + +samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl + @mkdir -p $(EXAMPLESDIR) + $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README + for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done + +# Archiving +archive: pdf + @mkdir -p $(ARCHIVEDIR) + cp $(PDFDIR)/Samba3-HOWTO.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf + cp $(PDFDIR)/Samba3-ByExample.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf + +# XSL scripts +xslt/html.xsl: xslt/html-common.xsl +xslt/html-chunk.xsl: xslt/html-common.xsl +xslt/latex.xsl: +xslt/expand-sambadoc.xsl: +xslt/generate-attributions.xsl: +xslt/man.xsl: +xslt/pearson.xsl: + +distclean clobber: clean + rm Makefile.settings config.status config.log configure + rm -rf autom4te.cache + + +# Always keep intermediate files if we can +.SECONDARY: +.PHONY: clean clobber archive release everything all $(TARGETS) latexfigures + |