]> git.proxmox.com Git - pve-docs.git/blame_incremental - Makefile
add missing file
[pve-docs.git] / Makefile
... / ...
CommitLineData
1DGDIR=.
2ASCIIDOC_PVE=./asciidoc-pve
3
4GEN_PACKAGE=pve-doc-generator
5DOC_PACKAGE=pve-docs
6MEDIAWIKI_PACKAGE=pve-docs-mediawiki
7
8# also update debian/changelog
9PKGREL=18
10
11GITVERSION:=$(shell git rev-parse HEAD)
12
13ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
14
15GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
16DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
17MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
18DOC_BUILDDEPS := asciidoc-dblatex, source-highlight, librsvg2-bin
19
20export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
21SOURCE_DATE_HUMAN := $(shell date -d "@${SOURCE_DATE_EPOCH}")
22
23all: index.html
24
25.PHONY: verify-images
26verify-images:
27 for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
28
29ADOC_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
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
34
35pve-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
39include ./pve-doc-generator.mk
40
41GEN_DEB_SOURCES= \
42 pve-doc-generator.mk \
43 ${MANUAL_SOURCES} \
44 pmxcfs.8-synopsis.adoc \
45 docinfo.xml
46
47GEN_SCRIPTS= \
48 gen-ha-groups-opts.pl \
49 gen-ha-resources-opts.pl \
50 gen-datacenter.cfg.5-opts.pl \
51 gen-pct.conf.5-opts.pl \
52 gen-pct-network-opts.pl \
53 gen-pct-mountpoint-opts.pl \
54 gen-qm.conf.5-opts.pl \
55 gen-qm-cloud-init-opts.pl \
56 gen-vzdump.conf.5-opts.pl \
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 \
61 gen-pve-firewall-vm-opts.pl
62
63API_VIEWER_SOURCES= \
64 api-viewer/index.html \
65 api-viewer/apidoc.js
66
67asciidoc-pve: asciidoc-pve.in link-refs.json
68 cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
69 sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
70 chmod +x asciidoc-pve.tmp
71 mv asciidoc-pve.tmp asciidoc-pve
72
73pve-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
78INDEX_INCLUDES= \
79 pve-admin-guide.pdf \
80 pve-admin-guide.epub \
81 chapter-index-table.adoc \
82 man1-index-table.adoc \
83 man5-index-table.adoc \
84 man8-index-table.adoc \
85 $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
86
87ADOC_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
88
89BROWSER?=xdg-open
90
91
92%-nwdiag.svg: %.nwdiag
93 nwdiag -T svg $*.nwdiag -o $@;
94
95README.html: README.adoc
96 asciidoc -a toc ${ADOC_STDARG} -o $@ $<
97
98.PHONY: index
99index: index.html
100 $(BROWSER) index.html &
101
102chapter-index-table.adoc: asciidoc-pve
103 ./asciidoc-pve chapter-table >$@.tmp
104 mv $@.tmp $@
105
106man1-index-table.adoc: asciidoc-pve
107 ./asciidoc-pve man1page-table >$@.tmp
108 mv $@.tmp $@
109
110man5-index-table.adoc: asciidoc-pve
111 ./asciidoc-pve man5page-table >$@.tmp
112 mv $@.tmp $@
113
114man8-index-table.adoc: asciidoc-pve
115 ./asciidoc-pve man8page-table >$@.tmp
116 mv $@.tmp $@
117
118index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
119 asciidoc ${ADOC_STDARG} -o $@ index.adoc
120
121pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
122 asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
123
124pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
125 rm -rf pve-admin-guide.chunked
126 a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
127
128PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
129PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
130
131pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
132 sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
133
134pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
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
137 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
138 a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc
139 rm proxmox-logo.pdf proxmox-ci-header.pdf
140
141pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
142 a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
143
144api-viewer/apidata.js: extractapi.pl
145 ./extractapi.pl >$@
146
147api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
148 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
149
150.PHONY: dinstall
151dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
152 dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
153
154.PHONY: deb
155deb:
156 rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
157 make all-debs
158
159.PHONY: all-debs
160all-debs: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
161
162.PHONY: clean-build
163clean-build:
164 rm -rf build
165
166define 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
176endef
177
178.PHONY: gen-deb
179gen-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}
186 # install asciidoc-pve
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
195doc-deb: $(DOC_DEB)
196$(DOC_DEB): index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images
197 $(call prepare_build,$(DOC_PACKAGE))
198 sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
199 # install files for pvedocs package
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}
204 # install screenshot images
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
207 # install api doc viewer
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
211 lintian ${DOC_DEB}
212
213.PHONY: mediawiki-deb
214mediawiki-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
219 lintian ${MEDIAWIKI_DEB}
220
221.PHONY: upload
222upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
223 tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist stretch
224
225.PHONY: update
226update: clean clean-static | update-static
227 make all
228
229.PHONY: update-static
230update-static: clean-static | $(filter %-synopsis.adoc %-opts.adoc, ${PVE_ADMIN_GUIDE_ADOCDEPENDS}) pve-firewall-macros.adoc api-viewer/apidata.js
231
232.PHONY: clean-static
233clean-static:
234 find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
235 rm -f api-viewer/apidata.js
236 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
237
238clean:
239 rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
240 rm -f *.deb *.changes *.buildinfo
241 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
242 rm -rf .pve-doc-depends
243 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
244 rm -rf build-*