]> git.proxmox.com Git - pve-docs.git/blame - Makefile
qm: add overrule-shutdown to CLI usage examples
[pve-docs.git] / Makefile
CommitLineData
76909adf
TL
1include /usr/share/dpkg/pkg-info.mk
2
76937e7d
TL
3# overwriting below ensures that we can build without full PVE installed
4DGDIR=.
c38115e9 5ASCIIDOC_PVE=./asciidoc-pve
bef0c1b4 6
67f4cd3b 7BUILDDIR ?= $(DEB_SOURCE)-$(DEB_VERSION)
1dacba72 8DSC=$(DEB_SOURCE)_$(DEB_VERSION).dsc
67f4cd3b 9
9015f48f
DM
10GEN_PACKAGE=pve-doc-generator
11DOC_PACKAGE=pve-docs
cfabc2e9 12MEDIAWIKI_PACKAGE=pve-docs-mediawiki
9344ee0d 13
60955877 14GITVERSION:=$(shell git rev-parse HEAD)
b4f3c18a 15
c7ce74f4
TL
16GEN_DEB=$(GEN_PACKAGE)_$(DEB_VERSION)_all.deb
17DOC_DEB=$(DOC_PACKAGE)_$(DEB_VERSION)_all.deb
18MEDIAWIKI_DEB=$(MEDIAWIKI_PACKAGE)_$(DEB_VERSION)_all.deb
9344ee0d 19
b965ad63 20export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
6027ec4b 21SOURCE_DATE_HUMAN := $(shell date -d "@$(SOURCE_DATE_EPOCH)")
516d1f2f 22
63a01806
DM
23all: index.html
24
7515acaf
DM
25.PHONY: verify-images
26verify-images:
27 for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
516d1f2f
DM
28
29ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
6027ec4b 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
35pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in
36 cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp
6027ec4b 37 sed -i "s/@RELEASE@$$/$(DEB_VERSION_UPSTREAM)/" $@.tmp
1ed794c8
DM
38 mv $@.tmp $@
39
fd880d44 40-include ./pve-doc-generator.mk
672abac1 41
9015f48f 42GEN_DEB_SOURCES= \
672abac1 43 pve-doc-generator.mk \
6027ec4b 44 $(MANUAL_SOURCES) \
54079101 45 pmxcfs.8-synopsis.adoc \
b08ec024 46 qmeventd.8-synopsis.adoc \
9344ee0d
DM
47 docinfo.xml
48
49GEN_SCRIPTS= \
8942fab2
DM
50 gen-ha-groups-opts.pl \
51 gen-ha-resources-opts.pl \
f6b81378
DM
52 gen-datacenter.cfg.5-opts.pl \
53 gen-pct.conf.5-opts.pl \
bac8c385 54 gen-pct-network-opts.pl \
fe154a4f 55 gen-pct-mountpoint-opts.pl \
9b4799ab 56 gen-qm.conf.5-opts.pl \
9e797d8c 57 gen-cpu-models.conf.5-opts.pl \
8eb81ff6 58 gen-qm-cloud-init-opts.pl \
500f1e1f 59 gen-vzdump.conf.5-opts.pl \
9344ee0d
DM
60 gen-pve-firewall-cluster-opts.pl \
61 gen-pve-firewall-host-opts.pl \
62 gen-pve-firewall-macros-adoc.pl \
63 gen-pve-firewall-rules-opts.pl \
441ae628
DM
64 gen-pve-firewall-vm-opts.pl \
65 gen-output-format-opts.pl
9344ee0d 66
37d44f8e
DC
67API_VIEWER_FILES= \
68 api-viewer/apidata.js \
69 api-viewer/PVEAPI.js \
1f79cc8c 70 /usr/share/javascript/proxmox-widget-toolkit-dev/APIViewer.js
37d44f8e 71
356064f4
DM
72API_VIEWER_SOURCES= \
73 api-viewer/index.html \
74 api-viewer/apidoc.js
75
aa99b349
DM
76asciidoc-pve: asciidoc-pve.in link-refs.json
77 cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
6027ec4b 78 sed -e s/@RELEASE@/$(DOCRELEASE)/ -i asciidoc-pve.tmp
aa99b349
DM
79 chmod +x asciidoc-pve.tmp
80 mv asciidoc-pve.tmp asciidoc-pve
81
b489b02c
DM
82pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
83 cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp
84 chmod +x pve-docs-mediawiki-import.tmp
85 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
86
f4defaeb
DM
87INDEX_INCLUDES= \
88 pve-admin-guide.pdf \
f4defaeb 89 pve-admin-guide.epub \
941ab9c7
DM
90 chapter-index-table.adoc \
91 man1-index-table.adoc \
92 man5-index-table.adoc \
93 man8-index-table.adoc \
6027ec4b 94 $(sort $(addsuffix .html, $(MANUAL_PAGES)) $(CHAPTER_LIST))
f4defaeb 95
6027ec4b 96ADOC_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 97
9d17dbac 98README.html: README.adoc
6027ec4b 99 asciidoc -a toc $(ADOC_STDARG) -o $@ $<
9d17dbac 100
fd02ab90
DM
101chapter-index-table.adoc: asciidoc-pve
102 ./asciidoc-pve chapter-table >$@.tmp
941ab9c7
DM
103 mv $@.tmp $@
104
fd02ab90
DM
105man1-index-table.adoc: asciidoc-pve
106 ./asciidoc-pve man1page-table >$@.tmp
941ab9c7
DM
107 mv $@.tmp $@
108
fd02ab90
DM
109man5-index-table.adoc: asciidoc-pve
110 ./asciidoc-pve man5page-table >$@.tmp
941ab9c7
DM
111 mv $@.tmp $@
112
fd02ab90
DM
113man8-index-table.adoc: asciidoc-pve
114 ./asciidoc-pve man8page-table >$@.tmp
941ab9c7
DM
115 mv $@.tmp $@
116
6027ec4b
TL
117index.html: index.adoc $(API_VIEWER_SOURCES) $(INDEX_INCLUDES)
118 asciidoc $(ADOC_STDARG) -o $@ index.adoc
deb7f2ea 119
6027ec4b
TL
120pve-admin-guide.html: $(PVE_ADMIN_GUIDE_ADOCDEPENDS)
121 asciidoc -a pvelogo $(ADOC_STDARG) -o $@ pve-admin-guide.adoc
deb7f2ea 122
6027ec4b 123pve-admin-guide.chunked: $(PVE_ADMIN_GUIDE_ADOCDEPENDS)
959bc81c
FG
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/$@ $@
59d89a51 128
2522a624 129PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
789c5c57 130PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
2522a624 131
742e92ef 132YEAR:=$(shell date '+%Y')
384871f2 133pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
6027ec4b 134 sed -e 's/@RELEASE@/$(DOCRELEASE)/' -e 's/@YEAR@/$(YEAR)/' <$< >$@
384871f2 135
6027ec4b 136pve-admin-guide.pdf: $(PVE_ADMIN_GUIDE_ADOCDEPENDS) docinfo.xml pve-admin-guide-docinfo.xml
789c5c57
TL
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
6027ec4b
TL
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
34ef065a 141 rm proxmox-logo.pdf proxmox-ci-header.pdf
deb7f2ea 142
6027ec4b 143pve-admin-guide.epub: $(PVE_ADMIN_GUIDE_ADOCDEPENDS)
959bc81c
FG
144 rm -rf $@.tmp $@
145 mkdir $@.tmp
6027ec4b 146 a2x -D $@.tmp -f epub --asciidoc-opts="$(PVE_DOCBOOK_CONF)" pve-admin-guide.adoc
959bc81c 147 mv $@.tmp/$@ $@
9344ee0d 148
356064f4 149api-viewer/apidata.js: extractapi.pl
61568a65
DM
150 ./extractapi.pl >$@
151
6027ec4b
TL
152api-viewer/apidoc.js: $(API_VIEWER_FILES)
153 cat $(API_VIEWER_FILES) >$@.tmp
37d44f8e 154 mv $@.tmp $@
61568a65 155
67f4cd3b
TL
156$(BUILDDIR):
157 rm -rf $@ $@.tmp
158 rsync -a * $@.tmp/
159 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout $(GITVERSION)" > $@.tmp/debian/SOURCE
160 mv $@.tmp $@
9015f48f 161
1dacba72
TL
162.PHONY: dsc deb
163dsc: $(DSC)
164$(DSC): $(BUILDDIR)
165 cd $(BUILDDIR); dpkg-buildpackage -S -us -uc -d
166 lintian $(DSC)
167
168sbuild: $(DSC)
169 sbuild $(DSC)
170
67f4cd3b 171deb:
6027ec4b 172 rm -f $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB)
67f4cd3b
TL
173 rm -rf $(BUILDDIR)
174 $(MAKE) $(DOC_DEB)
175
176$(MEDIAWIKI_DEB) $(GEN_DEB): $(DOC_DEB)
177$(DOC_DEB): $(BUILDDIR)
178 cd $(BUILDDIR); dpkg-buildpackage -b -us -uc
fa764571 179 lintian $(DOC_DEB) $(GEN_DEB) $(MEDIAWIKI_DEB)
f0d25f0d 180
67f4cd3b
TL
181.PHONY: dinstall
182dinstall: $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB)
183 dpkg -i $(GEN_DEB) $(DOC_DEB) # $(MEDIAWIKI_DEB)
184
c8bdafbd
WB
185.PHONY: clean-build
186clean-build:
9015f48f 187 rm -rf build
c8bdafbd 188
fa764571
FG
189.PHONY: install
190install: gen-install doc-install mediawiki-install
191
192.PHONY: gen-install
193gen-install: $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
194 install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)
195 install -dm755 $(DESTDIR)/usr/share/doc/$(GEN_PACKAGE)
196 install -dm755 $(DESTDIR)/usr/bin
c8bdafbd 197 # install files
6027ec4b
TL
198 install -m 0644 $(GEN_DEB_SOURCES) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
199 install -m 0755 $(GEN_SCRIPTS) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
de7022fb 200 # install asciidoc-pve
fa764571 201 install -m 0755 asciidoc-pve $(DESTDIR)/usr/bin/
6027ec4b
TL
202 install -D -m 0644 asciidoc/mediawiki.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/mediawiki.conf
203 install -m 0644 asciidoc/asciidoc-pve.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
4a06054e 204 install -m 0644 asciidoc/pve-docbook.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
6027ec4b 205 install -m 0644 asciidoc/pve-html.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
fa764571
FG
206
207.PHONY: doc-install
b7a5c9c5 208doc-install: index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images examples
fa764571
FG
209 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
210 install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
ceb4ea5b 211 # install files for pvedocs package
6027ec4b
TL
212 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
213 install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
214 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/examples/
215 install -m 755 examples/guest-example-hookscript.pl $(DESTDIR)/usr/share/$(DOC_PACKAGE)/examples/
216 install -m 0644 index.html $(INDEX_INCLUDES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)
217 install -m 0644 $(WIKI_IMPORTS) $(DESTDIR)/usr/share/$(DOC_PACKAGE)
50f88938 218 # install images
fa764571 219 make -C images install
8c8ae224 220 # install screenshot images
6027ec4b
TL
221 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/screenshot
222 install -m 0644 images/screenshot/*.png $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/screenshot
61568a65 223 # install api doc viewer
6027ec4b
TL
224 install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
225 install -m 0644 $(API_VIEWER_SOURCES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
fa764571
FG
226
227.PHONY: mediawiki-install
b275db16 228mediawiki-install: pve-docs-mediawiki-import
fa764571
FG
229 install -dm755 $(DESTDIR)/usr/share/$(MEDIAWIKI_PACKAGE)
230 install -dm755 $(DESTDIR)/usr/share/doc/$(MEDIAWIKI_PACKAGE)
231 install -dm755 $(DESTDIR)/usr/bin
232 install -dm755 $(DESTDIR)/usr/share/$(MEDIAWIKI_PACKAGE)
233 install -dm755 $(DESTDIR)/usr/share/doc/$(MEDIAWIKI_PACKAGE)
234 install -m 0755 pve-docs-mediawiki-import $(DESTDIR)/usr/bin/
9344ee0d 235
89e93b38 236.PHONY: upload
e3cca038 237upload: UPLOAD_DIST ?= $(DEB_DISTRIBUTION)
6027ec4b 238upload: $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB)
e3cca038 239 tar cf - $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB) | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist $(UPLOAD_DIST)
deb7f2ea 240
56122987 241.PHONY: update
0fa28023
DM
242update:
243 make clean clean-static
244 make update-static
5cb4ef63
TL
245 make all
246
247.PHONY: update-static
0fa28023
DM
248update-static:
249 make clean-static
6027ec4b 250 make $(filter %-synopsis.adoc %-opts.adoc, $(PVE_ADMIN_GUIDE_ADOCDEPENDS)) pve-firewall-macros.adoc api-viewer/apidata.js
5cb4ef63
TL
251
252.PHONY: clean-static
253clean-static:
51778acd 254 find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -not -name qmeventd.8-synopsis.adoc -exec rm -f \{\} \;
56122987 255 rm -f api-viewer/apidata.js
fe154a4f 256 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
deb7f2ea 257
5cb4ef63 258clean:
f00afaef 259 rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
67f4cd3b 260 rm -f *.deb *.dsc *.tar.* *.changes *.buildinfo *.build
5cb4ef63
TL
261 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
262 rm -rf .pve-doc-depends
f00afaef 263 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
67f4cd3b 264 rm -rf $(DEB_SOURCE)-[0-9]*/