samba-tool: add -v to domain --verbose
[kai/samba-autobuild/.git] / docs-xml / Makefile
index 1e4121053d871132a19f777eaeb25197068d23a3..ba49eae06c28e28310a307dc556dd56a21db7849 100644 (file)
@@ -6,28 +6,29 @@
 #              Jelmer Vernooij <jelmer@samba.org>
 include Makefile.settings
 
+export XML_CATALOG_FILES := $(XML_CATALOG_FILES) /etc/xml/catalog  $(shell pwd)/build/catalog.xml
+
 # Docs to build
 MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
-MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml)
-export TEXINPUTS=xslt/latex:.:
+MANPAGES = $(sort $(wildcard $(MANPAGEDIR)/*.?.xml))
 
 # 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))
+MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES))
+DBLATEX_OPTIONS = -p xslt/latex.xsl -i xslt/latex
 
 DATETIME := $(shell date +%Y%m%d%H%M%S)
 
+XSLTPROC_DEPS = build/catalog.xml build/DTD/samba.build.version
+
 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
 
@@ -36,99 +37,99 @@ help:
        @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 " pdf,tex,ps,manpages,txt,pearson,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 " htmlman - Build HTML version of manpages"
        @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
+$(PDFDIR)/Samba3-ByExample.pdf $(PSDIR)/Samba3-ByExample.ps $(DOCBOOKDIR)/Samba3-ByExample.xml Samba3-ByExample.tex: $(wildcard Samba3-ByExample/*.xml)
+$(PDFDIR)/Samba3-HOWTO.pdf $(PSDIR)/Samba3-HOWTO.ps Samba3-HOWTO.tex $(DOCBOOKDIR)/Samba3-HOWTO.xml: $(wildcard Samba3-HOWTO/*.xml) Samba3-HOWTO-attributions.xml
+Samba3-HOWTO/manpages.xml: $(MANPAGEDIR)/smb.conf.5.xml
+$(PDFDIR)/Samba3-Developers-Guide.pdf $(PSDIR)/Samba3-Developers-Guide.ps $(DOCBOOKDIR)/Samba3-Developers-Guide.xml Samba3-Developers-Guide.tex: $(wildcard Samba3-Developers-Guide/*.xml) Samba3-Developers-Guide-attributions.xml
 
 # Pseudo targets 
-all: $(TARGETS)
-everything: manpages3 pdf html-single html htmlman3 txt ps fo htmlhelp pearson 
-release: manpages3 htmlman3 html pdf 
-clean:
+all:: $(TARGETS)
+everything:: manpages pdf html-single html htmlman txt ps fo htmlhelp pearson
+release:: manpages htmlman html pdf
+clean::
        @echo "Cleaning up..." 
        rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
+       rm -f *-attributions.xml
        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
+                       $(patsubst %.svg,%.eps,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg))) \
+                       $(patsubst %.svg,%.png,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg)))
+       rm -f *-attributions.xml *.d *.tpt *.tex *.loc *.toc *.lof *.glo *.idx *.aux
        rm -f *-images-html*
-       rm -f *-images-latex-* latexfigures
+       rm -f *-images-latex-* $(LATEX_FIGURES)
        rm -f xslt/figures/*pdf
        rm -f $(SMBDOTCONFDOC)/parameters.*.xml
-       rm -f $(addsuffix .*,$(MAIN_DOCS))
+       rm -f build/catalog.xml
 
 # 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))
+pdf:: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
+ps:: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS))
+txt:: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS))
+tex:: $(addsuffix .tex,$(MAIN_DOCS))
+texi:: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
+texiinfo:: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
+manpages:: $(patsubst $(MANPAGEDIR)/%.xml,$(OUTPUTDIR)/manpages/%,$(MANPAGES))
+pearson:: $(PEARSONDIR)/Samba3-HOWTO.xml
+pearson-verify:: $(PEARSONDIR)/Samba3-HOWTO.report.html
+plucker:: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
+htmlman:: $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/manpages/%.html,$(MANPAGES)) $(HTMLDIR)/manpages/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))
+
+test:: validate
+check:: validate
+
+.PHONY: test check validate manpages
 
 # Intermediate docbook docs
 #
-$(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
+$(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl $(XSLTPROC_DEPS)
        @echo "Converting Samba-specific tags for $*..."
        @mkdir -p $(@D)
-       $(XSLTPROC) --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
+       @$(XSLTPROC) --stringparam latex.imagebasedir "$*/"  --stringparam noreference 0  --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 
-$(DOCBOOKDIR)/manpages-3/%.xml: $(MANPAGEDIR3)/%.xml xslt/expand-sambadoc.xsl
+$(DOCBOOKDIR)/manpages/%.xml: $(MANPAGEDIR)/%.xml xslt/expand-sambadoc.xsl Makefile.settings $(XSLTPROC_DEPS)
        @mkdir -p $(@D)
-       $(XSLTPROC) --xinclude --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
+       $(XSLTPROC) --xinclude --stringparam noreference 0 --output $@ xslt/expand-sambadoc.xsl $<
 
-$(DOCBOOKDIR)/manpages-3/index.xml: $(MANPAGES3) xslt/manpage-summary.xsl
+$(DOCBOOKDIR)/manpages/index.xml: $(MANPAGES) xslt/manpage-summary.xsl $(XSLTPROC_DEPS)
        @mkdir -p $(@D)
        echo "<article><variablelist>" > $@
-       $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@
+       $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES) >> $@
        @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
+
+$(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks $(XSLTPROC_DEPS)
        @mkdir -p $(@D)
        $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
 
 # Single large HTML files
-$(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
+$(OUTPUTDIR)/%/samba.css: xslt/html/samba.css $(XSLTPROC_DEPS)
        @mkdir -p $(@D)
        cp $< $@
 
 $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single
 
-$(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl 
+$(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl $(XSLTPROC_DEPS)
        $(XSLTPROC) --output $@ xslt/html.xsl $<
 
 # Attributions
-%-attributions.xml: 
+%-attributions.xml: $(XSLTPROC_DEPS)
        @echo "Generating attributions file $@ from $*/"
        @cp -f templates/attributions.xml $@
-       $(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml 
+       @$(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml 
 
 # Text files
 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
@@ -139,25 +140,12 @@ $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
 %.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) $<
+       @$(DBLATEX) $(DBLATEX_OPTIONS) -t tex -o $@ $<
 
 # Dependency files
-%.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl
+%.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl $(XSLTPROC_DEPS)
        @echo "Generating dependency file for $*" 
-       $(XSLTPROC) \
-               --novalid \
+       @$(XSLTPROC) --novalid \
                --stringparam txtbasedir "$(TXTDIR)/$*/" \
                --stringparam target "$*" \
                -o $@ xslt/generate-dependencies.xsl $<
@@ -189,54 +177,27 @@ ifneq ($(MAKECMDGOALS),clobber)
 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 $< $@
+# Adobe PDF files  
+$(PDFDIR)/%.pdf: %/index.xml $(PDFDIR) xslt/latex.xsl %-images-latex-png %-images-latex-pdf
+       $(DBLATEX) $(DBLATEX_OPTIONS) -I $*/images -t pdf -o $@ $<
 
-%.dvi: %.tex %.idx %-images-latex-eps
-       -$(LATEX) $< 
+# PostScript files
+$(PSDIR)/%.ps: %/index.xml $(PSDIR) xslt/latex.xsl %-images-latex-eps
+       $(DBLATEX) $(DBLATEX_OPTIONS) -I $*/images -t ps -o $@ $<
 
 %.eps: %.svg
-       $(INKSCAPE) -z -f $< --export-eps=$@
+       $(INKSCAPE) -z -f $(abspath $<) --export-eps=$(abspath $@)
 
 %.png: %.svg
-       $(INKSCAPE) -z -f $< --export-png=$@
-
-#%.pdf: %.svg
-#      $(INKSCAPE) -z -f $< --export-pdf=$@
-
-%.pdf: %.eps
-       $(EPSTOPDF) $<
+       $(INKSCAPE) -z -f $(abspath $<) --export-png=$(abspath $@)
 
 %.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 $@
+%.pdf: %.svg
+       $(INKSCAPE) -z -f $(abspath $<) --export-pdf=$(abspath $@)
 
-$(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
+$(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp $(XSLTPROC_DEPS)
        $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
                                --stringparam manifest.in.base.dir "$@/" \
                                --stringparam base.dir "$@/" \
@@ -256,18 +217,21 @@ $(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
+$(MANPAGEDIR)/smb.conf.5.xml: parameters
+
+# The phony parameters target exists in order to always create the
+# the parameters xml files. Otherwise, when parameters.*.xml does not exist
+# yet, the parameters are not generated when smb.conf.5.xml is newer than
+# any smbdotconf/*/*.xml file ...
+.PHONY: parameters
+
+parameters: $(SMBDOTCONFDOC)/parameters.all.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):
+       test -d $@ || mkdir $@
 
 $(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
        @mkdir -p $(@D)
@@ -275,7 +239,7 @@ $(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml 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 $<
@@ -293,13 +257,11 @@ $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
 %-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)
+build/catalog.xml: build/catalog.xml.in
+       sed -e "s|@abs_top_srcdir@|`pwd`|g;s|@abs_top_builddir@|`pwd`|g" < build/catalog.xml.in > build/catalog.xml
 
 samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
-       @mkdir -p $(EXAMPLESDIR)
+       @mkdir -p examples
        $(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
 
@@ -318,12 +280,14 @@ 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
+distclean clobber:: clean
+       rm -f Makefile.settings config.status config.log
 
+realdistclean:: distclean
+       rm -f configure
+       rm -rf autom4te.cache
+       rm -rf output
 
 # Always keep intermediate files if we can
 .SECONDARY:
-.PHONY: clean clobber archive release everything all $(TARGETS) latexfigures
-
+.PHONY: clean clobber archive release everything all