chiark / gitweb /
Document the existence of "hints" that release managers can use
[developers-reference.git] / Makefile
1 # Makefile, used for the developers-reference in DocBook XML
2
3 # Note: This Makefile should work perfectly without the debian/ directory.
4
5 SOURCES         := $(wildcard *.dbk) common.ent version.ent
6
7 FORMATS         := html txt pdf
8 LANGS           := de fr ja
9 TARGETS         := $(foreach fmt,$(FORMATS),developers-reference.$(fmt)) \
10                    $(foreach lng,$(LANGS), \
11                        $(foreach fmt,$(FORMATS), \
12                            $(lng)/developers-reference.$(fmt)))
13 # list of targets, that currently cannot build
14 #BLACKLIST      := ja/developers-reference.pdf
15
16 # hopefully overwritten by caller, e.g. debian/rules
17 VERSION=unknown
18 PUBDATE=unknown
19
20 # programs for creating output
21 XP=xsltproc --nonet --novalid --xinclude
22 XL=xmllint --nonet --noout --postvalid --xinclude
23 # dblatex 0.2.8 has some problems (e.g. #465221 and Japanese does
24 # not build)
25 # Alternatives:
26 # - docbook2pdf (seems to die on UTF-8, #431085); and
27 # - fop is currently in contrib, but can go to main, see #366783
28 # - xmlroff (not mature enough, #182445)
29 DBLATEX=dblatex --style=db2latex
30 TRANSLATE=po4a po4a/po4a.cfg
31
32 # XSL files and parameters
33 # note: the URL is used as identifier, no HTTP is used!
34 DOCBOOK_XSL=http://docbook.sourceforge.net/release/xsl/current
35 # for HTML output
36 DBK2HTML=$(CURDIR)/html.xsl
37 # all in one file for text output
38 DBK2HTML1=$(CURDIR)/txt.xsl
39
40 .PHONY: all
41 all:    $(filter-out $(BLACKLIST), $(TARGETS))
42
43 .PHONY: validate
44 validate:                       $(SOURCES)
45         $(XL) index.dbk
46
47 %/validate:                     $(addprefix %/,$(SOURCES))
48         cd $(@D) && $(XL) index.dbk
49
50 # This rule controls the build and installation on the website
51 # Logs are here: http://www-master.debian.org/build-logs/ddp/
52 .PHONY: publish
53 publish:        all
54         [ -d $(PUBLISHDIR) ] || exit 1
55         install -d -m 755 $(PUBLISHDIR)/developers-reference
56         rm -f $(PUBLISHDIR)/developers-reference/*.html
57         rm -f en && ln -sf . en
58         $(foreach format,$(FORMATS),$(foreach lang,en $(LANGS),for file in $(lang)/*.$(format); do if [ -e "$$file" ]; then cp --preserve=timestamps $$file $(PUBLISHDIR)/developers-reference/$$(basename $$file .$(format)).$(lang).$(format); fi; done;))
59         ln -sf index.en.html $(PUBLISHDIR)/developers-reference/index.html
60         ln -sf developers-reference.en.pdf $(PUBLISHDIR)/developers-reference/developers-reference.pdf
61         ln -sf developers-reference.en.txt $(PUBLISHDIR)/developers-reference/developers-reference.txt
62
63 .PHONY: developers-reference.html %/developers-reference.html
64 developers-reference.html:      $(CURDIR)/index.html
65 %/developers-reference.html:    $(addprefix %/,index.html)
66         @true
67
68 .PRECIOUS:                      %/index.html
69 index.html:                     $(CURDIR)/developers-reference.html
70 %/index.html:                   $(addprefix %/,$(SOURCES))
71         cd $(@D) && $(XP) $(DBK2HTML) index.dbk
72
73 # There must be an easier way than recursive make!
74 .PRECIOUS:              %.dbk %.ent
75 ifndef LINGUA
76 %.dbk %.ent: FORCE
77         $(TRANSLATE)
78         $(MAKE) $@ LINGUA=`basename $(@D)`
79
80 FORCE:
81 else
82 $(LINGUA)/%.dbk:        %.dbk po4a/$(LINGUA).po
83         $(TRANSLATE)
84
85 $(LINGUA)/common.ent:   common.ent
86         cd $(@D) && ln -sf ../$(@F) .
87 endif
88
89 developers-reference.txt:       $(CURDIR)/developers-reference.txt
90 %/developers-reference.txt:     $(addprefix %/,$(SOURCES))
91         $(XP) $(DBK2HTML1) $(@D)/index.dbk \
92             | LC_ALL=C.UTF-8 w3m -o display_charset=UTF-8 -cols 70 -dump -no-graph -T text/html > $@
93
94 XSLT            := xslt
95
96 developers-reference.pdf:       $(CURDIR)/developers-reference.pdf
97 %/developers-reference.pdf:     $(addprefix %/,$(SOURCES))
98         $(DBLATEX) $(@D)/index.dbk \
99             --backend=xetex \
100             --xsl-user=$(XSLT)/user_param.xsl \
101             --xsl-user=$(XSLT)/xetex_param.xsl \
102             --param=lingua=$(@D) \
103             && mv $(@D)/index.dbk.pdf $@
104
105 .PHONY: pot
106 pot:                                    po4a/po/developers-reference.pot
107 po4a/po/developers-reference.pot:       %.dbk
108         $(TRANSLATE)
109
110 ifdef LINGUA
111 .PHONY: updatepo
112 updatepo:                       po4a/po/$(LINGUA).po
113 po4a/po/$(LINGUA).po:           %.dbk
114         $(TRANSLATE)
115 endif
116
117 tidypo:
118         for po in po4a/po/*.po; do \
119             msgcat -o $$po $$po; \
120         done
121
122 checkpo:
123         @for po in po4a/po/*.po; do \
124             msgfmt -vv $$po; \
125         done
126
127 %/version.ent:
128         echo '<!ENTITY version "$(VERSION)">' >  $@
129         echo '<!ENTITY pubdate "$(PUBDATE)">' >> $@
130
131 .PHONY: clean
132 clean:
133         rm -f *.fo *.html *.pdf *.txt
134         for L in $(LANGS); do rm -rf `basename ./"$$L"/`; done
135         rm -f version.ent
136         rm -f `find . -name "*~" -o -name "*.bak"`
137         rm -f *~ *.bak .#* core
138
139 .PHONY: distclean
140 distclean: clean
141         rm -f *.rej *.orig
142
143 # if rule bomb out, delete the target
144 .DELETE_ON_ERROR: