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