Makefile

   1 DGDIR=.
   2
   3 include ./pve-doc-generator.mk
   4
   5 GEN_PACKAGE=pve-doc-generator
   6 DOC_PACKAGE=pve-docs
   7 MEDIAWIKI_PACKAGE=pve-docs-mediawiki
   8
   9 # also update debian/changelog
  10 PKGREL=3
  11
  12 GITVERSION:=$(shell cat .git/refs/heads/master)
  13
  14 ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
  15
  16 GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
  17 DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
  18 MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
  19
  20 CHAPTER_LIST=           \
  21         pve-installation        \
  22         sysadmin        \
  23         pvecm           \
  24         pmxcfs          \
  25         pvesm           \
  26         qm              \
  27         pve-firewall    \
  28         pveum           \
  29         pct             \
  30         ha-manager      \
  31         vzdump          \
  32         pve-faq         \
  33         pve-bibliography
  34
  35 STORAGE_TYPES=          \
  36         dir             \
  37         glusterfs       \
  38         iscsi           \
  39         iscsidirect     \
  40         lvm             \
  41         lvmthin         \
  42         nfs             \
  43         rbd             \
  44         zfspool
  45
  46 COMMAND_LIST=           \
  47         pvesubscription \
  48         pvecm           \
  49         qm              \
  50         qmrestore       \
  51         pveceph         \
  52         pct             \
  53         pveam           \
  54         pvesm           \
  55         pveum           \
  56         vzdump          \
  57         ha-manager
  58
  59 SERVICE_LIST=           \
  60         pve-firewall    \
  61         pve-ha-crm      \
  62         pve-ha-lrm      \
  63         pvestatd        \
  64         pmxcfs          \
  65         pveproxy        \
  66         spiceproxy      \
  67         pvedaemon
  68
  69 CONFIG_LIST=datacenter.cfg qm.conf pct.conf
  70
  71 GEN_DEB_SOURCES=                                \
  72         pve-doc-generator.mk                    \
  73         attributes.txt                          \
  74         $(addsuffix .adoc, ${COMMAND_LIST})     \
  75         $(addsuffix .adoc, ${SERVICE_LIST})     \
  76         $(addsuffix .adoc, ${CONFIG_LIST})      \
  77         pve-storage-dir.adoc                    \
  78         pve-storage-glusterfs.adoc              \
  79         pve-storage-iscsi.adoc                  \
  80         pve-storage-iscsidirect.adoc            \
  81         pve-storage-lvm.adoc                    \
  82         pve-storage-lvmthin.adoc                \
  83         pve-storage-nfs.adoc                    \
  84         pve-storage-rbd.adoc                    \
  85         pve-storage-zfspool.adoc                \
  86         pmxcfs.8-cli.adoc                       \
  87         pve-copyright.adoc                      \
  88         docinfo.xml
  89
  90 GEN_SCRIPTS=                                    \
  91         gen-datacenter.cfg.5-opts.pl            \
  92         gen-pct.conf.5-opts.pl                  \
  93         gen-pct-network-opts.pl                 \
  94         gen-pct-mountpoint-opts.pl              \
  95         gen-qm.conf.5-opts.pl                   \
  96         gen-vzdump.conf.5-opts.pl               \
  97         gen-pve-firewall-cluster-opts.pl        \
  98         gen-pve-firewall-host-opts.pl           \
  99         gen-pve-firewall-macros-adoc.pl         \
 100         gen-pve-firewall-rules-opts.pl          \
 101         gen-pve-firewall-vm-opts.pl
 102
 103 INSTALLATION_SOURCES=                           \
 104         pve-usbstick.adoc                       \
 105         pve-system-requirements.adoc            \
 106         pve-installation.adoc
 107
 108 SYSADMIN_PARTS=                                 \
 109         pve-network                             \
 110         pve-package-repos                       \
 111         system-software-updates                 \
 112         pve-disk-health-monitoring              \
 113         local-lvm                               \
 114         local-zfs
 115
 116 SYSADMIN_SOURCES=                               \
 117         $(addsuffix .adoc, ${SYSADMIN_PARTS})   \
 118         sysadmin.adoc
 119
 120 API_VIEWER_SOURCES=                             \
 121         api-viewer/index.html                   \
 122         api-viewer/apidoc.js
 123
 124 PVE_ADMIN_GUIDE_SOURCES=                        \
 125         ${DATACENTER_CONF_MAN5_SOURCES}         \
 126         ${QM_CONF_MAN5_SOURCES}                 \
 127         ${PCT_CONF_MAN5_SOURCES}                \
 128         ${SYSADMIN_SOURCES}                     \
 129         pve-admin-guide.adoc                    \
 130         pve-intro.adoc                          \
 131         getting-help.adoc                       \
 132         ${INSTALLATION_SOURCES}                 \
 133         pmxcfs.adoc                             \
 134         pmxcfs.8-cli.adoc                       \
 135         pve-faq.adoc                            \
 136         ${PVE_FIREWALL_MAN8_SOURCES}            \
 137         ${PVESM_MAN1_SOURCES}                   \
 138         ${PCT_MAN1_SOURCES}                     \
 139         ${PVECM_MAN1_SOURCES}                   \
 140         ${PVEUM_MAN1_SOURCES}                   \
 141         ${QM_MAN1_SOURCES}                      \
 142         ${QMRESTORE_MAN1_SOURCES}               \
 143         ${HA_MANAGER_MAN1_SOURCES}              \
 144         ${PVESTATD_MAN8_SOURCES}                \
 145         ${PVEDAEMON_MAN8_SOURCES}               \
 146         ${PVEPROXY_MAN8_SOURCES}                \
 147         ${SPICEPROXY_MAN8_SOURCES}              \
 148         ${PVE_HA_CRM_MAN8_SOURCES}              \
 149         ${PVE_HA_LRM_MAN8_SOURCES}              \
 150         ${VZDUMP_MAN1_SOURCES}                  \
 151         ${PVEAM_MAN1_SOURCES}                   \
 152         ${PVESUBSCRIPTION_MAN1_SOURCES}         \
 153         ${PVECEPH_MAN1_SOURCES}                 \
 154         pve-bibliography.adoc                   \
 155         $(addsuffix .adoc, ${COMMAND_LIST})     \
 156         $(addsuffix .adoc, ${SERVICE_LIST})     \
 157         $(addsuffix .adoc, ${CONFIG_LIST})      \
 158         GFDL.adoc                               \
 159         attributes.txt
 160
 161 link-refs.json: scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES}
 162         ./scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES} >link-refs.json
 163
 164 asciidoc-pve: asciidoc-pve.in link-refs.json
 165         cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
 166         chmod +x asciidoc-pve.tmp
 167         mv asciidoc-pve.tmp asciidoc-pve
 168
 169 WIKI_IMPORTS=                                                                   \
 170         section-pve-usbstick-plain.html                                         \
 171         section-getting-help-plain.html                                         \
 172         section-pve-system-requirements-plain.html                              \
 173         $(addsuffix -plain.html, $(addprefix sysadmin-, ${SYSADMIN_PARTS}))     \
 174         $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST}))        \
 175         $(addsuffix .5-plain.html, ${CONFIG_LIST})                              \
 176         $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES}))
 177
 178 INDEX_INCLUDES=                                                         \
 179         pve-admin-guide.pdf                                             \
 180         pve-admin-guide.html                                            \
 181         pve-admin-guide.epub                                            \
 182         $(addsuffix .1.html, ${COMMAND_LIST})                           \
 183         $(addsuffix .8.html, ${SERVICE_LIST})                           \
 184         $(addsuffix .5.html, ${CONFIG_LIST})                            \
 185         $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
 186
 187 ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
 188 ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG}
 189 ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG}
 190 ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG}
 191
 192 BROWSER?=xdg-open
 193
 194 all: index.html
 195
 196 %-nwdiag.svg: %.nwdiag
 197         nwdiag -T svg $*.nwdiag -o $@;
 198
 199 sysadmin-%-plain.html: %.adoc
 200         asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
 201
 202 section-%-plain.html: %.adoc
 203         asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
 204
 205 chapter-sysadmin.html chapter-sysadmin-plain.html: ${SYSADMIN_SOURCES}
 206
 207 chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
 208         asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc
 209
 210 chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
 211         asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc
 212
 213 pve-storage-%-plain.html: pve-storage-%.adoc ${PVE_COMMON_DOC_SOURCES}
 214         asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ pve-storage-$*.adoc
 215
 216 %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
 217         asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
 218
 219 pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
 220         asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
 221
 222 %.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
 223         asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
 224
 225 %.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
 226         asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
 227
 228 %.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
 229         asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
 230
 231 README.html: README.adoc
 232         asciidoc ${ADOC_STDARG} -o $@ $<
 233
 234 .PHONY: index
 235 index: index.html
 236         $(BROWSER) index.html &
 237
 238 index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
 239         asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
 240
 241 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
 242         asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
 243
 244 pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
 245         rm -rf pve-admin-guide.chunked
 246         a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
 247
 248 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
 249         inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
 250         inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
 251         grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in  pve-admin-guide-docinfo.xml" && false);
 252         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
 253         rm proxmox-logo.pdf proxmox-ci-header.pdf
 254
 255 pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
 256         a2x -f epub pve-admin-guide.adoc
 257
 258 api-viewer/apidata.js: extractapi.pl
 259         ./extractapi.pl >$@
 260
 261 api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
 262         cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
 263
 264 .PHONY: dinstall
 265 dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 266         dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 267
 268 .PHONY: deb
 269 deb:
 270         rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
 271         make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
 272
 273 ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES}
 274         rm -rf build
 275         mkdir build
 276         rsync -a debian/ build/debian
 277         echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
 278         # install files for pve-doc-generator package
 279         mkdir -p build/usr/share/${GEN_PACKAGE}
 280         mkdir -p build/usr/share/doc/${GEN_PACKAGE}
 281         install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
 282         install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
 283         # install files for pvedocs package
 284         mkdir -p build/usr/share/${DOC_PACKAGE}
 285         mkdir -p build/usr/share/doc/${DOC_PACKAGE}
 286         install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE}
 287         install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE}
 288         # install api doc viewer
 289         mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
 290         install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
 291         # build Debian packages
 292         cd build; dpkg-buildpackage -rfakeroot -b -us -uc
 293         lintian ${GEN_DEB}
 294         lintian ${DOC_DEB}
 295         lintian ${MEDIAWIKI_DEB}
 296
 297 .PHONY: upload
 298 upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 299         tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
 300
 301 .PHONY: update
 302 update: clean
 303         rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc
 304         rm -f api-viewer/apidata.js
 305         rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
 306         make all
 307
 308 clean:
 309         rm -rf *.tmp.xml *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html chapter-*-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json
 310         find . -name '*~' -exec rm {} ';'