Docs: Remove some ntdb references
[bbaumbach/samba-autobuild/.git] / docs-xml / Makefile
index f176d5aac8bb62b7711c9312e52e7b2548016b9f..d9ae92b4941577efb16762efbd32813c24e4edd2 100644 (file)
@@ -8,10 +8,10 @@ include Makefile.settings
 
 # Docs to build
 MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
-MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml)
+MANPAGES = $(wildcard $(MANPAGEDIR)/*.?.xml)
 
 # Lists of files to process
-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)
@@ -33,26 +33,25 @@ 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,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 
+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))) \
@@ -62,24 +61,20 @@ clean::
        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))
 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))
+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 $(MANPAGEDIR3)/%.xml,$(HTMLDIR)/manpages-3/%.html,$(MANPAGES3)) $(HTMLDIR)/manpages-3/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))
@@ -88,7 +83,7 @@ validate:: $(addsuffix -validate,$(MAIN_DOCS))
 test:: validate
 check:: validate
 
-.PHONY: test check validate
+.PHONY: test check validate manpages
 
 # Intermediate docbook docs
 #
@@ -97,21 +92,21 @@ $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
        @mkdir -p $(@D)
        @$(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
        @mkdir -p $(@D)
        $(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
        @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
        @mkdir -p $(@D)
        $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
@@ -143,10 +138,6 @@ $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
        @mkdir -p $(@D)
        @$(DBLATEX) $(DBLATEX_OPTIONS) -t tex -o $@ $<
 
-$(PDFDIR)/%.pdf: %.pdf
-       @mkdir -p $(@D)
-       cp $< $@
-
 # Dependency files
 %.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl
        @echo "Generating dependency file for $*" 
@@ -183,37 +174,24 @@ endif
 endif
 
 # Adobe PDF files  
-%.pdf: %/index.xml xslt/latex.xsl %-images-latex-png %-images-latex-pdf
+$(PDFDIR)/%.pdf: %/index.xml $(PDFDIR) xslt/latex.xsl %-images-latex-png %-images-latex-pdf
        $(DBLATEX) $(DBLATEX_OPTIONS) -I $*/images -t pdf -o $@ $<
 
 # PostScript files
-%.ps: %/index.xml xslt/latex.xsl %-images-latex-eps
+$(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) > $@
 
-# 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
        $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
@@ -235,18 +213,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)
@@ -254,7 +235,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 $<
@@ -272,11 +253,6 @@ $(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)
-
 samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
        @mkdir -p examples
        $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
@@ -303,6 +279,7 @@ distclean clobber:: clean
 realdistclean:: distclean
        rm -f configure
        rm -rf autom4te.cache
+       rm -rf output
 
 # Always keep intermediate files if we can
 .SECONDARY: