2 ASCIIDOC_PVE
=.
/asciidoc-pve
4 GEN_PACKAGE
=pve-doc-generator
6 MEDIAWIKI_PACKAGE
=pve-docs-mediawiki
8 # also update debian/changelog
11 GITVERSION
:=$(shell cat .git
/refs
/heads
/master
)
13 ARCH
:=$(shell dpkg-architecture
-qDEB_BUILD_ARCH
)
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
24 for i in .
/images
/screenshot
/*.png
; do .
/png-verify.pl
$$i; done
26 ADOC_SOURCES_GUESS
=$(filter-out %-synopsis.adoc
%-opts.adoc
%-table.adoc
, $(wildcard *.adoc
))
27 .pve-doc-depends link-refs.json
: ${ADOC_SOURCES_GUESS} scan-adoc-refs
28 .
/scan-adoc-refs
*.adoc
--depends .pve-doc-depends.tmp
> link-refs.json.tmp
29 @cmp
--quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends
30 @cmp
--quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
32 pve-doc-generator.mk
: .pve-doc-depends pve-doc-generator.mk.in
33 cat pve-doc-generator.mk.in .pve-doc-depends
> $@.tmp
36 include .
/pve-doc-generator.mk
39 pve-doc-generator.mk \
41 pmxcfs
.8-synopsis.adoc \
45 gen-ha-groups-opts.pl \
46 gen-ha-resources-opts.pl \
47 gen-datacenter.cfg
.5-opts.pl \
48 gen-pct.conf
.5-opts.pl \
49 gen-pct-network-opts.pl \
50 gen-pct-mountpoint-opts.pl \
51 gen-qm.conf
.5-opts.pl \
52 gen-vzdump.conf
.5-opts.pl \
53 gen-pve-firewall-cluster-opts.pl \
54 gen-pve-firewall-host-opts.pl \
55 gen-pve-firewall-macros-adoc.pl \
56 gen-pve-firewall-rules-opts.pl \
57 gen-pve-firewall-vm-opts.pl
60 api-viewer
/index.html \
63 asciidoc-pve
: asciidoc-pve.in link-refs.json
64 cat asciidoc-pve.in link-refs.json
>asciidoc-pve.tmp
65 sed
-e s
/@RELEASE@
/${DOCRELEASE}/ -i asciidoc-pve.tmp
66 chmod
+x asciidoc-pve.tmp
67 mv asciidoc-pve.tmp asciidoc-pve
69 pve-docs-mediawiki-import
: pve-docs-mediawiki-import.in link-refs.json
70 cat pve-docs-mediawiki-import.in link-refs.json
> pve-docs-mediawiki-import.tmp
71 chmod
+x pve-docs-mediawiki-import.tmp
72 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
76 pve-admin-guide.epub \
77 chapter-index-table.adoc \
78 man1-index-table.adoc \
79 man5-index-table.adoc \
80 man8-index-table.adoc \
81 $(sort $(addsuffix .html
, ${MANUAL_PAGES}) ${CHAPTER_LIST})
83 ADOC_STDARG
=-b
$(shell pwd
)/asciidoc
/pve-html
-f asciidoc
/asciidoc-pve.conf
-a icons
-a data-uri
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}"
88 %-nwdiag.svg
: %.nwdiag
89 nwdiag
-T svg
$*.nwdiag
-o
$@
;
91 README.html
: README.adoc
92 asciidoc
-a toc
${ADOC_STDARG} -o
$@
$<
96 $(BROWSER
) index.html
&
98 chapter-index-table.adoc
: asciidoc-pve
99 .
/asciidoc-pve chapter-table
>$@.tmp
102 man1-index-table.adoc
: asciidoc-pve
103 .
/asciidoc-pve man1page-table
>$@.tmp
106 man5-index-table.adoc
: asciidoc-pve
107 .
/asciidoc-pve man5page-table
>$@.tmp
110 man8-index-table.adoc
: asciidoc-pve
111 .
/asciidoc-pve man8page-table
>$@.tmp
114 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
115 asciidoc
${ADOC_STDARG} -o
$@ index.adoc
117 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
118 asciidoc
-a pvelogo
${ADOC_STDARG} -o
$@ pve-admin-guide.adoc
120 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
121 rm -rf pve-admin-guide.chunked
122 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
124 PVE_DOCBOOK_CONF
=-b
$(shell pwd
)/asciidoc
/pve-docbook
-f asciidoc
/asciidoc-pve.conf
126 pve-admin-guide-docinfo.xml
: pve-admin-guide-docinfo.xml.in
127 sed
-e
's/@RELEASE@/${DOCRELEASE}/' <$< >$@
129 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
130 inkscape
-z
-D
--export-pdf
=proxmox-logo.pdf images
/proxmox-logo.svg
131 inkscape
-z
-D
--export-pdf
=proxmox-ci-header.pdf images
/proxmox-ci-header.svg
132 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
133 a2x
-a docinfo
-a docinfo1
-f pdf
-L
--asciidoc-opts
="${PVE_DOCBOOK_CONF}" --dblatex-opts
"-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty" pve-admin-guide.adoc
134 rm proxmox-logo.pdf proxmox-ci-header.pdf
136 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
137 a2x
-f epub
--asciidoc-opts
="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
139 api-viewer
/apidata.js
: extractapi.pl
142 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
143 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
146 dinstall
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
147 dpkg
-i
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
151 rm -f
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
152 make
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
154 ${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 verify-images
157 rsync
-a debian
/ build
/debian
158 cp pve-docs-mediawiki-import build
/debian
/tree
/pve-docs-mediawiki
/pve-docs-mediawiki-import
159 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/debian
/SOURCE
160 # install files for pve-doc-generator package
161 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
162 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
163 mkdir
-p build
/usr
/bin
164 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
165 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
166 # install asciidoc-pve
167 install -m
0755 asciidoc-pve build
/usr
/bin
/
168 install -D
-m
0644 asciidoc
/mediawiki.conf build
/usr
/share
/${GEN_PACKAGE}/asciidoc
/mediawiki.conf
169 install -m
0644 asciidoc
/asciidoc-pve.conf build
/usr
/share
/${GEN_PACKAGE}/asciidoc
/
170 install -m
0644 asciidoc
/pve-html.conf build
/usr
/share
/${GEN_PACKAGE}/asciidoc
/
171 # install files for pvedocs package
172 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
173 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
174 install -m
0644 index.html
${INDEX_INCLUDES} build
/usr
/share
/${DOC_PACKAGE}
175 install -m
0644 ${WIKI_IMPORTS} build
/usr
/share
/${DOC_PACKAGE}
176 # install screenshot images
177 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}/images
/screenshot
178 install -m
0644 images
/screenshot
/*.png build
/usr
/share
/${DOC_PACKAGE}/images
/screenshot
179 # install api doc viewer
180 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
181 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
182 # build Debian packages
183 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
186 lintian
${MEDIAWIKI_DEB}
189 upload
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
190 tar cf
- ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
194 find .
-regex
'.*-\(opts\|synopsis\)\.adoc' -not
-name pmxcfs
.8-synopsis.adoc
-exec
rm -f \
{\
} \
;
195 rm -f api-viewer
/apidata.js
196 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
200 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 pve-admin-guide-docinfo.xml
201 find .
-name
'*~' -exec
rm {} ';'