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
23 ADOC_SOURCES_GUESS
=$(filter-out %-synopsis.adoc
%-opts.adoc
%-table.adoc
, $(wildcard *.adoc
))
24 .pve-doc-depends link-refs.json
: ${ADOC_SOURCES_GUESS} scan-adoc-refs
25 .
/scan-adoc-refs
*.adoc
--depends .pve-doc-depends.tmp
> link-refs.json.tmp
26 @cmp
--quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends
27 @cmp
--quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
29 pve-doc-generator.mk
: .pve-doc-depends pve-doc-generator.mk.in
30 cat pve-doc-generator.mk.in .pve-doc-depends
> $@.tmp
33 include .
/pve-doc-generator.mk
36 pve-doc-generator.mk \
38 pmxcfs
.8-synopsis.adoc \
42 gen-datacenter.cfg
.5-opts.pl \
43 gen-pct.conf
.5-opts.pl \
44 gen-pct-network-opts.pl \
45 gen-pct-mountpoint-opts.pl \
46 gen-qm.conf
.5-opts.pl \
47 gen-vzdump.conf
.5-opts.pl \
48 gen-pve-firewall-cluster-opts.pl \
49 gen-pve-firewall-host-opts.pl \
50 gen-pve-firewall-macros-adoc.pl \
51 gen-pve-firewall-rules-opts.pl \
52 gen-pve-firewall-vm-opts.pl
55 api-viewer
/index.html \
58 asciidoc-pve
: asciidoc-pve.in link-refs.json
59 cat asciidoc-pve.in link-refs.json
>asciidoc-pve.tmp
60 sed
-e s
/@RELEASE@
/${DOCRELEASE}/ -i asciidoc-pve.tmp
61 chmod
+x asciidoc-pve.tmp
62 mv asciidoc-pve.tmp asciidoc-pve
64 pve-docs-mediawiki-import
: pve-docs-mediawiki-import.in link-refs.json
65 cat pve-docs-mediawiki-import.in link-refs.json
> pve-docs-mediawiki-import.tmp
66 chmod
+x pve-docs-mediawiki-import.tmp
67 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
71 pve-admin-guide.epub \
72 chapter-index-table.adoc \
73 man1-index-table.adoc \
74 man5-index-table.adoc \
75 man8-index-table.adoc \
76 $(sort $(addsuffix .html
, ${MANUAL_PAGES}) ${CHAPTER_LIST})
78 ADOC_STDARG
= -b html5
-a icons
-a data-uri
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}"
83 %-nwdiag.svg
: %.nwdiag
84 nwdiag
-T svg
$*.nwdiag
-o
$@
;
86 README.html
: README.adoc
87 asciidoc
${ADOC_STDARG} -o
$@
$<
91 $(BROWSER
) index.html
&
93 chapter-index-table.adoc
: asciidoc-pve
94 .
/asciidoc-pve chapter-table
>$@.tmp
97 man1-index-table.adoc
: asciidoc-pve
98 .
/asciidoc-pve man1page-table
>$@.tmp
101 man5-index-table.adoc
: asciidoc-pve
102 .
/asciidoc-pve man5page-table
>$@.tmp
105 man8-index-table.adoc
: asciidoc-pve
106 .
/asciidoc-pve man8page-table
>$@.tmp
109 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
110 asciidoc
${ADOC_STDARG} -o
$@ index.adoc
112 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
113 asciidoc
-a pvelogo
${ADOC_STDARG} pve-admin-guide.adoc
115 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
116 rm -rf pve-admin-guide.chunked
117 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
119 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
120 inkscape
-z
-D
--export-pdf
=proxmox-logo.pdf images
/proxmox-logo.svg
121 inkscape
-z
-D
--export-pdf
=proxmox-ci-header.pdf images
/proxmox-ci-header.svg
122 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
123 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
124 rm proxmox-logo.pdf proxmox-ci-header.pdf
126 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
127 a2x
-f epub pve-admin-guide.adoc
129 api-viewer
/apidata.js
: extractapi.pl
132 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
133 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
136 dinstall
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
137 dpkg
-i
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
141 rm -f
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
142 make
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
144 ${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
147 rsync
-a debian
/ build
/debian
148 cp pve-docs-mediawiki-import build
/debian
/tree
/pve-docs-mediawiki
/pve-docs-mediawiki-import
149 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/debian
/SOURCE
150 # install files for pve-doc-generator package
151 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
152 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
153 mkdir
-p build
/usr
/bin
154 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
155 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
156 install -m
0755 asciidoc-pve build
/usr
/bin
/
157 install -D
-m
0644 asciidoc
/mediawiki.conf build
/etc
/asciidoc
/mediawiki.conf
158 # install files for pvedocs package
159 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
160 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
161 install -m
0644 index.html
${INDEX_INCLUDES} build
/usr
/share
/${DOC_PACKAGE}
162 install -m
0644 ${WIKI_IMPORTS} build
/usr
/share
/${DOC_PACKAGE}
163 # install api doc viewer
164 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
165 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
166 # build Debian packages
167 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
170 lintian
${MEDIAWIKI_DEB}
173 upload
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
174 tar cf
- ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
178 find .
-regex
'.*-\(opts\|synopsis\)\.adoc' -not
-name pmxcfs
.8-synopsis.adoc
-exec
rm -f \
{\
} \
;
179 rm -f api-viewer
/apidata.js
180 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
184 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
185 find .
-name
'*~' -exec
rm {} ';'