ceph: add explanation on the pg autoscaler
[pve-docs.git] / Makefile
1 include /usr/share/dpkg/pkg-info.mk
2
3 # overwriting below ensures that we can build without full PVE installed
4 DGDIR=.
5 ASCIIDOC_PVE=./asciidoc-pve
6
7 GEN_PACKAGE=pve-doc-generator
8 DOC_PACKAGE=pve-docs
9 MEDIAWIKI_PACKAGE=pve-docs-mediawiki
10
11 GITVERSION:=$(shell git rev-parse HEAD)
12
13 ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
14
15 GEN_DEB=${GEN_PACKAGE}_${DEB_VERSION_UPSTREAM_REVISION}_${ARCH}.deb
16 DOC_DEB=${DOC_PACKAGE}_${DEB_VERSION_UPSTREAM_REVISION}_all.deb
17 MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DEB_VERSION_UPSTREAM_REVISION}_all.deb
18
19 export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
20 SOURCE_DATE_HUMAN := $(shell date -d "@${SOURCE_DATE_EPOCH}")
21
22 all: index.html
23
24 .PHONY: verify-images
25 verify-images:
26 for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
27
28 ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
29 .pve-doc-depends link-refs.json: ${ADOC_SOURCES_GUESS} scan-adoc-refs
30 ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp
31 @cmp --quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends
32 @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
33
34 pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in
35 cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp
36 sed -i "s/@RELEASE@$$/${DEB_VERSION_UPSTREAM}/" $@.tmp
37 mv $@.tmp $@
38
39 -include ./pve-doc-generator.mk
40
41 GEN_DEB_SOURCES= \
42 pve-doc-generator.mk \
43 ${MANUAL_SOURCES} \
44 pmxcfs.8-synopsis.adoc \
45 qmeventd.8-synopsis.adoc \
46 docinfo.xml
47
48 GEN_SCRIPTS= \
49 gen-ha-groups-opts.pl \
50 gen-ha-resources-opts.pl \
51 gen-datacenter.cfg.5-opts.pl \
52 gen-pct.conf.5-opts.pl \
53 gen-pct-network-opts.pl \
54 gen-pct-mountpoint-opts.pl \
55 gen-qm.conf.5-opts.pl \
56 gen-cpu-models.conf.5-opts.pl \
57 gen-qm-cloud-init-opts.pl \
58 gen-vzdump.conf.5-opts.pl \
59 gen-pve-firewall-cluster-opts.pl \
60 gen-pve-firewall-host-opts.pl \
61 gen-pve-firewall-macros-adoc.pl \
62 gen-pve-firewall-rules-opts.pl \
63 gen-pve-firewall-vm-opts.pl \
64 gen-output-format-opts.pl
65
66 API_VIEWER_SOURCES= \
67 api-viewer/index.html \
68 api-viewer/apidoc.js
69
70 asciidoc-pve: asciidoc-pve.in link-refs.json
71 cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
72 sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
73 chmod +x asciidoc-pve.tmp
74 mv asciidoc-pve.tmp asciidoc-pve
75
76 pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
77 cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp
78 chmod +x pve-docs-mediawiki-import.tmp
79 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
80
81 INDEX_INCLUDES= \
82 pve-admin-guide.pdf \
83 pve-admin-guide.epub \
84 chapter-index-table.adoc \
85 man1-index-table.adoc \
86 man5-index-table.adoc \
87 man8-index-table.adoc \
88 $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
89
90 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
91
92 BROWSER?=xdg-open
93
94 README.html: README.adoc
95 asciidoc -a toc ${ADOC_STDARG} -o $@ $<
96
97 .PHONY: index
98 index: index.html
99 test -z "$${PVE_DOC_INSTANTVIEW}" || $(BROWSER) index.html &
100
101 chapter-index-table.adoc: asciidoc-pve
102 ./asciidoc-pve chapter-table >$@.tmp
103 mv $@.tmp $@
104
105 man1-index-table.adoc: asciidoc-pve
106 ./asciidoc-pve man1page-table >$@.tmp
107 mv $@.tmp $@
108
109 man5-index-table.adoc: asciidoc-pve
110 ./asciidoc-pve man5page-table >$@.tmp
111 mv $@.tmp $@
112
113 man8-index-table.adoc: asciidoc-pve
114 ./asciidoc-pve man8page-table >$@.tmp
115 mv $@.tmp $@
116
117 index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
118 asciidoc ${ADOC_STDARG} -o $@ index.adoc
119
120 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
121 asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
122
123 pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
124 rm -rf $@.tmp $@
125 mkdir $@.tmp
126 a2x -D $@.tmp -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
127 mv $@.tmp/$@ $@
128
129 PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
130 PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
131
132 YEAR:=$(shell date '+%Y')
133 pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
134 sed -e 's/@RELEASE@/${DOCRELEASE}/' -e 's/@YEAR@/${YEAR}/' <$< >$@
135
136 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
137 rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
138 rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
139 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
140 a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc
141 rm proxmox-logo.pdf proxmox-ci-header.pdf
142
143 pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
144 rm -rf $@.tmp $@
145 mkdir $@.tmp
146 a2x -D $@.tmp -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
147 mv $@.tmp/$@ $@
148
149 api-viewer/apidata.js: extractapi.pl
150 ./extractapi.pl >$@
151
152 api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
153 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
154
155 .PHONY: dinstall
156 dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
157 dpkg -i ${GEN_DEB} ${DOC_DEB} # ${MEDIAWIKI_DEB}
158
159 .PHONY: deb
160 deb: $(DOC_DEB)
161 $(MEDIAWIKI_DEB) $(GEN_DEB): $(DOC_DEB)
162 $(DOC_DEB):
163 rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
164 rm -rf build
165 rsync -a * build/
166 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
167 cd build; dpkg-buildpackage -b -us -uc
168 lintian $(DOC_DEB) $(GEN_DEB) $(MEDIAWIKI_DEB)
169
170 .PHONY: clean-build
171 clean-build:
172 rm -rf build
173
174 .PHONY: install
175 install: gen-install doc-install mediawiki-install
176
177 .PHONY: gen-install
178 gen-install: $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
179 install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)
180 install -dm755 $(DESTDIR)/usr/share/doc/$(GEN_PACKAGE)
181 install -dm755 $(DESTDIR)/usr/bin
182 # install files
183 install -m 0644 ${GEN_DEB_SOURCES} $(DESTDIR)/usr/share/${GEN_PACKAGE}
184 install -m 0755 ${GEN_SCRIPTS} $(DESTDIR)/usr/share/${GEN_PACKAGE}
185 # install asciidoc-pve
186 install -m 0755 asciidoc-pve $(DESTDIR)/usr/bin/
187 install -D -m 0644 asciidoc/mediawiki.conf $(DESTDIR)/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf
188 install -m 0644 asciidoc/asciidoc-pve.conf $(DESTDIR)/usr/share/${GEN_PACKAGE}/asciidoc/
189 install -m 0644 asciidoc/pve-html.conf $(DESTDIR)/usr/share/${GEN_PACKAGE}/asciidoc/
190
191 .PHONY: doc-install
192 doc-install: index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images examples
193 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
194 install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
195 # install files for pvedocs package
196 install -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}
197 install -dm755 $(DESTDIR)/usr/share/doc/${DOC_PACKAGE}
198 install -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}/examples/
199 install -m 755 examples/guest-example-hookscript.pl $(DESTDIR)/usr/share/${DOC_PACKAGE}/examples/
200 install -m 0644 index.html ${INDEX_INCLUDES} $(DESTDIR)/usr/share/${DOC_PACKAGE}
201 install -m 0644 ${WIKI_IMPORTS} $(DESTDIR)/usr/share/${DOC_PACKAGE}
202 # install images
203 make -C images install
204 # install screenshot images
205 install -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}/images/screenshot
206 install -m 0644 images/screenshot/*.png $(DESTDIR)/usr/share/${DOC_PACKAGE}/images/screenshot
207 # install api doc viewer
208 install -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}/api-viewer
209 install -m 0644 ${API_VIEWER_SOURCES} $(DESTDIR)/usr/share/${DOC_PACKAGE}/api-viewer
210
211 .PHONY: mediawiki-install
212 mediawiki-install: pve-docs-mediawiki-import
213 install -dm755 $(DESTDIR)/usr/share/$(MEDIAWIKI_PACKAGE)
214 install -dm755 $(DESTDIR)/usr/share/doc/$(MEDIAWIKI_PACKAGE)
215 install -dm755 $(DESTDIR)/usr/bin
216 install -dm755 $(DESTDIR)/usr/share/$(MEDIAWIKI_PACKAGE)
217 install -dm755 $(DESTDIR)/usr/share/doc/$(MEDIAWIKI_PACKAGE)
218 install -m 0755 pve-docs-mediawiki-import $(DESTDIR)/usr/bin/
219
220 .PHONY: upload
221 upload: ${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 buster
223
224 .PHONY: update
225 update:
226 make clean clean-static
227 make update-static
228 make all
229
230 .PHONY: update-static
231 update-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
236 clean-static:
237 find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -not -name qmeventd.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
241 clean:
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