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