[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}

VZDUMP_MAN1_SOURCES=			\
	vzdump.adoc 			\
	vzdump.1-synopsis.adoc		\
	vzdump.conf.5-opts.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVESUBSCRIPTION_MAN1_SOURCES=		\
	pvesubscription.adoc		\
	pvesubscription.1-synopsis.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PVECEPH_MAN1_SOURCES=			\
	pveceph.adoc 			\
	pveceph.1-synopsis.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}

PVEAM_MAN1_SOURCES=			\
	pveam.adoc 			\
	pveam.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 $@

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

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

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

pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} pvesubscription.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 $@

pveam.1: ${PVEAM_MAN1_SOURCES}
	a2x ${A2X_MAN1_OPTIONS} pveam.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} 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	VZDUMP_MAN1_SOURCES= \
	42	vzdump.adoc \
	43	vzdump.1-synopsis.adoc \
	44	vzdump.conf.5-opts.adoc \
	45	${PVE_COMMON_DOC_SOURCES}
	46
	47	PVESUBSCRIPTION_MAN1_SOURCES= \
	48	pvesubscription.adoc \
	49	pvesubscription.1-synopsis.adoc \
	50	${PVE_COMMON_DOC_SOURCES}
	51
	52	PVECEPH_MAN1_SOURCES= \
	53	pveceph.adoc \
	54	pveceph.1-synopsis.adoc \
	55	${PVE_COMMON_DOC_SOURCES}
	56
	57	PCT_MAN1_SOURCES= \
	58	pct.adoc \
	59	pct.1-synopsis.adoc \
	60	${PVE_COMMON_DOC_SOURCES}
	61
	62	PCT_CONF_MAN5_SOURCES= \
	63	pct.conf.adoc \
	64	pct.conf.5-opts.adoc \
	65	${PVE_COMMON_DOC_SOURCES}
	66
	67	DATACENTER_CONF_MAN5_SOURCES= \
	68	datacenter.cfg.adoc \
	69	datacenter.cfg.5-opts.adoc \
	70	${PVE_COMMON_DOC_SOURCES}
	71
	72	QM_MAN1_SOURCES= \
	73	qm.adoc \
	74	qm.1-synopsis.adoc \
	75	${PVE_COMMON_DOC_SOURCES}
	76
	77	QM_CONF_MAN5_SOURCES= \
	78	qm.conf.adoc \
	79	qm.conf.5-opts.adoc \
	80	${PVE_COMMON_DOC_SOURCES}
	81
	82	QMRESTORE_MAN1_SOURCES= \
	83	qmrestore.adoc \
	84	qmrestore.1-synopsis.adoc \
	85	${PVE_COMMON_DOC_SOURCES}
	86
	87	PVEUM_MAN1_SOURCES= \
	88	pveum.adoc \
	89	pveum.1-synopsis.adoc \
	90	${PVE_COMMON_DOC_SOURCES}
	91
	92	PVEAM_MAN1_SOURCES= \
	93	pveam.adoc \
	94	pveam.1-synopsis.adoc \
	95	${PVE_COMMON_DOC_SOURCES}
	96
	97	HA_MANAGER_MAN1_SOURCES= \
	98	ha-manager.adoc \
	99	ha-manager.1-synopsis.adoc \
	100	${PVE_COMMON_DOC_SOURCES}
	101
	102	PVE_HA_CRM_MAN8_SOURCES= \
	103	pve-ha-crm.adoc \
	104	pve-ha-crm.8-synopsis.adoc \
	105	${PVE_COMMON_DOC_SOURCES}
	106
	107	PVE_HA_LRM_MAN8_SOURCES= \
	108	pve-ha-lrm.adoc \
	109	pve-ha-lrm.8-synopsis.adoc \
	110	${PVE_COMMON_DOC_SOURCES}
	111
	112	PVESTATD_MAN8_SOURCES= \
	113	pvestatd.adoc \
	114	pvestatd.8-synopsis.adoc \
	115	${PVE_COMMON_DOC_SOURCES}
	116
	117	PVEDAEMON_MAN8_SOURCES= \
	118	pvedaemon.adoc \
	119	pvedaemon.8-synopsis.adoc \
	120	${PVE_COMMON_DOC_SOURCES}
	121
	122	PVEPROXY_MAN8_SOURCES= \
	123	pveproxy.adoc \
	124	pveproxy.8-synopsis.adoc \
	125	${PVE_COMMON_DOC_SOURCES}
	126
	127	SPICEPROXY_MAN8_SOURCES= \
	128	spiceproxy.adoc \
	129	spiceproxy.8-synopsis.adoc \
	130	${PVE_COMMON_DOC_SOURCES}
	131
	132	PMXCFS_MAN8_SOURCES= \
	133	pmxcfs.adoc \
	134	pmxcfs.8-cli.adoc \
	135	${PVE_COMMON_DOC_SOURCES}
	136
	137	attributes.txt docinfo.xml:
	138	cp ${DGDIR}/$@ $@.tmp
	139	mv $@.tmp $@
	140
	141	%-opts.adoc: ${DGDIR}/gen-%-opts.pl
	142	${DGDIR}/gen-$*-opts.pl >$@.tmp
	143	mv $@.tmp $@
	144
	145	%.adoc: ${DGDIR}/gen-%-adoc.pl
	146	${DGDIR}/gen-$*-adoc.pl >$@.tmp
	147	mv $@.tmp $@
	148
	149	%.1-synopsis.adoc:
	150	perl -I. -e "use PVE::CLI::$(subst -,_,$);print PVE::CLI::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	151	mv $@.tmp $@
	152
	153	%.8-synopsis.adoc:
	154	perl -I. -e "use PVE::Service::$(subst -,_,$);print PVE::Service::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	155	mv $@.tmp $@
	156
	157	ifneq (${DGDIR},.)
	158	%.adoc: ${DGDIR}/%.adoc
	159	cp $< $@.tmp
	160	mv $@.tmp $@
	161	endif
	162
	163	A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
	164	A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
	165	A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
	166	A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
	167
	168	pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
	169	a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
	170	test -n "$${NOVIEW}" \|\| man -l $@
	171
	172	pvesm.1: ${PVESM_MAN1_SOURCES}
	173	a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
	174	test -n "$${NOVIEW}" \|\| man -l $@
	175
	176	pveceph.1: ${PVECEPH_MAN1_SOURCES}
	177	a2x ${A2X_MAN1_OPTIONS} pveceph.adoc
	178	test -n "$${NOVIEW}" \|\| man -l $@
	179
	180	pct.1: ${PCT_MAN1_SOURCES}
	181	a2x ${A2X_MAN1_OPTIONS} pct.adoc
	182	test -n "$${NOVIEW}" \|\| man -l $@
	183
	184	vzdump.1: ${VZDUMP_MAN1_SOURCES}
	185	a2x ${A2X_MAN1_OPTIONS} vzdump.adoc
	186	test -n "$${NOVIEW}" \|\| man -l $@
	187
	188	pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
	189	a2x ${A2X_MAN1_OPTIONS} pvesubscription.adoc
	190	test -n "$${NOVIEW}" \|\| man -l $@
	191
	192	qm.1: ${QM_MAN1_SOURCES}
	193	a2x ${A2X_MAN1_OPTIONS} qm.adoc
	194	test -n "$${NOVIEW}" \|\| man -l $@
	195
	196	qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
	197	a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
	198	test -n "$${NOVIEW}" \|\| man -l $@
	199
	200	pvecm.1: ${PVECM_MAN1_SOURCES}
	201	a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
	202	test -n "$${NOVIEW}" \|\| man -l $@
	203
	204	pveum.1: ${PVEUM_MAN1_SOURCES}
	205	a2x ${A2X_MAN1_OPTIONS} pveum.adoc
	206	test -n "$${NOVIEW}" \|\| man -l $@
	207
	208	pveam.1: ${PVEAM_MAN1_SOURCES}
	209	a2x ${A2X_MAN1_OPTIONS} pveam.adoc
	210	test -n "$${NOVIEW}" \|\| man -l $@
	211
	212	ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
	213	a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
	214	test -n "$${NOVIEW}" \|\| man -l $@
	215
	216	pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
	217	a2x ${A2X_MAN8_OPTIONS} pve-ha-crm.adoc
	218	test -n "$${NOVIEW}" \|\| man -l $@
	219
	220	pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
	221	a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
	222	test -n "$${NOVIEW}" \|\| man -l $@
	223
	224	pvestatd.8: ${PVESTATD_MAN8_SOURCES}
	225	a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
	226	test -n "$${NOVIEW}" \|\| man -l $@
	227
	228	pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
	229	a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
	230	test -n "$${NOVIEW}" \|\| man -l $@
	231
	232	pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
	233	a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
	234	test -n "$${NOVIEW}" \|\| man -l $@
	235
	236	spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
	237	a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
	238	test -n "$${NOVIEW}" \|\| man -l $@
	239
	240	pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
	241	a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
	242	test -n "$${NOVIEW}" \|\| man -l $@
	243
	244	qm.conf.5: ${QM_CONF_MAN5_SOURCES}
	245
	246	pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
	247
	248	datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
	249
	250	%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
	251	a2x ${A2X_MAN5_OPTIONS} $*.adoc
	252	test -n "$${NOVIEW}" \|\| man -l $@
	253
	254	.PHONY: cleanup-docgen
	255	cleanup-docgen:
	256	rm -f .1 .5 .8 .adoc attributes.txt docinfo.xml