]>
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 | |
59270944 | 9 | PKGREL=11 |
9344ee0d | 10 | |
b4f3c18a DM |
11 | GITVERSION:=$(shell cat .git/refs/heads/master) |
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 |
9344ee0d | 18 | |
63a01806 DM |
19 | all: index.html |
20 | ||
21 | .pve-doc-depends link-refs.json: $(wildcard *.adoc) scan-adoc-refs | |
e6fc3b0c DM |
22 | ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp |
23 | @cmp --quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends | |
24 | @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json | |
63a01806 | 25 | |
1ed794c8 DM |
26 | pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in |
27 | cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp | |
28 | mv $@.tmp $@ | |
29 | ||
30 | include ./pve-doc-generator.mk | |
672abac1 | 31 | |
9015f48f | 32 | GEN_DEB_SOURCES= \ |
672abac1 | 33 | pve-doc-generator.mk \ |
63a01806 | 34 | ${MANUAL_SOURCES} \ |
54079101 | 35 | pmxcfs.8-synopsis.adoc \ |
9344ee0d DM |
36 | docinfo.xml |
37 | ||
38 | GEN_SCRIPTS= \ | |
f6b81378 DM |
39 | gen-datacenter.cfg.5-opts.pl \ |
40 | gen-pct.conf.5-opts.pl \ | |
bac8c385 | 41 | gen-pct-network-opts.pl \ |
fe154a4f | 42 | gen-pct-mountpoint-opts.pl \ |
9b4799ab | 43 | gen-qm.conf.5-opts.pl \ |
500f1e1f | 44 | gen-vzdump.conf.5-opts.pl \ |
9344ee0d DM |
45 | gen-pve-firewall-cluster-opts.pl \ |
46 | gen-pve-firewall-host-opts.pl \ | |
47 | gen-pve-firewall-macros-adoc.pl \ | |
48 | gen-pve-firewall-rules-opts.pl \ | |
f6b81378 | 49 | gen-pve-firewall-vm-opts.pl |
9344ee0d | 50 | |
356064f4 DM |
51 | API_VIEWER_SOURCES= \ |
52 | api-viewer/index.html \ | |
53 | api-viewer/apidoc.js | |
54 | ||
aa99b349 DM |
55 | asciidoc-pve: asciidoc-pve.in link-refs.json |
56 | cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp | |
835dd63b | 57 | sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp |
aa99b349 DM |
58 | chmod +x asciidoc-pve.tmp |
59 | mv asciidoc-pve.tmp asciidoc-pve | |
60 | ||
b489b02c DM |
61 | pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json |
62 | cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp | |
63 | chmod +x pve-docs-mediawiki-import.tmp | |
64 | mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import | |
65 | ||
f4defaeb DM |
66 | INDEX_INCLUDES= \ |
67 | pve-admin-guide.pdf \ | |
f4defaeb | 68 | pve-admin-guide.epub \ |
941ab9c7 DM |
69 | chapter-index-table.adoc \ |
70 | man1-index-table.adoc \ | |
71 | man5-index-table.adoc \ | |
72 | man8-index-table.adoc \ | |
63a01806 | 73 | $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST}) |
f4defaeb | 74 | |
8faad89e | 75 | ADOC_STDARG= -b html5 -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" |
deb7f2ea | 76 | |
fc1090ef | 77 | BROWSER?=xdg-open |
df41beec | 78 | |
7b2c36ae | 79 | |
deb7f2ea DM |
80 | %-nwdiag.svg: %.nwdiag |
81 | nwdiag -T svg $*.nwdiag -o $@; | |
82 | ||
9d17dbac DM |
83 | README.html: README.adoc |
84 | asciidoc ${ADOC_STDARG} -o $@ $< | |
85 | ||
8ace7110 DM |
86 | .PHONY: index |
87 | index: index.html | |
3f559975 DM |
88 | $(BROWSER) index.html & |
89 | ||
941ab9c7 DM |
90 | chapter-index-table.adoc: gen-index-includes.pl |
91 | ./gen-index-includes.pl chapter-table >$@.tmp | |
92 | mv $@.tmp $@ | |
93 | ||
94 | man1-index-table.adoc: gen-index-includes.pl | |
95 | ./gen-index-includes.pl man1page-table >$@.tmp | |
96 | mv $@.tmp $@ | |
97 | ||
98 | man5-index-table.adoc: gen-index-includes.pl | |
99 | ./gen-index-includes.pl man5page-table >$@.tmp | |
100 | mv $@.tmp $@ | |
101 | ||
102 | man8-index-table.adoc: link-refs.json gen-index-includes.pl | |
103 | ./gen-index-includes.pl man8page-table >$@.tmp | |
104 | mv $@.tmp $@ | |
105 | ||
106 | index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} | |
c65b00e2 | 107 | asciidoc ${ADOC_STDARG} -o $@ index.adoc |
deb7f2ea | 108 | |
63a01806 | 109 | pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} |
9242ce61 | 110 | asciidoc -a pvelogo ${ADOC_STDARG} pve-admin-guide.adoc |
deb7f2ea | 111 | |
63a01806 | 112 | pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} |
59d89a51 DM |
113 | rm -rf pve-admin-guide.chunked |
114 | a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc | |
59d89a51 | 115 | |
63a01806 | 116 | pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml |
34ef065a | 117 | inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg |
333a2f49 | 118 | inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg |
bef0c1b4 | 119 | grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false); |
7057b59f | 120 | a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" --dblatex-opts "-P doc.section.depth=2 -P toc.section.depth=2" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc/dblatex-custom.sty" pve-admin-guide.adoc |
34ef065a | 121 | rm proxmox-logo.pdf proxmox-ci-header.pdf |
deb7f2ea | 122 | |
63a01806 | 123 | pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} |
deb7f2ea | 124 | a2x -f epub pve-admin-guide.adoc |
9344ee0d | 125 | |
356064f4 | 126 | api-viewer/apidata.js: extractapi.pl |
61568a65 DM |
127 | ./extractapi.pl >$@ |
128 | ||
356064f4 DM |
129 | api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js |
130 | cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@ | |
61568a65 | 131 | |
9344ee0d | 132 | .PHONY: dinstall |
cfabc2e9 DM |
133 | dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
134 | dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
9015f48f | 135 | |
9344ee0d | 136 | .PHONY: deb |
9015f48f | 137 | deb: |
cfabc2e9 DM |
138 | rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; |
139 | make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; | |
9015f48f | 140 | |
e82ab12b | 141 | ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import asciidoc/mediawiki.conf |
9015f48f DM |
142 | rm -rf build |
143 | mkdir build | |
ceb4ea5b | 144 | rsync -a debian/ build/debian |
b489b02c | 145 | cp pve-docs-mediawiki-import build/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import |
ceb4ea5b DM |
146 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE |
147 | # install files for pve-doc-generator package | |
148 | mkdir -p build/usr/share/${GEN_PACKAGE} | |
149 | mkdir -p build/usr/share/doc/${GEN_PACKAGE} | |
bb3c27a7 | 150 | mkdir -p build/usr/bin |
ceb4ea5b DM |
151 | install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE} |
152 | install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE} | |
bb3c27a7 | 153 | install -m 0755 asciidoc-pve build/usr/bin/ |
e82ab12b | 154 | install -D -m 0644 asciidoc/mediawiki.conf build/etc/asciidoc/mediawiki.conf |
ceb4ea5b | 155 | # install files for pvedocs package |
9015f48f DM |
156 | mkdir -p build/usr/share/${DOC_PACKAGE} |
157 | mkdir -p build/usr/share/doc/${DOC_PACKAGE} | |
ad2bfc41 | 158 | install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE} |
251666be | 159 | install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE} |
61568a65 | 160 | # install api doc viewer |
356064f4 DM |
161 | mkdir build/usr/share/${DOC_PACKAGE}/api-viewer |
162 | install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer | |
cfabc2e9 | 163 | # build Debian packages |
9344ee0d | 164 | cd build; dpkg-buildpackage -rfakeroot -b -us -uc |
9015f48f | 165 | lintian ${GEN_DEB} |
ceb4ea5b | 166 | lintian ${DOC_DEB} |
cfabc2e9 | 167 | lintian ${MEDIAWIKI_DEB} |
9344ee0d | 168 | |
89e93b38 | 169 | .PHONY: upload |
cfabc2e9 | 170 | upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
d7b4925a | 171 | tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload |
deb7f2ea | 172 | |
56122987 | 173 | .PHONY: update |
c016ebb7 | 174 | update: clean |
5bf279bd | 175 | find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \; |
56122987 | 176 | rm -f api-viewer/apidata.js |
fe154a4f | 177 | rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc |
c016ebb7 | 178 | make all |
deb7f2ea | 179 | |
bca311e4 | 180 | clean: |
941ab9c7 | 181 | rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build 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 .pve-doc-depends pve-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc |
de9cbbd6 | 182 | find . -name '*~' -exec rm {} ';' |