# Docs to build
MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml)
-MANPAGES4 = $(wildcard $(MANPAGEDIR4)/*.?.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
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: configure.in
- @echo configure not present, trying to generate
- @autoreconf
+configure: configure.ac
+ @echo configure not present, trying to regenerate it...
+ autoreconf
endif
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,manpages{3,4},txt,pearson,fo,htmlhelp - Build specific output format"
+ @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,htmlman4 - Build HTML version of manpages"
+ @echo " htmlman3 - Build HTML version of manpages"
@echo " undocumented - Output list of undocumented smb.conf options"
@echo " samples - Extract examples"
- @echo " files - Extract other files"
$(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
# Pseudo targets
all: $(TARGETS)
-everything: manpages3 manpages4 pdf html-single html htmlman3 htmlman4 txt ps fo htmlhelp pearson
+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))
texi: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
texiinfo: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
manpages3: $(patsubst $(MANPAGEDIR3)/%.xml,$(OUTPUTDIR)/manpages-3/%,$(MANPAGES3))
-manpages4: $(patsubst $(MANPAGEDIR4)/%.xml,$(OUTPUTDIR)/manpages-4/%,$(MANPAGES4))
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
-htmlman4: $(patsubst $(MANPAGEDIR4)/%.xml,$(HTMLDIR)/manpages-4/%.html,$(MANPAGES4)) $(HTMLDIR)/manpages-4/index.html
html-single: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
html: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
htmlhelp: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS))
# Intermediate docbook docs
#
$(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
- mkdir -p $(@D)
+ @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 latex.imagebasedir "$*/" --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
-
-$(DOCBOOKDIR)/manpages-4/%.xml: $(MANPAGEDIR4)/%.xml xslt/expand-sambadoc.xsl
- mkdir -p $(@D)
- $(XSLTPROC) --xinclude --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --output $@ 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)
+ @mkdir -p $(@D)
echo "<article><variablelist>" > $@
$(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@
- echo "</variablelist></article>" >> $@
-
-$(DOCBOOKDIR)/manpages-4/index.xml: $(MANPAGES4) xslt/manpage-summary.xsl
- mkdir -p $(@D)
- echo "<article><variablelist>" > $@
- $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES4) >> $@
- echo "</variablelist></article>" >> $@
-
+ @echo "</variablelist></article>" >> $@
# HTML docs
$(HTMLDIR)/index.html: htmldocs.html
- mkdir -p $(@D)
+ @mkdir -p $(@D)
cp $< $@
$(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks
- mkdir -p $(@D)
+ @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)
+ @mkdir -p $(@D)
cp $< $@
$(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single
# 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)
+ @mkdir -p $(@D)
$(HTML2TEXT) -nobs -style pretty -o $@ $<
# Tex files
-%.tex: $(DOCBOOKDIR)/%.xml xslt/latex.xsl
- mkdir -p $(@D)
- $(XSLTPROC) --output $@ xslt/latex.xsl $<
+%.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)
+ @mkdir -p $(@D)
cp $< $@
%.idx: %.tex latexfigures
# 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-png: \$$(addsuffix .png, \$$($*-images-latex))" >> $@
- @echo >> $@
+ @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 " @mkdir -p \$$(@D)" >> $@
+ @echo " @cp \$$< \$$@" >> $@
@echo >> $@
@echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@
- @echo " mkdir -p \$$(@D)" >> $@
- @echo " cp \$$< \$$@" >> $@
+ @echo " @mkdir -p \$$(@D)" >> $@
+ @echo " @cp \$$< \$$@" >> $@
@echo >> $@
@echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@
- @echo " mkdir -p \$$(@D)" >> $@
- @echo " cp \$$< \$$@" >> $@
+ @echo " @mkdir -p \$$(@D)" >> $@
+ @echo " @cp \$$< \$$@" >> $@
@echo >> $@
@echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@
@echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@
ifdef OUTPUTDIR
ifneq ($(MAKECMDGOALS),clobber)
-include $(addsuffix .d,$(MAIN_DOCS))
+-include $(addsuffix .d,$(MAIN_DOCS))
endif
endif
# Adobe PDF files
-%.pdf: %.tex %.ind latexfigures %-images-latex-png
+%.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)
+ @mkdir -p $(@D)
cp $< $@
%.dvi: %.tex %.idx %-images-latex-eps
-$(LATEX) $<
-%.png: %.dia
- $(DIA) -e $@ $<
+%.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)
+ @mkdir -p $(@D)
$(DVIPS) -o $@ $<
-xslt/figures/%.pdf: xslt/figures/%.eps
- $(EPSTOPDF) $<
-
# Fo
$(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml
- mkdir -p $(@D)
+ @mkdir -p $(@D)
$(XSLTPROC) --output $@ xslt/fo.xsl $<
# PDF thru Fo
$(FOPDFDIR)/%.pdf: $(FODIR)/%.fo
- mkdir -p $(@D)
+ @mkdir -p $(@D)
JAVA_OPTS=-Xmx250m $(FOP) -q -d $< -pdf $@
$(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
# Plucker docs
$(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
- mkdir -p $(@D)
+ @mkdir -p $(@D)
$(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$<
# Texinfo docs
$(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml
- mkdir -p $(@D)
+ @mkdir -p $(@D)
cd $(@D) && $(DB2TEXI) $(shell pwd)/$<
$(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi
$(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)
+ @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)
+ @mkdir -p $(@D)
$(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
# Pearson compatible XML
$(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
- mkdir -p $(@D)
+ @mkdir -p $(@D)
$(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
$(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
- mkdir -p $(@D)
+ @mkdir -p $(@D)
-$(XMLLINT) --valid --noout $< 2> $@
# Validation verification
# 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)
-
-# Examples and the like
-files: Samba3-HOWTO/index.xml xslt/extract-smbfiles.xsl
- $(XSLTPROC) xslt/extract-smbfiles.xsl $< > /dev/null
+ $(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)
+ @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)
+ @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 settings.xsl
-xslt/html-chunk.xsl: xslt/html-common.xsl settings.xsl
-xslt/latex.xsl: settings.xsl
-xslt/expand-sambadoc.xsl: settings.xsl
+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:
-clobber: clean
- rm Makefile.settings settings.xsl config.status config.log configure
+distclean clobber: clean
+ rm Makefile.settings config.status config.log configure
+ rm -rf autom4te.cache
-clean:
- rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
- 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))
# Always keep intermediate files if we can
.SECONDARY:
.PHONY: clean clobber archive release everything all $(TARGETS) latexfigures
+
git.samba.org / import / samba-docs-svnimport.git / blobdiff