dfc7947c5c58dd69d51c7b3538ce6e8377a925d4
[ira/wip.git] / docs-xml / Makefile
1 #################################################################
2 # Makefile for Samba Documentation
3 # Authors:      
4 #               James Moore <jmoore@php.net>
5 #               Gerald Carter <jerry@samba.org>
6 #               Jelmer Vernooij <jelmer@samba.org>
7 include Makefile.settings
8
9 # Docs to build
10 MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
11 MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml)
12 export TEXINPUTS=xslt/latex:.:
13
14 # Lists of files to process
15 LATEX_FIGURES = xslt/figures/caution.pdf xslt/figures/important.pdf xslt/figures/note.pdf xslt/figures/tip.pdf xslt/figures/warning.pdf
16 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR3)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES3))
17
18 DATETIME := $(shell date +%Y%m%d%H%M%S)
19
20 ifeq ($(PROFILE), Y)
21 XSLTPROC += --profile --load-trace --timing
22 endif
23
24 ifndef OUTPUTDIR
25 Makefile.settings: configure
26         @echo Makefile.settings not present, trying to run configure...
27         ./configure
28
29 configure: configure.ac
30         @echo configure not present, trying to regenerate it...
31         autoreconf
32 endif
33
34 help: 
35         @echo "Supported make targets:"
36         @echo " release - Build the docs needed for a Samba release"
37         @echo " all - Build all docs that can be build using the utilities found by configure"
38         @echo " everything - Build all of the above"
39         @echo " pdf,tex,dvi,ps,manpages3,txt,pearson,fo,htmlhelp - Build specific output format"
40         @echo " html - Build multi-file HTML versions"
41         @echo " html-single - Build single-file HTML versions"
42         @echo " htmlman3 - Build HTML version of manpages"
43         @echo " undocumented - Output list of undocumented smb.conf options"
44         @echo " samples - Extract examples"
45
46 $(DOCBOOKDIR)/Samba3-ByExample.xml: $(filter-out Samba3-ByExample/index.xml,$(wildcard Samba3-ByExample/*.xml))
47 $(DOCBOOKDIR)/Samba3-HOWTO.xml: $(filter-out Samba3-HOWTO/index.xml,$(wildcard Samba3-HOWTO/*.xml)) Samba3-HOWTO-attributions.xml
48 Samba3-HOWTO/manpages.xml: $(MANPAGEDIR3)/smb.conf.5.xml
49 $(DOCBOOKDIR)/Samba3-Developers-Guide.xml: $(filter-out Samba3-Developers-Guide/index.xml,$(wildcard Samba3-Developers-Guide/*.xml)) Samba3-Developers-Guide-attributions.xml
50 $(DOCBOOKDIR)/Samba4-HOWTO.xml: $(filter-out Samba4-HOWTO/index.xml,$(wildcard Samba4-HOWTO/*.xml)) Samba4-HOWTO-attributions.xml
51
52 # Pseudo targets 
53 all:: $(TARGETS)
54 everything:: manpages3 pdf html-single html htmlman3 txt ps fo htmlhelp pearson 
55 release:: manpages3 htmlman3 html pdf 
56 clean::
57         @echo "Cleaning up..." 
58         rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
59         rm -f $(patsubst %.svg,%.png,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-dia))) \
60                         $(patsubst %.svg,%.pdf,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg))) \
61                         $(patsubst %.svg,%.eps,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg))) \
62                         $(patsubst %.svg,%.png,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg)))
63         rm -f *-attributions.xml *.d *.tpt *.tex *.loc *.toc *.lof *.glo *.idx *.aux
64         rm -f *-images-html*
65         rm -f *-images-latex-* $(LATEX_FIGURES)
66         rm -f xslt/figures/*pdf
67         rm -f $(SMBDOTCONFDOC)/parameters.*.xml
68         rm -f $(addsuffix .*,$(MAIN_DOCS))
69
70 # Output format targets
71 pdf:: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
72 dvi:: $(patsubst %,$(DVIDIR)/%.dvi,$(MAIN_DOCS))
73 ps:: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS))
74 txt:: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS))
75 txt-chunks:: $(addsuffix -txt-chunks,$(MAIN_DOCS))
76 fo:: $(patsubst %,$(FODIR)/%.fo,$(MAIN_DOCS))
77 fo-pdf:: $(patsubst %,$(FOPDFDIR)/%.pdf,$(MAIN_DOCS))
78 tex:: $(addsuffix .tex,$(MAIN_DOCS))
79 texi:: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
80 texiinfo:: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
81 manpages3:: $(patsubst $(MANPAGEDIR3)/%.xml,$(OUTPUTDIR)/manpages-3/%,$(MANPAGES3))
82 pearson:: $(PEARSONDIR)/Samba3-HOWTO.xml
83 pearson-verify:: $(PEARSONDIR)/Samba3-HOWTO.report.html
84 plucker:: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
85 htmlman3:: $(patsubst $(MANPAGEDIR3)/%.xml,$(HTMLDIR)/manpages-3/%.html,$(MANPAGES3)) $(HTMLDIR)/manpages-3/index.html
86 html-single:: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
87 html:: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
88 htmlhelp:: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS))
89 validate:: $(addsuffix -validate,$(MAIN_DOCS))
90
91 test:: validate
92 check:: validate
93
94 .PHONY: test check validate
95
96 # Intermediate docbook docs
97 #
98 $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
99         @echo "Converting Samba-specific tags for $*..."
100         @mkdir -p $(@D)
101         @$(XSLTPROC) --stringparam latex.imagebasedir "$*/"  --stringparam noreference 0  --xinclude --output $@ xslt/expand-sambadoc.xsl $<
102
103 $(DOCBOOKDIR)/manpages-3/%.xml: $(MANPAGEDIR3)/%.xml xslt/expand-sambadoc.xsl
104         @mkdir -p $(@D)
105         $(XSLTPROC) --xinclude --stringparam noreference 0 --output $@ xslt/expand-sambadoc.xsl $<
106
107 $(DOCBOOKDIR)/manpages-3/index.xml: $(MANPAGES3) xslt/manpage-summary.xsl
108         @mkdir -p $(@D)
109         echo "<article><variablelist>" > $@
110         $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@
111         @echo "</variablelist></article>" >> $@
112
113 # HTML docs
114 $(HTMLDIR)/index.html: htmldocs.html
115         @mkdir -p $(@D)
116         cp $< $@
117         
118 $(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks
119         @mkdir -p $(@D)
120         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
121
122 # Single large HTML files
123 $(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
124         @mkdir -p $(@D)
125         cp $< $@
126
127 $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single
128
129 $(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl 
130         $(XSLTPROC) --output $@ xslt/html.xsl $<
131
132 # Attributions
133 %-attributions.xml: 
134         @echo "Generating attributions file $@ from $*/"
135         @cp -f templates/attributions.xml $@
136         @$(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml 
137
138 # Text files
139 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
140         @mkdir -p $(@D)
141         $(HTML2TEXT) -nobs -style pretty -o $@ $<
142
143 # Tex files
144 %.tex: %/index.xml xslt/latex.xsl
145         @echo "Generating $@..."
146         @mkdir -p $(@D)
147         @$(XSLTPROC) $(DB2LATEX_ARGS) --stringparam latex.imagebasedir "$*/" --xinclude --output $@ xslt/latex.xsl $<
148
149 $(PDFDIR)/%.pdf: %.pdf
150         @mkdir -p $(@D)
151         cp $< $@
152
153 %.idx: %.tex $(LATEX_FIGURES)
154         -$(PDFLATEX) $<
155
156 %.ind: %.idx
157         $(MAKEINDEX) $<
158
159 # Dependency files
160 %.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl
161         @echo "Generating dependency file for $*" 
162         @$(XSLTPROC) --novalid \
163                 --stringparam txtbasedir "$(TXTDIR)/$*/" \
164                 --stringparam target "$*" \
165                 -o $@ xslt/generate-dependencies.xsl $<
166         @echo "$*-images-latex-svg = \$$(wildcard \$$(addsuffix .svg, \$$($*-images-latex)))" >> $@
167         @echo "$*-images-latex-eps: \$$(addsuffix .eps, \$$($*-images-latex))" >> $@
168         @echo "$*-images-latex-pdf: \$$(patsubst %.svg, %.pdf, \$$($*-images-latex-svg))" >> $@
169         @echo "$*-images-latex-png: \$$(filter-out \$$(patsubst %.svg,%.png,\$$($*-images-latex-svg)), \$$(addsuffix .png, \$$($*-images-latex)))" >> $@
170
171         @echo >> $@
172         @echo "\$$(HTMLDIR)/%: $*/%" >> $@
173         @echo " @mkdir -p \$$(@D)" >> $@
174         @echo " @cp \$$< \$$@" >> $@
175         @echo >> $@
176         @echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@
177         @echo " @mkdir -p \$$(@D)" >> $@
178         @echo " @cp \$$< \$$@" >> $@
179         @echo >> $@
180         @echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@
181         @echo " @mkdir -p \$$(@D)" >> $@
182         @echo " @cp \$$< \$$@" >> $@
183         @echo >> $@
184         @echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@
185         @echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@
186         @echo "$*-images-htmlhelp: \$$(addprefix \$$(HTMLHELPDIR)/$*/, \$$($*-images-html))" >> $@
187
188 ifdef OUTPUTDIR 
189 ifneq ($(MAKECMDGOALS),clobber)
190 -include $(addsuffix .d,$(MAIN_DOCS))
191 endif
192 endif
193
194 # Adobe PDF files
195 %.pdf: %.tex %.ind $(LATEX_FIGURES) %-images-latex-png %-images-latex-pdf
196         -$(PDFLATEX) $<
197         -$(PDFLATEX) $<
198         -$(PDFLATEX) $<
199         -$(PDFLATEX) $<
200         $(THUMBPDF) --quiet $*.pdf
201         -$(PDFLATEX) $<
202
203 # DVI files
204 $(DVIDIR)/%.dvi: %.dvi
205         @mkdir -p $(@D)
206         cp $< $@
207
208 %.dvi: %.tex %.idx %-images-latex-eps
209         -$(LATEX) $< 
210
211 %.eps: %.svg
212         $(INKSCAPE) -z -f $< --export-eps=$@
213
214 %.png: %.svg
215         $(INKSCAPE) -z -f $< --export-png=$@
216
217 #%.pdf: %.svg
218 #       $(INKSCAPE) -z -f $< --export-pdf=$@
219
220 %.pdf: %.eps
221         $(EPSTOPDF) $<
222
223 %.eps: %.png
224         $(PNGTOPNM) $< | $(PNMTOPS) > $@
225
226 # PostScript files
227 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
228         @mkdir -p $(@D)
229         $(DVIPS) -o $@ $<
230
231 # Fo
232 $(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml
233         @mkdir -p $(@D)
234         $(XSLTPROC) --output $@ xslt/fo.xsl $<
235
236 # PDF thru Fo
237 $(FOPDFDIR)/%.pdf: $(FODIR)/%.fo
238         @mkdir -p $(@D)
239         JAVA_OPTS=-Xmx250m $(FOP) -q -d $< -pdf $@
240
241 $(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
242         $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
243                                 --stringparam manifest.in.base.dir "$@/" \
244                                 --stringparam base.dir "$@/" \
245         http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
246
247 # Plucker docs
248 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html 
249         @mkdir -p $(@D)
250         $(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$< 
251
252 # Texinfo docs
253 $(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml
254         @mkdir -p $(@D)
255         cd $(@D) && $(DB2TEXI) $(shell pwd)/$<
256
257 $(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi
258         $(MAKEINFO) --no-validate --force -o $@ "$<"
259
260 # Manpages
261 $(MANPAGEDIR3)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
262
263 $(SMBDOTCONFDOC)/parameters.all.xml: $(wildcard $(SMBDOTCONFDOC)/*/*.xml) $(SMBDOTCONFDOC)/generate-file-list.sh
264         $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@
265
266 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
267         @echo "Generating list of global smb.conf options" 
268         $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
269
270 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
271         @echo "Generating list of share-mode smb.conf options" 
272         $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
273
274 $(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
275         @mkdir -p $(@D)
276         $(XSLTPROC) --output $@ xslt/man.xsl $<
277
278 # Individual smb.conf parameters
279 smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml))
280         
281 $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
282         @mkdir -p $(@D)
283         $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
284
285 # Pearson compatible XML
286 $(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
287         @mkdir -p $(@D)
288         $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
289
290 $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
291         @mkdir -p $(@D)
292         -$(XMLLINT) --valid --noout $< 2> $@
293
294 # Validation verification
295 %-validate: %/index.xml
296         cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
297
298 # Find undocumented parameters
299 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl
300         $(PERL) scripts/find_missing_doc.pl $(SRCDIR)
301         $(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
302
303 samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
304         @mkdir -p $(EXAMPLESDIR)
305         $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
306         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
307
308 # Archiving
309 archive: pdf
310         @mkdir -p $(ARCHIVEDIR)
311         cp $(PDFDIR)/Samba3-HOWTO.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf
312         cp $(PDFDIR)/Samba3-ByExample.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf
313
314 # XSL scripts
315 xslt/html.xsl: xslt/html-common.xsl 
316 xslt/html-chunk.xsl: xslt/html-common.xsl 
317 xslt/latex.xsl: 
318 xslt/expand-sambadoc.xsl: 
319 xslt/generate-attributions.xsl: 
320 xslt/man.xsl:
321 xslt/pearson.xsl:
322
323 distclean clobber:: clean
324         rm -f Makefile.settings config.status config.log
325
326 realdistclean:: distclean
327         rm -f configure
328         rm -rf autom4te.cache
329
330
331 # Always keep intermediate files if we can
332 .SECONDARY:
333 .PHONY: clean clobber archive release everything all 
334