[pve-docs.git] / pve-doc-generator.mk

# also update debian/changelog
DOCRELEASE=4.1

DGDIR?=/usr/share/pve-doc-generator

all:

PVE_COMMON_DOC_SOURCES=			\
	attributes.txt 			\
	pve-copyright.adoc		\
	docinfo.xml

PVECM_MAN1_SOURCES=			\
	pvecm.adoc			\
	pvecm.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVE_FIREWALL_MAN8_SOURCES=		\
	pve-firewall.adoc 		\
	pve-firewall.8-synopsis.adoc 	\
	pve-firewall-cluster-opts.adoc 	\
	pve-firewall-host-opts.adoc 	\
	pve-firewall-vm-opts.adoc 	\
	pve-firewall-rules-opts.adoc	\
	pve-firewall-macros.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PVESM_MAN1_SOURCES=			\
	pvesm.adoc			\
	pvesm.1-synopsis.adoc		\
	pve-storage-dir.adoc		\
	pve-storage-glusterfs.adoc	\
	pve-storage-iscsi.adoc		\
	pve-storage-iscsidirect.adoc	\
	pve-storage-lvm.adoc		\
	pve-storage-nfs.adoc		\
	pve-storage-rbd.adoc		\
	pve-storage-zfspool.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PCT_MAN1_SOURCES=			\
	pct.adoc 			\
	pct.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PCT_CONF_MAN5_SOURCES=			\
	pct.conf.adoc 			\
	pct.conf.5-opts.adoc		\
	${PVE_COMMON_DOC_SOURCES}

DATACENTER_CONF_MAN5_SOURCES=		\
	datacenter.cfg.adoc 		\
	datacenter.cfg.5-opts.adoc	\
	${PVE_COMMON_DOC_SOURCES}

QM_MAN1_SOURCES=			\
	qm.adoc 			\
	qm.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

QM_CONF_MAN5_SOURCES=			\
	qm.conf.adoc 			\
	qm.conf.5-opts.adoc		\
	${PVE_COMMON_DOC_SOURCES}

QMRESTORE_MAN1_SOURCES=			\
	qmrestore.adoc 			\
	qmrestore.1-synopsis.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PVEUM_MAN1_SOURCES=			\
	pveum.adoc 			\
	pveum.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

HA_MANAGER_MAN1_SOURCES=			\
	ha-manager.adoc 			\
	ha-manager.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVE_HA_CRM_MAN8_SOURCES=			\
	pve-ha-crm.adoc				\
	pve-ha-crm.8-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVE_HA_LRM_MAN8_SOURCES=			\
	pve-ha-lrm.adoc				\
	pve-ha-lrm.8-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVESTATD_MAN8_SOURCES=			\
	pvestatd.adoc			\
	pvestatd.8-synopsis.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PVEDAEMON_MAN8_SOURCES=			\
	pvedaemon.adoc			\
	pvedaemon.8-synopsis.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PVEPROXY_MAN8_SOURCES=			\
	pveproxy.adoc			\
	pveproxy.8-synopsis.adoc	\
	${PVE_COMMON_DOC_SOURCES}

SPICEPROXY_MAN8_SOURCES=		\
	spiceproxy.adoc			\
	spiceproxy.8-synopsis.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PMXCFS_MAN8_SOURCES=			\
	pmxcfs.adoc			\
	pmxcfs.8-cli.adoc		\
	${PVE_COMMON_DOC_SOURCES}

attributes.txt docinfo.xml:
	cp ${DGDIR}/$@ $@.tmp
	mv $@.tmp $@

%-opts.adoc: ${DGDIR}/gen-%-opts.pl
	${DGDIR}/gen-$*-opts.pl >$@.tmp
	mv $@.tmp $@

%.adoc: ${DGDIR}/gen-%-adoc.pl
	${DGDIR}/gen-$*-adoc.pl >$@.tmp
	mv $@.tmp $@

%.1-synopsis.adoc:
	perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
	mv $@.tmp $@

%.8-synopsis.adoc:
	perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
	mv $@.tmp $@

ifneq (${DGDIR},.)
%.adoc: ${DGDIR}/%.adoc
	cp $< $@.tmp
	mv $@.tmp $@
endif

A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"

pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
	test -n "$${NOVIEW}" || man -l $@

pvesm.1: ${PVESM_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
	test -n "$${NOVIEW}" || man -l $@

pct.1: ${PCT_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} pct.adoc
	test -n "$${NOVIEW}" || man -l $@

qm.1: ${QM_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} qm.adoc
	test -n "$${NOVIEW}" || man -l $@

qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
	test -n "$${NOVIEW}" || man -l $@

pvecm.1: ${PVECM_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
	test -n "$${NOVIEW}" || man -l $@

pveum.1: ${PVEUM_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} pveum.adoc
	test -n "$${NOVIEW}" || man -l $@

ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
	test -n "$${NOVIEW}" || man -l $@

pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
	test -n "$${NOVIEW}" || man -l $@

pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
	test -n "$${NOVIEW}" || man -l $@

pvestatd.8: ${PVESTATD_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
	test -n "$${NOVIEW}" || man -l $@

pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
	test -n "$${NOVIEW}" || man -l $@

pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
	test -n "$${NOVIEW}" || man -l $@

spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
	test -n "$${NOVIEW}" || man -l $@

pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
	a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
	test -n "$${NOVIEW}" || man -l $@

qm.conf.5: ${QM_CONF_MAN5_SOURCES}

pct.conf.5: ${PCT_CONF_MAN5_SOURCES}

datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}

%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
	a2x ${A2X_MAN5_OPTIONS} $*.adoc
	test -n "$${NOVIEW}" || man -l $@

.PHONY: cleanup-docgen
cleanup-docgen:
	rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
Commit	Line	Data
	1	# also update debian/changelog
	2	DOCRELEASE=4.1
	3
	4	DGDIR?=/usr/share/pve-doc-generator
	5
	6	all:
	7
	8	PVE_COMMON_DOC_SOURCES= \
	9	attributes.txt \
	10	pve-copyright.adoc \
	11	docinfo.xml
	12
	13	PVECM_MAN1_SOURCES= \
	14	pvecm.adoc \
	15	pvecm.1-synopsis.adoc \
	16	${PVE_COMMON_DOC_SOURCES}
	17
	18	PVE_FIREWALL_MAN8_SOURCES= \
	19	pve-firewall.adoc \
	20	pve-firewall.8-synopsis.adoc \
	21	pve-firewall-cluster-opts.adoc \
	22	pve-firewall-host-opts.adoc \
	23	pve-firewall-vm-opts.adoc \
	24	pve-firewall-rules-opts.adoc \
	25	pve-firewall-macros.adoc \
	26	${PVE_COMMON_DOC_SOURCES}
	27
	28	PVESM_MAN1_SOURCES= \
	29	pvesm.adoc \
	30	pvesm.1-synopsis.adoc \
	31	pve-storage-dir.adoc \
	32	pve-storage-glusterfs.adoc \
	33	pve-storage-iscsi.adoc \
	34	pve-storage-iscsidirect.adoc \
	35	pve-storage-lvm.adoc \
	36	pve-storage-nfs.adoc \
	37	pve-storage-rbd.adoc \
	38	pve-storage-zfspool.adoc \
	39	${PVE_COMMON_DOC_SOURCES}
	40
	41	PCT_MAN1_SOURCES= \
	42	pct.adoc \
	43	pct.1-synopsis.adoc \
	44	${PVE_COMMON_DOC_SOURCES}
	45
	46	PCT_CONF_MAN5_SOURCES= \
	47	pct.conf.adoc \
	48	pct.conf.5-opts.adoc \
	49	${PVE_COMMON_DOC_SOURCES}
	50
	51	DATACENTER_CONF_MAN5_SOURCES= \
	52	datacenter.cfg.adoc \
	53	datacenter.cfg.5-opts.adoc \
	54	${PVE_COMMON_DOC_SOURCES}
	55
	56	QM_MAN1_SOURCES= \
	57	qm.adoc \
	58	qm.1-synopsis.adoc \
	59	${PVE_COMMON_DOC_SOURCES}
	60
	61	QM_CONF_MAN5_SOURCES= \
	62	qm.conf.adoc \
	63	qm.conf.5-opts.adoc \
	64	${PVE_COMMON_DOC_SOURCES}
	65
	66	QMRESTORE_MAN1_SOURCES= \
	67	qmrestore.adoc \
	68	qmrestore.1-synopsis.adoc \
	69	${PVE_COMMON_DOC_SOURCES}
	70
	71	PVEUM_MAN1_SOURCES= \
	72	pveum.adoc \
	73	pveum.1-synopsis.adoc \
	74	${PVE_COMMON_DOC_SOURCES}
	75
	76	HA_MANAGER_MAN1_SOURCES= \
	77	ha-manager.adoc \
	78	ha-manager.1-synopsis.adoc \
	79	${PVE_COMMON_DOC_SOURCES}
	80
	81	PVE_HA_CRM_MAN8_SOURCES= \
	82	pve-ha-crm.adoc \
	83	pve-ha-crm.8-synopsis.adoc \
	84	${PVE_COMMON_DOC_SOURCES}
	85
	86	PVE_HA_LRM_MAN8_SOURCES= \
	87	pve-ha-lrm.adoc \
	88	pve-ha-lrm.8-synopsis.adoc \
	89	${PVE_COMMON_DOC_SOURCES}
	90
	91	PVESTATD_MAN8_SOURCES= \
	92	pvestatd.adoc \
	93	pvestatd.8-synopsis.adoc \
	94	${PVE_COMMON_DOC_SOURCES}
	95
	96	PVEDAEMON_MAN8_SOURCES= \
	97	pvedaemon.adoc \
	98	pvedaemon.8-synopsis.adoc \
	99	${PVE_COMMON_DOC_SOURCES}
	100
	101	PVEPROXY_MAN8_SOURCES= \
	102	pveproxy.adoc \
	103	pveproxy.8-synopsis.adoc \
	104	${PVE_COMMON_DOC_SOURCES}
	105
	106	SPICEPROXY_MAN8_SOURCES= \
	107	spiceproxy.adoc \
	108	spiceproxy.8-synopsis.adoc \
	109	${PVE_COMMON_DOC_SOURCES}
	110
	111	PMXCFS_MAN8_SOURCES= \
	112	pmxcfs.adoc \
	113	pmxcfs.8-cli.adoc \
	114	${PVE_COMMON_DOC_SOURCES}
	115
	116	attributes.txt docinfo.xml:
	117	cp ${DGDIR}/$@ $@.tmp
	118	mv $@.tmp $@
	119
	120	%-opts.adoc: ${DGDIR}/gen-%-opts.pl
	121	${DGDIR}/gen-$*-opts.pl >$@.tmp
	122	mv $@.tmp $@
	123
	124	%.adoc: ${DGDIR}/gen-%-adoc.pl
	125	${DGDIR}/gen-$*-adoc.pl >$@.tmp
	126	mv $@.tmp $@
	127
	128	%.1-synopsis.adoc:
	129	perl -I. -e "use PVE::CLI::$(subst -,_,$);print PVE::CLI::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	130	mv $@.tmp $@
	131
	132	%.8-synopsis.adoc:
	133	perl -I. -e "use PVE::Service::$(subst -,_,$);print PVE::Service::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	134	mv $@.tmp $@
	135
	136	ifneq (${DGDIR},.)
	137	%.adoc: ${DGDIR}/%.adoc
	138	cp $< $@.tmp
	139	mv $@.tmp $@
	140	endif
	141
	142	A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
	143	A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
	144	A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
	145	A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
	146
	147	pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
	148	a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
	149	test -n "$${NOVIEW}" \|\| man -l $@
	150
	151	pvesm.1: ${PVESM_MAN1_SOURCES}
	152	a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
	153	test -n "$${NOVIEW}" \|\| man -l $@
	154
	155	pct.1: ${PCT_MAN1_SOURCES}
	156	a2x ${A2X_MAN1_OPTIONS} pct.adoc
	157	test -n "$${NOVIEW}" \|\| man -l $@
	158
	159	qm.1: ${QM_MAN1_SOURCES}
	160	a2x ${A2X_MAN1_OPTIONS} qm.adoc
	161	test -n "$${NOVIEW}" \|\| man -l $@
	162
	163	qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
	164	a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
	165	test -n "$${NOVIEW}" \|\| man -l $@
	166
	167	pvecm.1: ${PVECM_MAN1_SOURCES}
	168	a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
	169	test -n "$${NOVIEW}" \|\| man -l $@
	170
	171	pveum.1: ${PVEUM_MAN1_SOURCES}
	172	a2x ${A2X_MAN1_OPTIONS} pveum.adoc
	173	test -n "$${NOVIEW}" \|\| man -l $@
	174
	175	ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
	176	a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
	177	test -n "$${NOVIEW}" \|\| man -l $@
	178
	179	pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
	180	a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
	181	test -n "$${NOVIEW}" \|\| man -l $@
	182
	183	pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
	184	a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
	185	test -n "$${NOVIEW}" \|\| man -l $@
	186
	187	pvestatd.8: ${PVESTATD_MAN8_SOURCES}
	188	a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
	189	test -n "$${NOVIEW}" \|\| man -l $@
	190
	191	pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
	192	a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
	193	test -n "$${NOVIEW}" \|\| man -l $@
	194
	195	pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
	196	a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
	197	test -n "$${NOVIEW}" \|\| man -l $@
	198
	199	spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
	200	a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
	201	test -n "$${NOVIEW}" \|\| man -l $@
	202
	203	pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
	204	a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
	205	test -n "$${NOVIEW}" \|\| man -l $@
	206
	207	qm.conf.5: ${QM_CONF_MAN5_SOURCES}
	208
	209	pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
	210
	211	datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
	212
	213	%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
	214	a2x ${A2X_MAN5_OPTIONS} $*.adoc
	215	test -n "$${NOVIEW}" \|\| man -l $@
	216
	217	.PHONY: cleanup-docgen
	218	cleanup-docgen:
	219	rm -f .1 .5 .8 .adoc attributes.txt docinfo.xml