]>
Commit | Line | Data |
---|---|---|
bef0c1b4 | 1 | DGDIR=. |
c38115e9 | 2 | ASCIIDOC_PVE=./asciidoc-pve |
bef0c1b4 | 3 | |
9015f48f DM |
4 | GEN_PACKAGE=pve-doc-generator |
5 | DOC_PACKAGE=pve-docs | |
cfabc2e9 | 6 | MEDIAWIKI_PACKAGE=pve-docs-mediawiki |
9344ee0d DM |
7 | |
8 | # also update debian/changelog | |
d986fd90 | 9 | PKGREL=5 |
9344ee0d | 10 | |
60955877 | 11 | GITVERSION:=$(shell git rev-parse HEAD) |
b4f3c18a | 12 | |
0a3c58e0 TL |
13 | ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH) |
14 | ||
15 | GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb | |
ceb4ea5b | 16 | DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb |
cfabc2e9 | 17 | MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb |
789c5c57 | 18 | DOC_BUILDDEPS := asciidoc-dblatex, source-highlight, librsvg2-bin |
9344ee0d | 19 | |
b965ad63 FG |
20 | export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp) |
21 | SOURCE_DATE_HUMAN := $(shell date -d "@${SOURCE_DATE_EPOCH}") | |
516d1f2f | 22 | |
63a01806 DM |
23 | all: index.html |
24 | ||
7515acaf DM |
25 | .PHONY: verify-images |
26 | verify-images: | |
27 | for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done | |
516d1f2f DM |
28 | |
29 | ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc)) | |
30 | .pve-doc-depends link-refs.json: ${ADOC_SOURCES_GUESS} scan-adoc-refs | |
e6fc3b0c DM |
31 | ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp |
32 | @cmp --quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends | |
33 | @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json | |
63a01806 | 34 | |
1ed794c8 DM |
35 | pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in |
36 | cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp | |
37 | mv $@.tmp $@ | |
38 | ||
39 | include ./pve-doc-generator.mk | |
672abac1 | 40 | |
9015f48f | 41 | GEN_DEB_SOURCES= \ |
672abac1 | 42 | pve-doc-generator.mk \ |
63a01806 | 43 | ${MANUAL_SOURCES} \ |
54079101 | 44 | pmxcfs.8-synopsis.adoc \ |
9344ee0d DM |
45 | docinfo.xml |
46 | ||
47 | GEN_SCRIPTS= \ | |
8942fab2 DM |
48 | gen-ha-groups-opts.pl \ |
49 | gen-ha-resources-opts.pl \ | |
f6b81378 DM |
50 | gen-datacenter.cfg.5-opts.pl \ |
51 | gen-pct.conf.5-opts.pl \ | |
bac8c385 | 52 | gen-pct-network-opts.pl \ |
fe154a4f | 53 | gen-pct-mountpoint-opts.pl \ |
9b4799ab | 54 | gen-qm.conf.5-opts.pl \ |
8eb81ff6 | 55 | gen-qm-cloud-init-opts.pl \ |
500f1e1f | 56 | gen-vzdump.conf.5-opts.pl \ |
9344ee0d DM |
57 | gen-pve-firewall-cluster-opts.pl \ |
58 | gen-pve-firewall-host-opts.pl \ | |
59 | gen-pve-firewall-macros-adoc.pl \ | |
60 | gen-pve-firewall-rules-opts.pl \ | |
f6b81378 | 61 | gen-pve-firewall-vm-opts.pl |
9344ee0d | 62 | |
356064f4 DM |
63 | API_VIEWER_SOURCES= \ |
64 | api-viewer/index.html \ | |
65 | api-viewer/apidoc.js | |
66 | ||
aa99b349 DM |
67 | asciidoc-pve: asciidoc-pve.in link-refs.json |
68 | cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp | |
835dd63b | 69 | sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp |
aa99b349 DM |
70 | chmod +x asciidoc-pve.tmp |
71 | mv asciidoc-pve.tmp asciidoc-pve | |
72 | ||
b489b02c DM |
73 | pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json |
74 | cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp | |
75 | chmod +x pve-docs-mediawiki-import.tmp | |
76 | mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import | |
77 | ||
f4defaeb DM |
78 | INDEX_INCLUDES= \ |
79 | pve-admin-guide.pdf \ | |
f4defaeb | 80 | pve-admin-guide.epub \ |
941ab9c7 DM |
81 | chapter-index-table.adoc \ |
82 | man1-index-table.adoc \ | |
83 | man5-index-table.adoc \ | |
84 | man8-index-table.adoc \ | |
63a01806 | 85 | $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST}) |
f4defaeb | 86 | |
b965ad63 | 87 | ADOC_STDARG=-b $(shell pwd)/asciidoc/pve-html -f asciidoc/asciidoc-pve.conf -a icons -a data-uri -a "date=${SOURCE_DATE_HUMAN}" -a "revnumber=${DOCRELEASE}" -a footer-style=revdate |
deb7f2ea | 88 | |
fc1090ef | 89 | BROWSER?=xdg-open |
df41beec | 90 | |
7b2c36ae | 91 | |
deb7f2ea DM |
92 | %-nwdiag.svg: %.nwdiag |
93 | nwdiag -T svg $*.nwdiag -o $@; | |
94 | ||
9d17dbac | 95 | README.html: README.adoc |
6b70c786 | 96 | asciidoc -a toc ${ADOC_STDARG} -o $@ $< |
9d17dbac | 97 | |
8ace7110 DM |
98 | .PHONY: index |
99 | index: index.html | |
3f559975 DM |
100 | $(BROWSER) index.html & |
101 | ||
fd02ab90 DM |
102 | chapter-index-table.adoc: asciidoc-pve |
103 | ./asciidoc-pve chapter-table >$@.tmp | |
941ab9c7 DM |
104 | mv $@.tmp $@ |
105 | ||
fd02ab90 DM |
106 | man1-index-table.adoc: asciidoc-pve |
107 | ./asciidoc-pve man1page-table >$@.tmp | |
941ab9c7 DM |
108 | mv $@.tmp $@ |
109 | ||
fd02ab90 DM |
110 | man5-index-table.adoc: asciidoc-pve |
111 | ./asciidoc-pve man5page-table >$@.tmp | |
941ab9c7 DM |
112 | mv $@.tmp $@ |
113 | ||
fd02ab90 DM |
114 | man8-index-table.adoc: asciidoc-pve |
115 | ./asciidoc-pve man8page-table >$@.tmp | |
941ab9c7 DM |
116 | mv $@.tmp $@ |
117 | ||
118 | index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} | |
c65b00e2 | 119 | asciidoc ${ADOC_STDARG} -o $@ index.adoc |
deb7f2ea | 120 | |
63a01806 | 121 | pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} |
ae0ad291 | 122 | asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc |
deb7f2ea | 123 | |
63a01806 | 124 | pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} |
59d89a51 DM |
125 | rm -rf pve-admin-guide.chunked |
126 | a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc | |
59d89a51 | 127 | |
2522a624 | 128 | PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf |
789c5c57 | 129 | PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf' |
2522a624 | 130 | |
384871f2 DM |
131 | pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in |
132 | sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@ | |
133 | ||
63a01806 | 134 | pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml |
789c5c57 TL |
135 | rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg |
136 | rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg | |
bef0c1b4 | 137 | grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false); |
789c5c57 | 138 | a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc |
34ef065a | 139 | rm proxmox-logo.pdf proxmox-ci-header.pdf |
deb7f2ea | 140 | |
63a01806 | 141 | pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} |
2522a624 | 142 | a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc |
9344ee0d | 143 | |
356064f4 | 144 | api-viewer/apidata.js: extractapi.pl |
61568a65 DM |
145 | ./extractapi.pl >$@ |
146 | ||
356064f4 DM |
147 | api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js |
148 | cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@ | |
61568a65 | 149 | |
9344ee0d | 150 | .PHONY: dinstall |
cfabc2e9 DM |
151 | dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
152 | dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
9015f48f | 153 | |
9344ee0d | 154 | .PHONY: deb |
9015f48f | 155 | deb: |
c8bdafbd WB |
156 | rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
157 | make all-debs | |
9015f48f | 158 | |
f0d25f0d WB |
159 | .PHONY: all-debs |
160 | all-debs: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
161 | ||
c8bdafbd WB |
162 | .PHONY: clean-build |
163 | clean-build: | |
9015f48f | 164 | rm -rf build |
c8bdafbd WB |
165 | |
166 | define prepare_build | |
167 | rm -rf build-$1 | |
168 | mkdir build-$1 | |
169 | cp -a debian build-$1/debian | |
170 | mv build-$1/debian/control.in build-$1/debian/control | |
171 | echo >> build-$1/debian/control | |
172 | cat debian/$1.control >> build-$1/debian/control | |
173 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build-$1/debian/SOURCE | |
174 | install -dm755 build-$1/usr/share/$1 | |
175 | install -dm755 build-$1/usr/share/doc/$1 | |
176 | endef | |
177 | ||
178 | .PHONY: gen-deb | |
179 | gen-deb: $(GEN_DEB) | |
180 | $(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf | |
181 | $(call prepare_build,$(GEN_PACKAGE)) | |
182 | install -dm755 build-$(GEN_PACKAGE)/usr/bin | |
183 | # install files | |
184 | install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE} | |
185 | install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE} | |
de7022fb | 186 | # install asciidoc-pve |
c8bdafbd WB |
187 | install -m 0755 asciidoc-pve build-$(GEN_PACKAGE)/usr/bin/ |
188 | install -D -m 0644 asciidoc/mediawiki.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf | |
189 | install -m 0644 asciidoc/asciidoc-pve.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/ | |
190 | install -m 0644 asciidoc/pve-html.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/ | |
191 | cd build-$(GEN_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc | |
192 | lintian ${GEN_DEB} | |
193 | ||
194 | .PHONY: doc-deb | |
195 | doc-deb: $(DOC_DEB) | |
196 | $(DOC_DEB): index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images | |
197 | $(call prepare_build,$(DOC_PACKAGE)) | |
421ad500 | 198 | sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control |
ceb4ea5b | 199 | # install files for pvedocs package |
c8bdafbd WB |
200 | install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE} |
201 | install -dm755 build-$(DOC_PACKAGE)/usr/share/doc/${DOC_PACKAGE} | |
202 | install -m 0644 index.html ${INDEX_INCLUDES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE} | |
203 | install -m 0644 ${WIKI_IMPORTS} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE} | |
8c8ae224 | 204 | # install screenshot images |
c8bdafbd WB |
205 | install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot |
206 | install -m 0644 images/screenshot/*.png build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot | |
61568a65 | 207 | # install api doc viewer |
c8bdafbd WB |
208 | install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer |
209 | install -m 0644 ${API_VIEWER_SOURCES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer | |
210 | cd build-$(DOC_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc | |
ceb4ea5b | 211 | lintian ${DOC_DEB} |
c8bdafbd WB |
212 | |
213 | .PHONY: mediawiki-deb | |
214 | mediawiki-deb: $(MEDIAWIKI_DEB) | |
215 | $(MEDIAWIKI_DEB): pve-docs-mediawiki-import | |
216 | $(call prepare_build,$(MEDIAWIKI_PACKAGE)) | |
217 | cp pve-docs-mediawiki-import build-$(MEDIAWIKI_PACKAGE)/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import | |
218 | cd build-$(MEDIAWIKI_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc | |
cfabc2e9 | 219 | lintian ${MEDIAWIKI_DEB} |
9344ee0d | 220 | |
89e93b38 | 221 | .PHONY: upload |
cfabc2e9 | 222 | upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
821cf643 | 223 | tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist stretch |
deb7f2ea | 224 | |
56122987 | 225 | .PHONY: update |
0fa28023 DM |
226 | update: |
227 | make clean clean-static | |
228 | make update-static | |
5cb4ef63 TL |
229 | make all |
230 | ||
231 | .PHONY: update-static | |
0fa28023 DM |
232 | update-static: |
233 | make clean-static | |
234 | make $(filter %-synopsis.adoc %-opts.adoc, ${PVE_ADMIN_GUIDE_ADOCDEPENDS}) pve-firewall-macros.adoc api-viewer/apidata.js | |
5cb4ef63 TL |
235 | |
236 | .PHONY: clean-static | |
237 | clean-static: | |
5bf279bd | 238 | find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \; |
56122987 | 239 | rm -f api-viewer/apidata.js |
fe154a4f | 240 | rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc |
deb7f2ea | 241 | |
5cb4ef63 | 242 | clean: |
f00afaef WB |
243 | rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 |
244 | rm -f *.deb *.changes *.buildinfo | |
5cb4ef63 TL |
245 | rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import |
246 | rm -rf .pve-doc-depends | |
f00afaef | 247 | rm -f pve-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pve-admin-guide-docinfo.xml |
c8bdafbd | 248 | rm -rf build-* |