]>
Commit | Line | Data |
---|---|---|
1 | DGDIR=. | |
2 | ASCIIDOC_PVE=./asciidoc-pve | |
3 | ||
4 | GEN_PACKAGE=pve-doc-generator | |
5 | DOC_PACKAGE=pve-docs | |
6 | MEDIAWIKI_PACKAGE=pve-docs-mediawiki | |
7 | ||
8 | # also update debian/changelog | |
9 | PKGREL=8 | |
10 | ||
11 | GITVERSION:=$(shell cat .git/refs/heads/master) | |
12 | ||
13 | ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH) | |
14 | ||
15 | GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb | |
16 | DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb | |
17 | MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb | |
18 | ||
19 | all: index.html | |
20 | ||
21 | .pve-doc-depends link-refs.json: $(wildcard *.adoc) scan-adoc-refs | |
22 | ./scan-adoc-refs *.adoc --depends .pve-doc-depends > link-refs.json | |
23 | ||
24 | pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in | |
25 | cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp | |
26 | mv $@.tmp $@ | |
27 | ||
28 | include ./pve-doc-generator.mk | |
29 | ||
30 | GEN_DEB_SOURCES= \ | |
31 | pve-doc-generator.mk \ | |
32 | ${MANUAL_SOURCES} \ | |
33 | ${PVESM_ADOCSOURCES} \ | |
34 | pmxcfs.8-synopsis.adoc \ | |
35 | docinfo.xml | |
36 | ||
37 | GEN_SCRIPTS= \ | |
38 | gen-datacenter.cfg.5-opts.pl \ | |
39 | gen-pct.conf.5-opts.pl \ | |
40 | gen-pct-network-opts.pl \ | |
41 | gen-pct-mountpoint-opts.pl \ | |
42 | gen-qm.conf.5-opts.pl \ | |
43 | gen-vzdump.conf.5-opts.pl \ | |
44 | gen-pve-firewall-cluster-opts.pl \ | |
45 | gen-pve-firewall-host-opts.pl \ | |
46 | gen-pve-firewall-macros-adoc.pl \ | |
47 | gen-pve-firewall-rules-opts.pl \ | |
48 | gen-pve-firewall-vm-opts.pl | |
49 | ||
50 | API_VIEWER_SOURCES= \ | |
51 | api-viewer/index.html \ | |
52 | api-viewer/apidoc.js | |
53 | ||
54 | asciidoc-pve: asciidoc-pve.in link-refs.json | |
55 | cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp | |
56 | sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp | |
57 | chmod +x asciidoc-pve.tmp | |
58 | mv asciidoc-pve.tmp asciidoc-pve | |
59 | ||
60 | pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json | |
61 | cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp | |
62 | chmod +x pve-docs-mediawiki-import.tmp | |
63 | mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import | |
64 | ||
65 | INDEX_INCLUDES= \ | |
66 | pve-admin-guide.pdf \ | |
67 | pve-admin-guide.epub \ | |
68 | $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST}) | |
69 | ||
70 | ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" | |
71 | ||
72 | BROWSER?=xdg-open | |
73 | ||
74 | ||
75 | %-nwdiag.svg: %.nwdiag | |
76 | nwdiag -T svg $*.nwdiag -o $@; | |
77 | ||
78 | README.html: README.adoc | |
79 | asciidoc ${ADOC_STDARG} -o $@ $< | |
80 | ||
81 | .PHONY: index | |
82 | index: index.html | |
83 | $(BROWSER) index.html & | |
84 | ||
85 | index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} | |
86 | asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc | |
87 | ||
88 | pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} | |
89 | asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc | |
90 | ||
91 | pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} | |
92 | rm -rf pve-admin-guide.chunked | |
93 | a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc | |
94 | ||
95 | pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml | |
96 | inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg | |
97 | inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg | |
98 | grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false); | |
99 | 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 | |
100 | rm proxmox-logo.pdf proxmox-ci-header.pdf | |
101 | ||
102 | pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} | |
103 | a2x -f epub pve-admin-guide.adoc | |
104 | ||
105 | api-viewer/apidata.js: extractapi.pl | |
106 | ./extractapi.pl >$@ | |
107 | ||
108 | api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js | |
109 | cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@ | |
110 | ||
111 | .PHONY: dinstall | |
112 | dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
113 | dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
114 | ||
115 | .PHONY: deb | |
116 | deb: | |
117 | rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; | |
118 | make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; | |
119 | ||
120 | ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import | |
121 | rm -rf build | |
122 | mkdir build | |
123 | rsync -a debian/ build/debian | |
124 | cp pve-docs-mediawiki-import build/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import | |
125 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE | |
126 | # install files for pve-doc-generator package | |
127 | mkdir -p build/usr/share/${GEN_PACKAGE} | |
128 | mkdir -p build/usr/share/doc/${GEN_PACKAGE} | |
129 | mkdir -p build/usr/bin | |
130 | install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE} | |
131 | install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE} | |
132 | install -m 0755 asciidoc-pve build/usr/bin/ | |
133 | # install files for pvedocs package | |
134 | mkdir -p build/usr/share/${DOC_PACKAGE} | |
135 | mkdir -p build/usr/share/doc/${DOC_PACKAGE} | |
136 | install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE} | |
137 | install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE} | |
138 | # install api doc viewer | |
139 | mkdir build/usr/share/${DOC_PACKAGE}/api-viewer | |
140 | install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer | |
141 | # build Debian packages | |
142 | cd build; dpkg-buildpackage -rfakeroot -b -us -uc | |
143 | lintian ${GEN_DEB} | |
144 | lintian ${DOC_DEB} | |
145 | lintian ${MEDIAWIKI_DEB} | |
146 | ||
147 | .PHONY: upload | |
148 | upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
149 | tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload | |
150 | ||
151 | .PHONY: update | |
152 | update: clean | |
153 | rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc | |
154 | rm -f api-viewer/apidata.js | |
155 | rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc | |
156 | make all | |
157 | ||
158 | clean: | |
159 | 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 | |
160 | find . -name '*~' -exec rm {} ';' |