]> git.proxmox.com Git - pve-docs.git/blame_incremental - Makefile
remove note about vlan management interface
[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=8
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 gen-output-format-opts.pl
63
64API_VIEWER_SOURCES= \
65 api-viewer/index.html \
66 api-viewer/apidoc.js
67
68asciidoc-pve: asciidoc-pve.in link-refs.json
69 cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
70 sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
71 chmod +x asciidoc-pve.tmp
72 mv asciidoc-pve.tmp asciidoc-pve
73
74pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
75 cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp
76 chmod +x pve-docs-mediawiki-import.tmp
77 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
78
79INDEX_INCLUDES= \
80 pve-admin-guide.pdf \
81 pve-admin-guide.epub \
82 chapter-index-table.adoc \
83 man1-index-table.adoc \
84 man5-index-table.adoc \
85 man8-index-table.adoc \
86 $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
87
88ADOC_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
89
90BROWSER?=xdg-open
91
92README.html: README.adoc
93 asciidoc -a toc ${ADOC_STDARG} -o $@ $<
94
95.PHONY: index
96index: index.html
97 $(BROWSER) index.html &
98
99chapter-index-table.adoc: asciidoc-pve
100 ./asciidoc-pve chapter-table >$@.tmp
101 mv $@.tmp $@
102
103man1-index-table.adoc: asciidoc-pve
104 ./asciidoc-pve man1page-table >$@.tmp
105 mv $@.tmp $@
106
107man5-index-table.adoc: asciidoc-pve
108 ./asciidoc-pve man5page-table >$@.tmp
109 mv $@.tmp $@
110
111man8-index-table.adoc: asciidoc-pve
112 ./asciidoc-pve man8page-table >$@.tmp
113 mv $@.tmp $@
114
115index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
116 asciidoc ${ADOC_STDARG} -o $@ index.adoc
117
118pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
119 asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
120
121pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
122 rm -rf pve-admin-guide.chunked
123 a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
124
125PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
126PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
127
128pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
129 sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
130
131pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
132 rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
133 rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
134 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
135 a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc
136 rm proxmox-logo.pdf proxmox-ci-header.pdf
137
138pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
139 a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
140
141api-viewer/apidata.js: extractapi.pl
142 ./extractapi.pl >$@
143
144api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
145 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
146
147.PHONY: dinstall
148dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
149 dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
150
151.PHONY: deb
152deb:
153 rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
154 make all-debs
155
156.PHONY: all-debs
157all-debs: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
158
159.PHONY: clean-build
160clean-build:
161 rm -rf build
162
163define prepare_build
164 rm -rf build-$1
165 mkdir build-$1
166 cp -a debian build-$1/debian
167 mv build-$1/debian/control.in build-$1/debian/control
168 echo >> build-$1/debian/control
169 cat debian/$1.control >> build-$1/debian/control
170 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build-$1/debian/SOURCE
171 install -dm755 build-$1/usr/share/$1
172 install -dm755 build-$1/usr/share/doc/$1
173endef
174
175.PHONY: gen-deb
176gen-deb: $(GEN_DEB)
177$(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
178 $(call prepare_build,$(GEN_PACKAGE))
179 install -dm755 build-$(GEN_PACKAGE)/usr/bin
180 # install files
181 install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
182 install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
183 # install asciidoc-pve
184 install -m 0755 asciidoc-pve build-$(GEN_PACKAGE)/usr/bin/
185 install -D -m 0644 asciidoc/mediawiki.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf
186 install -m 0644 asciidoc/asciidoc-pve.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
187 install -m 0644 asciidoc/pve-html.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
188 cd build-$(GEN_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
189 lintian ${GEN_DEB}
190
191.PHONY: doc-deb
192doc-deb: $(DOC_DEB)
193$(DOC_DEB): index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images
194 $(call prepare_build,$(DOC_PACKAGE))
195 sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
196 # install files for pvedocs package
197 install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
198 install -dm755 build-$(DOC_PACKAGE)/usr/share/doc/${DOC_PACKAGE}
199 install -m 0644 index.html ${INDEX_INCLUDES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
200 install -m 0644 ${WIKI_IMPORTS} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
201 # install images
202 make -C images DESTDIR=../build-$(DOC_PACKAGE) install
203 # install screenshot images
204 install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
205 install -m 0644 images/screenshot/*.png build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
206 # install api doc viewer
207 install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
208 install -m 0644 ${API_VIEWER_SOURCES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
209 cd build-$(DOC_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
210 lintian ${DOC_DEB}
211
212.PHONY: mediawiki-deb
213mediawiki-deb: $(MEDIAWIKI_DEB)
214$(MEDIAWIKI_DEB): pve-docs-mediawiki-import
215 $(call prepare_build,$(MEDIAWIKI_PACKAGE))
216 cp pve-docs-mediawiki-import build-$(MEDIAWIKI_PACKAGE)/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import
217 cd build-$(MEDIAWIKI_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
218 lintian ${MEDIAWIKI_DEB}
219
220.PHONY: upload
221upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
222 tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist stretch
223
224.PHONY: update
225update:
226 make clean clean-static
227 make update-static
228 make all
229
230.PHONY: update-static
231update-static:
232 make clean-static
233 make $(filter %-synopsis.adoc %-opts.adoc, ${PVE_ADMIN_GUIDE_ADOCDEPENDS}) pve-firewall-macros.adoc api-viewer/apidata.js
234
235.PHONY: clean-static
236clean-static:
237 find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
238 rm -f api-viewer/apidata.js
239 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
240
241clean:
242 rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
243 rm -f *.deb *.changes *.buildinfo
244 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
245 rm -rf .pve-doc-depends
246 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
247 rm -rf build-*