Makefile

   1 DGDIR=.
   2
   3 include ./pve-doc-generator.mk
   4
   5 GEN_PACKAGE=pve-doc-generator
   6 DOC_PACKAGE=pve-docs
   7
   8 # also update debian/changelog
   9 PKGREL=1
  10
  11 GITVERSION:=$(shell cat .git/refs/heads/master)
  12
  13 GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
  14 DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
  15
  16 COMMAND_LIST=           \
  17         pvesubscription \
  18         pvecm           \
  19         qm              \
  20         qmrestore       \
  21         pveceph         \
  22         pct             \
  23         pveam           \
  24         pvesm           \
  25         pveum           \
  26         vzdump          \
  27         ha-manager
  28
  29 SERVICE_LIST=           \
  30         pve-firewall    \
  31         pve-ha-crm      \
  32         pve-ha-lrm      \
  33         pvestatd        \
  34         pmxcfs          \
  35         pveproxy        \
  36         spiceproxy      \
  37         pvedaemon
  38
  39 CONFIG_LIST=datacenter.cfg qm.conf pct.conf
  40
  41 GEN_DEB_SOURCES=                                \
  42         pve-doc-generator.mk                    \
  43         attributes.txt                          \
  44         $(addsuffix .adoc, ${COMMAND_LIST})     \
  45         $(addsuffix .adoc, ${SERVICE_LIST})     \
  46         $(addsuffix .adoc, ${CONFIG_LIST})      \
  47         pve-storage-dir.adoc                    \
  48         pve-storage-glusterfs.adoc              \
  49         pve-storage-iscsi.adoc                  \
  50         pve-storage-iscsidirect.adoc            \
  51         pve-storage-lvm.adoc                    \
  52         pve-storage-nfs.adoc                    \
  53         pve-storage-rbd.adoc                    \
  54         pve-storage-zfspool.adoc                \
  55         pmxcfs.8-cli.adoc                       \
  56         pve-copyright.adoc                      \
  57         docinfo.xml
  58
  59 GEN_SCRIPTS=                                    \
  60         gen-datacenter.cfg.5-opts.pl            \
  61         gen-pct.conf.5-opts.pl                  \
  62         gen-qm.conf.5-opts.pl                   \
  63         gen-vzdump.conf.5-opts.pl               \
  64         gen-pve-firewall-cluster-opts.pl        \
  65         gen-pve-firewall-host-opts.pl           \
  66         gen-pve-firewall-macros-adoc.pl         \
  67         gen-pve-firewall-rules-opts.pl          \
  68         gen-pve-firewall-vm-opts.pl
  69
  70 SYSADMIN_SOURCES=                               \
  71         getting-help.adoc                       \
  72         pve-package-repos.adoc                  \
  73         pve-installation.adoc                   \
  74         system-software-updates.adoc            \
  75         sysadmin.adoc
  76
  77 API_VIEWER_SOURCES=                             \
  78         api-viewer/index.html                   \
  79         api-viewer/apidoc.js
  80
  81 PVE_ADMIN_GUIDE_SOURCES=                        \
  82         ${DATACENTER_CONF_MAN5_SOURCES}         \
  83         ${QM_CONF_MAN5_SOURCES}                 \
  84         ${PCT_CONF_MAN5_SOURCES}                \
  85         ${SYSADMIN_SOURCES}                     \
  86         pve-admin-guide.adoc                    \
  87         pve-intro.adoc                          \
  88         pmxcfs.adoc                             \
  89         pmxcfs.8-cli.adoc                       \
  90         pve-faq.adoc                            \
  91         ${PVE_FIREWALL_MAN8_SOURCES}            \
  92         ${PVESM_MAN1_SOURCES}                   \
  93         ${PCT_MAN1_SOURCES}                     \
  94         ${PVECM_MAN1_SOURCES}                   \
  95         ${PVEUM_MAN1_SOURCES}                   \
  96         ${QM_MAN1_SOURCES}                      \
  97         ${QMRESTORE_MAN1_SOURCES}               \
  98         ${HA_MANAGER_MAN1_SOURCES}              \
  99         ${PVESTATD_MAN8_SOURCES}                \
 100         ${PVEDAEMON_MAN8_SOURCES}               \
 101         ${PVEPROXY_MAN8_SOURCES}                \
 102         ${SPICEPROXY_MAN8_SOURCES}              \
 103         ${PVE_HA_CRM_MAN8_SOURCES}              \
 104         ${PVE_HA_LRM_MAN8_SOURCES}              \
 105         ${VZDUMP_MAN1_SOURCES}                  \
 106         ${PVEAM_MAN1_SOURCES}                   \
 107         ${PVESUBSCRIPTION_MAN1_SOURCES}         \
 108         ${PVECEPH_MAN1_SOURCES}                 \
 109         images/cluster-nwdiag.svg               \
 110         images/node-nwdiag.svg                  \
 111         pve-bibliography.adoc                   \
 112         $(addsuffix .adoc, ${COMMAND_LIST})     \
 113         $(addsuffix .adoc, ${SERVICE_LIST})     \
 114         $(addsuffix .adoc, ${CONFIG_LIST})      \
 115         GFDL.adoc                               \
 116         attributes.txt
 117
 118 ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)"
 119 ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
 120 ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
 121 ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
 122
 123 BROWSER?=xdg-open
 124
 125 all: pve-admin-guide.html
 126
 127 %-nwdiag.svg: %.nwdiag
 128         nwdiag -T svg $*.nwdiag -o $@;
 129
 130 %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
 131         asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
 132         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 133
 134
 135 pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
 136         asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
 137         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 138
 139 %.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
 140         asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
 141         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 142
 143 %.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
 144         asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
 145         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 146
 147 index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
 148         $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
 149         $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
 150         asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
 151         test -n "$${NOVIEW}" || $(BROWSER) index.html &
 152
 153 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
 154         asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
 155         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 156
 157 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
 158         grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in  pve-admin-guide-docinfo.xml" && false);
 159         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" pve-admin-guide.adoc
 160         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 161
 162 pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
 163         a2x -f epub pve-admin-guide.adoc
 164         test -n "$${NOVIEW}" || $(BROWSER) $@ &
 165
 166 api-viewer/apidata.js: extractapi.pl
 167         ./extractapi.pl >$@
 168
 169 api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
 170         cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
 171
 172 .PHONY: dinstall
 173 dinstall: ${GEN_DEB} ${DOC_DEB}
 174         dpkg -i ${GEN_DEB} ${DOC_DEB}
 175
 176
 177 .PHONY: deb
 178 deb:
 179         rm -f ${GEN_DEB} ${DOC_DEB};
 180         make ${GEN_DEB};
 181         make ${DOC_DEB};
 182
 183 DOC_DEB_FILES=                                  \
 184         $(addsuffix .1.html, ${COMMAND_LIST})   \
 185         $(addsuffix .8.html, ${SERVICE_LIST})   \
 186         $(addsuffix .5.html, ${CONFIG_LIST})    \
 187         pve-admin-guide.pdf     \
 188         pve-admin-guide.html    \
 189         pve-admin-guide.epub    \
 190         index.html
 191
 192 ${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
 193         $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
 194         $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
 195         asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
 196         rm -rf build
 197         mkdir build
 198         rsync -a doc-debian/ build/debian
 199         mkdir -p build/usr/share/${DOC_PACKAGE}
 200         mkdir -p build/usr/share/doc/${DOC_PACKAGE}
 201         echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${DOC_PACKAGE}/SOURCE
 202         # install doc files
 203         install -m 0644 ${DOC_DEB_FILES} build/usr/share/${DOC_PACKAGE}
 204         # install api doc viewer
 205         mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
 206         install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
 207         cd build; dpkg-buildpackage -rfakeroot -b -us -uc
 208         lintian ${DOC_DEB}
 209
 210 ${GEN_DEB}: ${GEN_DEB_SOURCES}
 211         rm -rf build
 212         mkdir build
 213         rsync -a debian/ build/debian
 214         mkdir -p build/usr/share/${GEN_PACKAGE}
 215         mkdir -p build/usr/share/doc/${GEN_PACKAGE}
 216         echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${GEN_PACKAGE}/SOURCE
 217         install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
 218         install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
 219         cd build; dpkg-buildpackage -rfakeroot -b -us -uc
 220         lintian ${GEN_DEB}
 221
 222 .PHONY: upload
 223 upload: ${GEN_DEB} ${DOC_DEB}
 224         umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw
 225         mkdir -p /pve/${DOCRELEASE}/extra
 226         rm -f /pve/${DOCRELEASE}/extra/${GEN_PACKAGE}_*.deb
 227         rm -f /pve/${DOCRELEASE}/extra/${DOC_PACKAGE}_*.deb
 228         rm -f /pve/${DOCRELEASE}/extra/Packages*
 229         cp ${GEN_DEB} ${DOC_DEB} /pve/${DOCRELEASE}/extra
 230         cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz
 231         umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro
 232
 233 update: clean
 234         rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
 235         make all
 236
 237 clean:
 238         rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidata.js api-viewer/apidoc.js
 239