samba-tool: add -v to domain --verbose
[kai/samba-autobuild/.git] / docs-xml / Makefile
index 30703764177a92eef69df3c7f745129fa180d5c5..ba49eae06c28e28310a307dc556dd56a21db7849 100644 (file)
@@ -6,9 +6,11 @@
 #              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))
-MANPAGES = $(wildcard $(MANPAGEDIR)/*.?.xml)
+MANPAGES = $(sort $(wildcard $(MANPAGEDIR)/*.?.xml))
 
 # Lists of files to process
 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES))
@@ -16,6 +18,8 @@ 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
@@ -36,8 +40,7 @@ help:
        @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"
 
 $(PDFDIR)/Samba3-ByExample.pdf $(PSDIR)/Samba3-ByExample.ps $(DOCBOOKDIR)/Samba3-ByExample.xml Samba3-ByExample.tex: $(wildcard Samba3-ByExample/*.xml)
@@ -47,8 +50,8 @@ $(PDFDIR)/Samba3-Developers-Guide.pdf $(PSDIR)/Samba3-Developers-Guide.ps $(DOCB
 
 # Pseudo targets 
 all:: $(TARGETS)
-everything:: manpages pdf html-single html htmlman3 txt ps fo htmlhelp pearson 
-release:: manpages htmlman3 html pdf 
+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)
@@ -75,7 +78,7 @@ 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))
-htmlman3:: $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/manpages/%.html,$(MANPAGES)) $(HTMLDIR)/manpages/index.html
+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))
@@ -84,20 +87,20 @@ validate:: $(addsuffix -validate,$(MAIN_DOCS))
 test:: validate
 check:: validate
 
-.PHONY: test 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 0  --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 
-$(DOCBOOKDIR)/manpages/%.xml: $(MANPAGEDIR)/%.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 0 --output $@ xslt/expand-sambadoc.xsl $<
 
-$(DOCBOOKDIR)/manpages/index.xml: $(MANPAGES) 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 $(MANPAGES) >> $@
@@ -108,22 +111,22 @@ $(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 
@@ -140,7 +143,7 @@ $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
        @$(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 \
                --stringparam txtbasedir "$(TXTDIR)/$*/" \
@@ -191,7 +194,10 @@ $(PSDIR)/%.ps: %/index.xml $(PSDIR) xslt/latex.xsl %-images-latex-eps
 %.eps: %.png
        $(PNGTOPNM) $< | $(PNMTOPS) > $@
 
-$(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
+%.pdf: %.svg
+       $(INKSCAPE) -z -f $(abspath $<) --export-pdf=$(abspath $@)
+
+$(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp $(XSLTPROC_DEPS)
        $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
                                --stringparam manifest.in.base.dir "$@/" \
                                --stringparam base.dir "$@/" \
@@ -219,19 +225,11 @@ $(MANPAGEDIR)/smb.conf.5.xml: parameters
 # any smbdotconf/*/*.xml file ...
 .PHONY: parameters
 
-parameters: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
+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 $@
 
@@ -259,10 +257,8 @@ $(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)/source3
+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 examples