]> git.proxmox.com Git - pmg-docs.git/blame - Makefile
images: run png-cleanup.pl on all and verify on install
[pmg-docs.git] / Makefile
CommitLineData
1e94bc81
TL
1include /usr/share/dpkg/pkg-info.mk
2
410dc2c9
DM
3DGDIR=.
4ASCIIDOC_PMG=./asciidoc-pmg
5
b1fa7304 6BUILDDIR ?= $(DEB_SOURCE)-$(DEB_VERSION)
8627268b 7DSC=$(DEB_SOURCE)_$(DEB_VERSION).dsc
b1fa7304 8
410dc2c9
DM
9GEN_PACKAGE=pmg-doc-generator
10DOC_PACKAGE=pmg-docs
11
163affa4 12GEN_DEB=$(GEN_PACKAGE)_$(DEB_VERSION_UPSTREAM_REVISION)_all.deb
ddb9aa33 13DOC_DEB=$(DOC_PACKAGE)_$(DEB_VERSION_UPSTREAM_REVISION)_all.deb
410dc2c9 14
8a328f84 15export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
ddb9aa33 16SOURCE_DATE_HUMAN := $(shell date -d "@$(SOURCE_DATE_EPOCH)")
8a328f84
SI
17
18
410dc2c9
DM
19all: index.html
20
21.PHONY: verify-images
22verify-images: png-verify.pl
23 for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
4af6e955 24 for i in ./images/installer/*.png; do ./png-verify.pl $$i; done
410dc2c9
DM
25
26ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
ddb9aa33 27.pmg-doc-depends link-refs.json: $(ADOC_SOURCES_GUESS) scan-adoc-refs
410dc2c9
DM
28 ./scan-adoc-refs *.adoc --depends .pmg-doc-depends.tmp > link-refs.json.tmp
29 @cmp --quiet .pmg-doc-depends .pmg-doc-depends.tmp || mv .pmg-doc-depends.tmp .pmg-doc-depends
30 @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
31
32pmg-doc-generator.mk: .pmg-doc-depends pmg-doc-generator.mk.in
33 cat pmg-doc-generator.mk.in .pmg-doc-depends > $@.tmp
ddb9aa33 34 sed -i "s/@RELEASE@$$/$(DEB_VERSION_UPSTREAM)/" $@.tmp
410dc2c9
DM
35 mv $@.tmp $@
36
1a8e71a9 37-include ./pmg-doc-generator.mk
410dc2c9
DM
38
39GEN_DEB_SOURCES= \
40 pmg-doc-generator.mk \
ddb9aa33 41 $(MANUAL_SOURCES) \
410dc2c9
DM
42 docinfo.xml
43
f872534d 44GEN_SCRIPTS= \
42117962 45 gen-cluster.conf.5-opts.pl \
c9fa2593
DM
46 gen-fetchmail.conf.5-opts.pl \
47 gen-ldap.conf.5-opts.pl \
48 gen-pmg.conf.5-opts.pl \
49 gen-user.conf.5-opts.pl
410dc2c9 50
4413eb71
DC
51API_VIEWER_FILES= \
52 api-viewer/apidata.js \
53 api-viewer/PMGAPI.js \
54 /usr/share/javascript/proxmox-widget-toolkit-dev/APIViewer.js
55
410dc2c9
DM
56API_VIEWER_SOURCES= \
57 api-viewer/index.html \
58 api-viewer/apidoc.js
59
60asciidoc-pmg: asciidoc-pmg.in link-refs.json
61 cat asciidoc-pmg.in link-refs.json >asciidoc-pmg.tmp
ddb9aa33 62 sed -e s/@RELEASE@/$(DOCRELEASE)/ -i asciidoc-pmg.tmp
410dc2c9
DM
63 chmod +x asciidoc-pmg.tmp
64 mv asciidoc-pmg.tmp asciidoc-pmg
65
66INDEX_INCLUDES= \
67 pmg-admin-guide.pdf \
68 pmg-admin-guide.epub \
69 chapter-index-table.adoc \
70 man1-index-table.adoc \
71 man5-index-table.adoc \
72 man8-index-table.adoc \
ddb9aa33 73 $(sort $(addsuffix .html, $(MANUAL_PAGES)) $(CHAPTER_LIST))
410dc2c9 74
ddb9aa33 75ADOC_STDARG=-b $(shell pwd)/asciidoc/pmg-html -f asciidoc/asciidoc-pmg.conf -a icons -a data-uri -a "date=$(SOURCE_DATE_HUMAN)" -a "revnumber=$(DOCRELEASE)"
410dc2c9
DM
76
77BROWSER?=xdg-open
78
79
80README.html: README.adoc
ddb9aa33 81 asciidoc -a toc $(ADOC_STDARG) -o $@ $<
410dc2c9
DM
82
83.PHONY: index
84index: index.html
85 $(BROWSER) index.html &
86
87chapter-index-table.adoc: asciidoc-pmg
88 ./asciidoc-pmg chapter-table >$@.tmp
89 mv $@.tmp $@
90
91man1-index-table.adoc: asciidoc-pmg
92 ./asciidoc-pmg man1page-table >$@.tmp
93 mv $@.tmp $@
94
95man5-index-table.adoc: asciidoc-pmg
96 ./asciidoc-pmg man5page-table >$@.tmp
97 mv $@.tmp $@
98
99man8-index-table.adoc: asciidoc-pmg
100 ./asciidoc-pmg man8page-table >$@.tmp
101 mv $@.tmp $@
102
ddb9aa33
SI
103index.html: index.adoc $(API_VIEWER_SOURCES) $(INDEX_INCLUDES)
104 asciidoc $(ADOC_STDARG) -o $@ index.adoc
410dc2c9 105
ddb9aa33
SI
106pmg-admin-guide.html: $(PMG_ADMIN_GUIDE_ADOCDEPENDS)
107 asciidoc -a pmglogo $(ADOC_STDARG) -o $@ pmg-admin-guide.adoc
410dc2c9 108
ddb9aa33 109pmg-admin-guide.chunked: $(PMG_ADMIN_GUIDE_ADOCDEPENDS)
c978a321
SI
110 rm -rf $@.tmp $@
111 mkdir $@.tmp
112 a2x -D $@.tmp -a docinfo -a docinfo1 -a icons -f chunked pmg-admin-guide.adoc
113 mv $@.tmp/$@ $@
410dc2c9
DM
114
115PMG_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pmg-docbook -f asciidoc/asciidoc-pmg.conf
d4fe77a5 116PMG_DBLATEX_OPTS='-p ./asciidoc/pmg-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
410dc2c9 117
99289f05
SI
118YEAR:=$(shell date "+%Y")
119
410dc2c9 120pmg-admin-guide-docinfo.xml: pmg-admin-guide-docinfo.xml.in
ddb9aa33 121 sed -e 's/@RELEASE@/$(DOCRELEASE)/' -e 's/@YEAR@/$(YEAR)/' <$< >$@
99289f05
SI
122
123pmg-copyright.adoc: pmg-copyright.adoc.in
ddb9aa33 124 sed -e 's/@YEAR@/$(YEAR)/' <$< >$@
410dc2c9 125
ddb9aa33 126pmg-admin-guide.pdf: $(PMG_ADMIN_GUIDE_ADOCDEPENDS) docinfo.xml pmg-admin-guide-docinfo.xml
d4fe77a5
RV
127 rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
128 rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
ddb9aa33
SI
129 grep ">Release $(DOCRELEASE)<" pmg-admin-guide-docinfo.xml || (echo "wrong release in pmg-admin-guide-docinfo.xml" && false);
130 a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="$(PMG_DOCBOOK_CONF)" --dblatex-opts $(PMG_DBLATEX_OPTS) pmg-admin-guide.adoc
410dc2c9
DM
131 rm proxmox-logo.pdf proxmox-ci-header.pdf
132
ddb9aa33 133pmg-admin-guide.epub: $(PMG_ADMIN_GUIDE_ADOCDEPENDS)
c978a321
SI
134 rm -rf $@.tmp $@
135 mkdir $@.tmp
ddb9aa33 136 a2x -D $@.tmp -f epub --asciidoc-opts="$(PMG_DOCBOOK_CONF)" pmg-admin-guide.adoc
c978a321 137 mv $@.tmp/$@ $@
410dc2c9
DM
138
139api-viewer/apidata.js: extractapi.pl
140 ./extractapi.pl >$@
141
ddb9aa33
SI
142api-viewer/apidoc.js: $(API_VIEWER_FILES)
143 cat $(API_VIEWER_FILES) >$@.tmp
4413eb71 144 mv $@.tmp $@
410dc2c9 145
b1fa7304
SI
146$(BUILDDIR):
147 rm -rf $@ $@.tmp
148 rsync -a * $@.tmp
d9e641bb 149 echo "git clone git://git.proxmox.com/git/pmg-docs.git\\ngit checkout $(shell git rev-parse HEAD)" > $@.tmp/debian/SOURCE
b1fa7304
SI
150 mv $@.tmp $@
151
410dc2c9 152.PHONY: dinstall
ddb9aa33
SI
153dinstall: $(GEN_DEB) $(DOC_DEB)
154 dpkg -i $(GEN_DEB) $(DOC_DEB)
410dc2c9 155
8627268b
SI
156.PHONY: dsc deb
157dsc: $(DSC)
158$(DSC): $(BUILDDIR)
159 cd $(BUILDDIR); dpkg-buildpackage -S -us -uc -d
160 lintian $(DSC)
161
162sbuild: $(DSC)
163 sbuild $(DSC)
164
ddb9aa33 165deb: $(DOC_DEB)
b1fa7304
SI
166 rm -f $(GEN_DEB) $(DOC_DEB)
167 rm -rf $(BUILDDIR)
168 $(MAKE) $(DOC_DEB)
410dc2c9 169
ddb9aa33 170$(GEN_DEB): $(DOC_DEB)
1a8e71a9 171
b1fa7304
SI
172$(DOC_DEB): $(BUILDDIR)
173 cd $(BUILDDIR); dpkg-buildpackage -b -us -uc
1e359f9f 174 lintian $(DOC_DEB) $(GEN_DEB)
410dc2c9
DM
175
176.PHONY: clean-build
177clean-build:
b1fa7304 178 rm -rf $(BUILDDIR)
410dc2c9 179
1a8e71a9
SI
180.PHONY: install
181install: gen-install doc-install
182
183.PHONY: gen-install
184gen-install: $(GEN_DEB_SOURCES) asciidoc-pmg
ddb9aa33
SI
185 install -dm755 $(DESTDIR)/usr/bin
186 install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)
410dc2c9 187 # install files
ddb9aa33
SI
188 install -m 0644 $(GEN_DEB_SOURCES) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
189 install -m 0755 $(GEN_SCRIPTS) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
410dc2c9 190 # install asciidoc-pmg
1a8e71a9 191 install -m 0755 asciidoc-pmg $(DESTDIR)/usr/bin/
ddb9aa33
SI
192 install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
193 install -m 0644 asciidoc/asciidoc-pmg.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
194 install -m 0644 asciidoc/pmg-html.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
1a8e71a9
SI
195
196.PHONY: doc-install
197doc-install: index.html $(API_VIEWER_SOURCES) verify-images
410dc2c9 198 # install files for pmgdocs package
ddb9aa33
SI
199 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
200 install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
201 install -m 0644 index.html $(INDEX_INCLUDES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)
410dc2c9 202 # install screenshot images
4af6e955
CH
203 for d in screenshot installer; do \
204 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/$$d; \
205 install -m 0644 images/$$d/*.png $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/$$d; \
206 done
410dc2c9 207 # install api doc viewer
ddb9aa33
SI
208 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
209 install -m 0644 $(API_VIEWER_SOURCES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
410dc2c9
DM
210
211.PHONY: upload
82588cce 212upload: UPLOAD_DIST ?= $(DEB_DISTRIBUTION)
ddb9aa33 213upload: $(GEN_DEB) $(DOC_DEB)
82588cce 214 tar cf - $(GEN_DEB) $(DOC_DEB) | ssh -X repoman@repo.proxmox.com -- upload --product pmg --dist $(UPLOAD_DIST)
410dc2c9
DM
215
216.PHONY: update
217update: clean
218 find . -regex '.*-\(opts\|synopsis\)\.adoc' -exec rm -f \{\} \;
219 rm -f api-viewer/apidata.js
220 make all
221
222clean:
223 find . -name '*~' -exec rm {} ';'
224 rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
8627268b 225 rm -f *.deb *dsc *.tar.* *.changes *.buildinfo *.build
93f5feff 226 rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pmg-admin-guide.chunked asciidoc-pmg link-refs.json .asciidoc-pmg-tmp_* pmg-smtp-filter.8-synopsis.adoc pmgpolicy.8-synopsis.adoc pmgsh.1-synopsis.adoc
410dc2c9 227 rm -rf .pmg-doc-depends
99289f05 228 rm -f pmg-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pmg-admin-guide-docinfo.xml pmg-copyright.adoc
b1fa7304 229 rm -rf $(DEB_SOURCE)-[0-9]*