summaryrefslogtreecommitdiffstats
path: root/xml/Makefile.am
blob: 670a85642907b383c7b1c71fc739218fb1d047f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
#
# Copyright 2004-2024 the Pacemaker project contributors
#
# The version control history for this file may have further details.
#
# This source code is licensed under the GNU General Public License version 2
# or later (GPLv2+) WITHOUT ANY WARRANTY.
#

include $(top_srcdir)/mk/common.mk

noarch_pkgconfig_DATA	= $(builddir)/pacemaker-schemas.pc

# Pacemaker has 3 schemas: the CIB schema, the API schema (for command-line
# tool XML output), and a legacy schema for crm_mon --as-xml.
#
# See README.md for details on updating CIB schema files (API is similar)

# The CIB and crm_mon schemas are installed directly in CRM_SCHEMA_DIRECTORY
# for historical reasons, while the API schema is installed in a subdirectory.
APIdir	= $(CRM_SCHEMA_DIRECTORY)/api
CIBdir	= $(CRM_SCHEMA_DIRECTORY)
MONdir	= $(CRM_SCHEMA_DIRECTORY)

basexsltdir		= $(CRM_SCHEMA_DIRECTORY)/base
dist_basexslt_DATA	= $(srcdir)/base/access-render-2.xsl

# Extract a sorted list of available numeric schema versions
# from filenames like NAME-MAJOR[.MINOR][.MINOR-MINOR].rng
numeric_versions = $(shell ls -1 $(1) \
			  | sed -n -e 's/^.*-\([0-9][0-9.]*\).rng$$/\1/p' \
			  | sort -u -t. -k 1,1n -k 2,2n -k 3,3n)

# @COMPAT: pacemaker-next is deprecated since 2.1.5
version_pairs = $(join \
			    $(1),$(addprefix \
			      -,$(wordlist \
			        2,$(words $(1)),$(1) \
			      ) next \
			    ) \
			  )

version_pairs_last = $(wordlist \
			    $(words \
			      $(wordlist \
			        2,$(1),$(2) \
			      ) \
			    ),$(1),$(2) \
			  )

# NOTE: All files in API_request_base, CIB_cfg_base, API_base, and CIB_base
# need to start with a unique prefix.  These variables all get iterated over
# and globbed, and two files starting with the same prefix will cause
# problems.

# Names of API schemas that form the choices for pacemaker-result content
API_request_base	= command-output	\
			  crm_attribute 	\
			  crm_error 		\
			  crm_mon 		\
			  crm_node 		\
			  crm_resource		\
			  crm_rule 		\
			  crm_shadow		\
			  crm_simulate		\
			  crm_ticket 		\
			  crmadmin		\
			  digests		\
			  pacemakerd 		\
			  stonith_admin		\
			  version

# Names of CIB schemas that form the choices for cib/configuration content
CIB_cfg_base		= options 	\
			  nodes 	\
			  resources 	\
			  constraints 	\
			  fencing 	\
			  acls 		\
			  tags 		\
			  alerts

# Names of all schemas (including top level and those included by others)
API_base		= $(API_request_base)	\
			  any-element		\
			  failure		\
			  fence-event 		\
			  generic-list		\
			  instruction		\
			  item			\
			  node-attrs		\
			  node-history		\
			  nodes			\
			  ocf-ra		\
			  options		\
			  patchset		\
			  resources		\
			  status		\
			  subprocess-output 	\
			  ticket

CIB_base		= cib 			\
			  $(CIB_cfg_base) 	\
			  status 		\
			  score 		\
			  rule 			\
			  nvset

# Static schema files and transforms (only CIB has transforms)
# 
# This is more complicated than it should be due to the need to support
# VPATH builds and "make distcheck". We need the absolute paths for reliable
# substitution back and forth, and relative paths for distributed files.
API_abs_files		= $(foreach base,$(API_base),$(wildcard $(abs_srcdir)/api/$(base)-*.rng))
CIB_abs_files		= $(foreach base,$(CIB_base),$(wildcard $(abs_srcdir)/$(base).rng $(abs_srcdir)/$(base)-*.rng))
CIB_abs_xsl		= $(abs_srcdir)/upgrade-1.3.xsl			\
			  $(abs_srcdir)/upgrade-2.10.xsl		\
			  $(wildcard $(abs_srcdir)/upgrade-*enter.xsl)	\
			  $(wildcard $(abs_srcdir)/upgrade-*leave.xsl)
MON_abs_files 		= $(abs_srcdir)/crm_mon.rng
API_files		= $(foreach base,$(API_base),$(wildcard $(srcdir)/api/$(base)-*.rng))
CIB_files		= $(foreach base,$(CIB_base),$(wildcard $(srcdir)/$(base).rng $(srcdir)/$(base)-*.rng))
CIB_xsl			= $(srcdir)/upgrade-1.3.xsl			\
			  $(srcdir)/upgrade-2.10.xsl			\
			  $(wildcard $(srcdir)/upgrade-*enter.xsl)	\
			  $(wildcard $(srcdir)/upgrade-*leave.xsl)
MON_files 		= $(srcdir)/crm_mon.rng

# Sorted lists of all numeric schema versions
API_numeric_versions	= $(call numeric_versions,${API_files})
CIB_numeric_versions	= $(call numeric_versions,${CIB_files})
MON_numeric_versions 	= $(call numeric_versions,$(wildcard $(srcdir)/api/crm_mon*.rng))

# The highest numeric schema version
API_max			?= $(lastword $(API_numeric_versions))
CIB_max			?= $(lastword $(CIB_numeric_versions))
MON_max 			?= $(lastword $(MON_numeric_versions))

# Sorted lists of all schema versions (including "next")
# @COMPAT: pacemaker-next is deprecated since 2.1.5
API_versions		= next $(API_numeric_versions)
CIB_versions		= next $(CIB_numeric_versions)

# Build tree locations of static schema files and transforms (for VPATH builds)
API_build_copies	= $(foreach f,$(API_abs_files),$(subst $(abs_srcdir),$(abs_builddir),$(f)))
CIB_build_copies	= $(foreach f,$(CIB_abs_files) $(CIB_abs_xsl),$(subst $(abs_srcdir),$(abs_builddir),$(f)))
MON_build_copies 	= $(foreach f,$(MON_abs_files),$(subst $(abs_srcdir),$(abs_builddir),$(f)))

# Dynamically generated schema files
API_generated		= api/api-result.rng $(foreach base,$(API_versions),api/api-result-$(base).rng)
CIB_generated		= pacemaker.rng 					\
			  $(foreach base,$(CIB_versions),pacemaker-$(base).rng) \
			  versions.rng
MON_generated 		= crm_mon.rng

CIB_version_pairs	= $(call version_pairs,${CIB_numeric_versions})
CIB_version_pairs_cnt	= $(words ${CIB_version_pairs})
CIB_version_pairs_last  = $(call version_pairs_last,${CIB_version_pairs_cnt},${CIB_version_pairs})

dist_API_DATA		= $(API_files)
dist_CIB_DATA		= $(CIB_files) \
			  $(CIB_xsl)

nodist_API_DATA		= $(API_generated)
nodist_CIB_DATA		= $(CIB_generated)
nodist_MON_DATA		= $(MON_generated)

EXTRA_DIST		= README.md			\
			  cibtr-2.rng			\
			  context-of.xsl		\
			  rng-helper			\
			  ocf-meta2man.xsl		\
			  regression.sh			\
			  upgrade-2.10-roundtrip.xsl	\
			  upgrade-detail.xsl		\
			  xslt_cibtr-2.rng		\
			  assets			\
			  test-2			\
			  test-2-enter			\
			  test-2-leave			\
			  test-2-roundtrip

.PHONY: cib-versions
cib-versions:
	@echo "Max: $(CIB_max)"
	@echo "Available: $(CIB_versions)"

.PHONY: api-versions
api-versions:
	@echo "Max: $(API_max)"
	@echo "Available: $(API_versions)"

# Dynamically generated top-level API schema
api/api-result.rng: api/api-result-$(API_max).rng
	$(AM_V_at)$(MKDIR_P) api # might not exist in VPATH build
	$(AM_V_SCHEMA)cp $(top_builddir)/xml/$< $@

api/api-result-%.rng: $(API_build_copies) rng-helper Makefile.am
	$(AM_V_SCHEMA)$(builddir)/rng-helper build_api_rng "$@" "$*" \
		$(API_request_base)

crm_mon.rng: api/crm_mon-$(MON_max).rng
	$(AM_V_at)echo '<?xml version="1.0" encoding="UTF-8"?>' > $@
	$(AM_V_at)echo '<grammar xmlns="http://relaxng.org/ns/structure/1.0"' >> $@
	$(AM_V_at)echo '         datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">' >> $@
	$(AM_V_at)echo '    <start>' >> $@
	$(AM_V_at)echo '        <ref name="element-crm_mon-old"/>' >> $@
	$(AM_V_at)echo '    </start>' >> $@
	$(AM_V_at)echo '    <define name="element-crm_mon-old">' >> $@
	$(AM_V_at)echo '        <element name="crm_mon">' >> $@
	$(AM_V_at)echo '            <attribute name="version"> <text/> </attribute>' >> $@
	$(AM_V_at)echo '            <externalRef href="$(<)" />' >> $@
	$(AM_V_at)echo '        </element>' >> $@
	$(AM_V_at)echo '    </define>' >> $@
	$(AM_V_SCHEMA)echo '</grammar>' >> $@

# Dynamically generated top-level CIB schema
pacemaker.rng: pacemaker-$(CIB_max).rng
	$(AM_V_SCHEMA)cp $(top_builddir)/xml/$< $@

pacemaker-%.rng: $(CIB_build_copies) rng-helper Makefile.am
	$(AM_V_SCHEMA)$(builddir)/rng-helper build_cib_rng "$@" "$*" \
		$(CIB_cfg_base)

# Dynamically generated CIB schema listing all pacemaker versions
#
# @COMPAT none, pacemaker-0.6, pacemaker-0.7, pacemaker-1.1, and
# transitional-0.6 are deprecated since 2.1.8, as is validate-with being
# optional
versions.rng: pacemaker-$(CIB_max).rng Makefile.am
	$(AM_V_at)echo '<?xml version="1.0" encoding="UTF-8"?>' > $@
	$(AM_V_at)echo '<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">' >> $@
	$(AM_V_at)echo '  <start>' >> $@
	$(AM_V_at)echo '   <interleave>' >> $@
	$(AM_V_at)echo '    <optional>' >> $@
	$(AM_V_at)echo '      <attribute name="validate-with">' >> $@
	$(AM_V_at)echo '        <choice>' >> $@
	$(AM_V_at)echo '          <value>none</value>' >> $@
	$(AM_V_at)echo '          <value>pacemaker-0.6</value>' >> $@
	$(AM_V_at)echo '          <value>transitional-0.6</value>' >> $@
	$(AM_V_at)echo '          <value>pacemaker-0.7</value>' >> $@
	$(AM_V_at)echo '          <value>pacemaker-1.1</value>' >> $@
	$(AM_V_at)for rng in $(CIB_versions); do echo "          <value>pacemaker-$$rng</value>" >> $@; done
	$(AM_V_at)echo '        </choice>' >> $@
	$(AM_V_at)echo '      </attribute>' >> $@
	$(AM_V_at)echo '    </optional>' >> $@
	$(AM_V_at)echo '    <attribute name="admin_epoch"><data type="nonNegativeInteger"/></attribute>' >> $@
	$(AM_V_at)echo '    <attribute name="epoch"><data type="nonNegativeInteger"/></attribute>' >> $@
	$(AM_V_at)echo '    <attribute name="num_updates"><data type="nonNegativeInteger"/></attribute>' >> $@
	$(AM_V_at)echo '   </interleave>' >> $@
	$(AM_V_at)echo '  </start>' >> $@
	$(AM_V_SCHEMA)echo '</grammar>' >> $@

.PHONY: diff
diff: rng-helper
	@echo "#  Comparing changes in + since $(CIB_max)"
	@$(builddir)/rng-helper diff ${CIB_version_pairs_last}

.PHONY: fulldiff
fulldiff: rng-helper
	@echo "#  Comparing all changes across all the subsequent increments"
	@$(builddir)/rng-helper diff ${CIB_version_pairs}

CLEANFILES = $(API_generated) \
	     $(CIB_generated) \
	     $(MON_generated)

# Remove pacemaker schema files generated by *any* source version. This allows
# "make -C xml clean" to have the desired effect when checking out an earlier
# revision in a source tree.
.PHONY: clean-local
clean-local:
	if [ "x$(srcdir)" != "x$(builddir)" ]; then					\
		rm -f $(API_build_copies) $(CIB_build_copies) $(MON_build_copies);	\
	fi
	rm -f $(builddir)/pacemaker-[0-9]*.[0-9]*.rng

# Enable ability to use $@ in prerequisite
.SECONDEXPANSION:

# For VPATH builds, copy the static schema files into the build tree
$(API_build_copies) $(CIB_build_copies) $(MON_build_copies): $$(subst $(abs_builddir),$(srcdir),$$(@))
	$(AM_V_GEN)if [ "x$(srcdir)" != "x$(builddir)" ]; then	\
		$(MKDIR_P) "$(dir $(@))";			\
		cp "$(<)" "$(@)";				\
	fi