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

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 $@

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
bef0c1b4 DM	1	# also update debian/changelog
	2	DOCRELEASE=4.1
	3
9344ee0d DM	4	DGDIR?=/usr/share/pve-doc-generator
	5
	6	all:
	7
828a27f5 DM	8	PVE_COMMON_DOC_SOURCES= \
	9	attributes.txt \
	10	pve-copyright.adoc \
	11	docinfo.xml
	12
d8742b0c DM	13	PVECM_MAN1_SOURCES= \
	14	pvecm.adoc \
	15	pvecm.1-synopsis.adoc \
	16	${PVE_COMMON_DOC_SOURCES}
	17
9344ee0d DM	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 \
828a27f5 DM	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}
9344ee0d	40
f6b81378 DM	41	PCT_MAN1_SOURCES= \
	42	pct.adoc \
	43	pct.1-synopsis.adoc \
	44	${PVE_COMMON_DOC_SOURCES}
	45
672abac1	46	PCT_CONF_MAN5_SOURCES= \
6ec3cd20 DM	47	pct.conf.adoc \
	48	pct.conf.5-opts.adoc \
	49	${PVE_COMMON_DOC_SOURCES}
	50
672abac1 DM	51	DATACENTER_CONF_MAN5_SOURCES= \
	52	datacenter.cfg.adoc \
	53	datacenter.cfg.5-opts.adoc \
	54	${PVE_COMMON_DOC_SOURCES}
	55
7f8858a2 DM	56	QM_MAN1_SOURCES= \
	57	qm.adoc \
	58	qm.1-synopsis.adoc \
	59	${PVE_COMMON_DOC_SOURCES}
	60
672abac1	61	QM_CONF_MAN5_SOURCES= \
6ec3cd20 DM	62	qm.conf.adoc \
	63	qm.conf.5-opts.adoc \
	64	${PVE_COMMON_DOC_SOURCES}
	65
a5bb4c40 DM	66	QMRESTORE_MAN1_SOURCES= \
	67	qmrestore.adoc \
	68	qmrestore.1-synopsis.adoc \
	69	${PVE_COMMON_DOC_SOURCES}
	70
d7810cdb DM	71	PVEUM_MAN1_SOURCES= \
	72	pveum.adoc \
	73	pveum.1-synopsis.adoc \
	74	${PVE_COMMON_DOC_SOURCES}
	75
e26d2ff0 DM	76	HA_MANAGER_MAN1_SOURCES= \
	77	ha-manager.adoc \
	78	ha-manager.1-synopsis.adoc \
	79	${PVE_COMMON_DOC_SOURCES}
	80
47e1b0c6 DM	81	PVE_HA_CRM_MAN8_SOURCES= \
	82	pve-ha-crm.adoc \
	83	pve-ha-crm.8-synopsis.adoc \
	84	${PVE_COMMON_DOC_SOURCES}
	85
954a26fd DM	86	PVE_HA_LRM_MAN8_SOURCES= \
	87	pve-ha-lrm.adoc \
	88	pve-ha-lrm.8-synopsis.adoc \
	89	${PVE_COMMON_DOC_SOURCES}
	90
4db6a3f3 DM	91	PVESTATD_MAN8_SOURCES= \
	92	pvestatd.adoc \
	93	pvestatd.8-synopsis.adoc \
	94	${PVE_COMMON_DOC_SOURCES}
	95
9344ee0d DM	96	attributes.txt docinfo.xml:
	97	cp ${DGDIR}/$@ $@.tmp
	98	mv $@.tmp $@
	99
	100	%-opts.adoc: ${DGDIR}/gen-%-opts.pl
f6b81378	101	${DGDIR}/gen-$*-opts.pl >$@.tmp
9344ee0d DM	102	mv $@.tmp $@
	103
	104	%.adoc: ${DGDIR}/gen-%-adoc.pl
f6b81378	105	${DGDIR}/gen-$*-adoc.pl >$@.tmp
9344ee0d DM	106	mv $@.tmp $@
	107
	108	%.1-synopsis.adoc:
	109	perl -I. -e "use PVE::CLI::$(subst -,_,$);print PVE::CLI::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	110	mv $@.tmp $@
	111
	112	%.8-synopsis.adoc:
	113	perl -I. -e "use PVE::Service::$(subst -,_,$);print PVE::Service::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	114	mv $@.tmp $@
	115
f6b81378	116	ifneq (${DGDIR},.)
9344ee0d DM	117	%.adoc: ${DGDIR}/%.adoc
	118	cp $< $@.tmp
	119	mv $@.tmp $@
f6b81378	120	endif
9344ee0d	121
872bbc1b DM	122	A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
	123	A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
	124	A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
	125	A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
	126
9344ee0d	127	pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
872bbc1b	128	a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
9344ee0d DM	129	test -n "$${NOVIEW}" \|\| man -l $@
9344ee0d DM	130
828a27f5	131	pvesm.1: ${PVESM_MAN1_SOURCES}
872bbc1b	132	a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
828a27f5 DM	133	test -n "$${NOVIEW}" \|\| man -l $@
828a27f5 DM	134
f6b81378	135	pct.1: ${PCT_MAN1_SOURCES}
872bbc1b	136	a2x ${A2X_MAN1_OPTIONS} pct.adoc
f6b81378 DM	137	test -n "$${NOVIEW}" \|\| man -l $@
f6b81378 DM	138
7f8858a2	139	qm.1: ${QM_MAN1_SOURCES}
872bbc1b	140	a2x ${A2X_MAN1_OPTIONS} qm.adoc
7f8858a2 DM	141	test -n "$${NOVIEW}" \|\| man -l $@
7f8858a2 DM	142
a5bb4c40	143	qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
872bbc1b	144	a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
a5bb4c40 DM	145	test -n "$${NOVIEW}" \|\| man -l $@
a5bb4c40 DM	146
d8742b0c	147	pvecm.1: ${PVECM_MAN1_SOURCES}
872bbc1b	148	a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
d8742b0c DM	149	test -n "$${NOVIEW}" \|\| man -l $@
d8742b0c DM	150
d7810cdb	151	pveum.1: ${PVEUM_MAN1_SOURCES}
872bbc1b	152	a2x ${A2X_MAN1_OPTIONS} pveum.adoc
d7810cdb DM	153	test -n "$${NOVIEW}" \|\| man -l $@
d7810cdb DM	154
e26d2ff0	155	ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
872bbc1b	156	a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
e26d2ff0 DM	157	test -n "$${NOVIEW}" \|\| man -l $@
e26d2ff0 DM	158
47e1b0c6	159	pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
872bbc1b	160	a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
47e1b0c6 DM	161	test -n "$${NOVIEW}" \|\| man -l $@
47e1b0c6 DM	162
954a26fd	163	pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
872bbc1b	164	a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
954a26fd DM	165	test -n "$${NOVIEW}" \|\| man -l $@
954a26fd DM	166
4db6a3f3 DM	167	pvestatd.8: ${PVESTATD_MAN8_SOURCES}
	168	a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
	169	test -n "$${NOVIEW}" \|\| man -l $@
	170
672abac1 DM	171	qm.conf.5: ${QM_CONF_MAN5_SOURCES}
	172
	173	pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
6ec3cd20	174
672abac1	175	datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
6ec3cd20	176
b0f56e11	177	%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
872bbc1b	178	a2x ${A2X_MAN5_OPTIONS} $*.adoc
f6b81378	179	test -n "$${NOVIEW}" \|\| man -l $@
9344ee0d DM	180
	181	.PHONY: cleanup-docgen
	182	cleanup-docgen:
427b88e5	183	rm -f .1 .5 .8 .adoc attributes.txt docinfo.xml