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