RAPI Desing Doc
[ganeti-local] / Makefile.am
1 # Ganeti makefile
2 # - Indent with tabs only.
3 # - Keep files sorted; one line per file.
4 # - Directories in lib/ must have their own *dir variable (see hypervisor).
5 # - All directories must be listed DIRS.
6 # - Use autogen.sh to generate Makefile.in and configure script.
7
8 # Automake doesn't export these variables before version 1.10.
9 abs_top_builddir = @abs_top_builddir@
10 abs_top_srcdir = @abs_top_srcdir@
11
12 ACLOCAL_AMFLAGS = -I autotools
13 DOCBOOK_WRAPPER = $(top_srcdir)/autotools/docbook-wrapper
14 BUILD_RAPI_RESOURCE_DOC = $(top_srcdir)/doc/build-rapi-resources-doc
15 REPLACE_VARS_SED = autotools/replace_vars.sed
16
17 hypervisordir = $(pkgpythondir)/hypervisor
18 rapidir = $(pkgpythondir)/rapi
19 toolsdir = $(pkglibdir)/tools
20 docdir = $(datadir)/doc/$(PACKAGE)
21
22 DIRS = \
23         autotools \
24         daemons \
25         devel \
26         doc \
27         doc/examples \
28         lib \
29         lib/hypervisor \
30         lib/rapi \
31         man \
32         qa \
33         scripts \
34         test \
35         test/data \
36         tools
37
38 CLEANFILES = \
39         autotools/replace_vars.sed \
40         devel/upload \
41         doc/*.html \
42         doc/*.in \
43         doc/*.pdf \
44         doc/rapi-resources.sgml \
45         doc/examples/ganeti.initd \
46         doc/examples/ganeti.cron \
47         lib/*.py[co] \
48         lib/hypervisor/*.py[co] \
49         lib/rapi/*.py[co] \
50         man/*.[78] \
51         man/*.in \
52         qa/*.py[co] \
53         test/*.py[co] \
54         stamp-directories \
55         $(nodist_pkgpython_PYTHON)
56
57 nodist_pkgpython_PYTHON = \
58         lib/_autoconf.py
59
60 pkgpython_PYTHON = \
61         lib/__init__.py \
62         lib/backend.py \
63         lib/bdev.py \
64         lib/bootstrap.py \
65         lib/cli.py \
66         lib/cmdlib.py \
67         lib/config.py \
68         lib/constants.py \
69         lib/errors.py \
70         lib/http.py \
71         lib/jqueue.py \
72         lib/jstore.py \
73         lib/locking.py \
74         lib/logger.py \
75         lib/luxi.py \
76         lib/mcpu.py \
77         lib/objects.py \
78         lib/opcodes.py \
79         lib/rpc.py \
80         lib/serializer.py \
81         lib/ssconf.py \
82         lib/ssh.py \
83         lib/utils.py \
84         lib/workerpool.py
85
86 hypervisor_PYTHON = \
87         lib/hypervisor/__init__.py \
88         lib/hypervisor/hv_base.py \
89         lib/hypervisor/hv_fake.py \
90         lib/hypervisor/hv_kvm.py \
91         lib/hypervisor/hv_xen.py
92
93 rapi_PYTHON = \
94         lib/rapi/__init__.py \
95         lib/rapi/httperror.py \
96         lib/rapi/baserlib.py \
97         lib/rapi/connector.py \
98         lib/rapi/rlib1.py \
99         lib/rapi/rlib2.py
100
101
102 docsgml = \
103         doc/hooks.sgml \
104         doc/install.sgml \
105         doc/admin.sgml \
106         doc/rapi.sgml \
107         doc/iallocator.sgml
108
109 docrst = \
110         doc/design-2.0-commandline-parameters.rst \
111         doc/design-2.0-disk-handling.rst \
112         doc/design-2.0-index.rst \
113         doc/design-2.0-job-queue.rst \
114         doc/design-2.0-locking.rst \
115         doc/design-2.0-master-daemon.rst \
116         doc/design-2.0-rapi-changes.rst
117
118 doc_DATA = \
119         $(patsubst %.rst,%.html,$(docrst)) \
120         $(patsubst %.sgml,%.html,$(docsgml)) \
121         $(patsubst %.sgml,%.pdf,$(docsgml))
122
123 dist_sbin_SCRIPTS = \
124         daemons/ganeti-noded \
125         daemons/ganeti-watcher \
126         daemons/ganeti-masterd \
127         daemons/ganeti-rapi \
128         scripts/gnt-backup \
129         scripts/gnt-cluster \
130         scripts/gnt-debug \
131         scripts/gnt-instance \
132         scripts/gnt-job \
133         scripts/gnt-node \
134         scripts/gnt-os
135
136 dist_tools_SCRIPTS = \
137         tools/burnin \
138         tools/cfgshell \
139         tools/cfgupgrade \
140         tools/lvmstrap
141
142 EXTRA_DIST = \
143         NEWS \
144         DEVNOTES \
145         autotools/docbook-wrapper \
146         devel/upload.in \
147         $(docrst) \
148         $(docsgml) \
149         doc/build-rapi-resources-doc \
150         doc/examples/ganeti.initd.in \
151         doc/examples/ganeti.cron.in \
152         doc/examples/dumb-allocator \
153         doc/locking.txt \
154         test/testutils.py \
155         test/mocks.py \
156         $(dist_TESTS) \
157         $(TEST_FILES) \
158         man/footer.sgml \
159         $(mansgml) \
160         qa/ganeti-qa.py \
161         qa/qa-sample.json \
162         qa/qa_cluster.py \
163         qa/qa_config.py \
164         qa/qa_daemon.py \
165         qa/qa_env.py \
166         qa/qa_error.py \
167         qa/qa_instance.py \
168         qa/qa_node.py \
169         qa/qa_os.py \
170         qa/qa_rapi.py \
171         qa/qa_tags.py \
172         qa/qa_utils.py
173
174 man_MANS = \
175         man/ganeti.7 \
176         man/ganeti-noded.8 \
177         man/ganeti-os-interface.7 \
178         man/ganeti-watcher.8 \
179         man/gnt-backup.8 \
180         man/gnt-cluster.8 \
181         man/gnt-instance.8 \
182         man/gnt-node.8 \
183         man/gnt-os.8
184
185 maninput = $(patsubst %.7,%.in,$(patsubst %.8,%.in,$(man_MANS)))
186 mansgml = $(patsubst %.in,%.sgml,$(maninput))
187
188 TEST_FILES = \
189         test/data/bdev-both.txt \
190         test/data/bdev-disk.txt \
191         test/data/bdev-net.txt \
192         test/data/proc_drbd8.txt
193
194 dist_TESTS = \
195         test/ganeti.config_unittest.py \
196         test/ganeti.hooks_unittest.py \
197         test/ganeti.utils_unittest.py \
198         test/ganeti.bdev_unittest.py \
199         test/ganeti.ssh_unittest.py \
200         test/ganeti.locking_unittest.py \
201         test/ganeti.serializer_unittest.py \
202         test/ganeti.workerpool_unittest.py \
203         test/ganeti.rapi.resources_unittest.py \
204         test/ganeti.http_unittest.py \
205         test/ganeti.constants_unittest.py
206
207 nodist_TESTS =
208
209 TESTS = $(dist_TESTS) $(nodist_TESTS)
210
211 TESTS_ENVIRONMENT = PYTHONPATH=.:$(top_builddir)
212
213
214 all-local: stamp-directories lib/_autoconf.py devel/upload \
215         doc/examples/ganeti.initd doc/examples/ganeti.cron
216
217 devel/upload: devel/upload.in stamp-directories $(REPLACE_VARS_SED)
218         sed -f $(REPLACE_VARS_SED) < $< > $@
219         chmod u+x $@
220
221 doc/examples/ganeti.%: doc/examples/ganeti.%.in stamp-directories \
222                 $(REPLACE_VARS_SED)
223         sed -f $(REPLACE_VARS_SED) < $< > $@
224
225 doc/%.in: doc/%.sgml stamp-directories $(REPLACE_VARS_SED)
226         sed -f $(REPLACE_VARS_SED) < $< > $@
227
228 man/%.in: man/%.sgml stamp-directories $(REPLACE_VARS_SED)
229         sed -f $(REPLACE_VARS_SED) < $< > $@
230
231 doc/%.pdf: doc/%.in $(DOCBOOK_WRAPPER)
232         $(DOCBOOK_WRAPPER) "$(DOCBOOK2PDF)" $< $@
233
234 doc/%.html: doc/%.in $(DOCBOOK_WRAPPER)
235         $(DOCBOOK_WRAPPER) "$(DOCBOOK2HTML) --nochunks" $< $@
236
237 doc/%.html: doc/%.rst
238         $(RST2HTML) $< $@
239
240 doc/rapi.pdf doc/rapi.html doc/rapi.in: doc/rapi-resources.sgml
241
242 doc/rapi-resources.sgml: $(BUILD_RAPI_RESOURCE_DOC) lib/rapi/connector.py
243         PYTHONPATH=.:$(top_builddir) $(BUILD_RAPI_RESOURCE_DOC) > $@ || rm -f $@
244
245 man/%.7: man/%.in man/footer.sgml $(DOCBOOK_WRAPPER)
246         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $@
247
248 man/%.8: man/%.in man/footer.sgml $(DOCBOOK_WRAPPER)
249         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $@
250
251 man/footer.sgml $(TESTS): srclinks
252
253 $(TESTS) $(BUILD_RAPI_RESOURCE_DOC): ganeti lib/_autoconf.py
254
255 lib/_autoconf.py: Makefile stamp-directories
256         set -e; \
257         { echo '# This file is automatically generated, do not edit!'; \
258           echo '#'; \
259           echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
260           echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
261           echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \
262           echo "VERSION_REVISION = '$(VERSION_REVISION)'"; \
263           echo "VERSION_SUFFIX = '$(VERSION_SUFFIX)'"; \
264           echo "VERSION_FULL = '$(VERSION_FULL)'"; \
265           echo "LOCALSTATEDIR = '$(localstatedir)'"; \
266           echo "SYSCONFDIR = '$(sysconfdir)'"; \
267           echo "SSH_INITD_SCRIPT = '$(SSH_INITD_SCRIPT)'"; \
268           echo "EXPORT_DIR = '$(EXPORT_DIR)'"; \
269           echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
270           echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
271           echo "XEN_INITRD = '$(XEN_INITRD)'"; \
272           echo "FILE_STORAGE_DIR = '$(FILE_STORAGE_DIR)'"; \
273           echo "IALLOCATOR_SEARCH_PATH = [$(IALLOCATOR_SEARCH_PATH)]"; \
274           echo "KVM_PATH = '$(KVM_PATH)'"; \
275         } > $@
276
277 $(REPLACE_VARS_SED): Makefile stamp-directories
278         set -e; \
279         { echo 's#@PREFIX@#$(prefix)#g'; \
280           echo 's#@SYSCONFDIR@#$(sysconfdir)#g'; \
281           echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
282           echo 's#@SBINDIR@#$(sbindir)#g'; \
283           echo 's#@GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
284           echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
285           echo 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
286           echo 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
287           echo '/@INCLUDE_RAPI_RESOURCES@/ {'; \
288           echo '  r $(abs_top_builddir)/doc/rapi-resources.sgml'; \
289           echo '  d'; \
290           echo '}'; \
291         } > $@
292
293 # We need to create symlinks because "make distcheck" will not install Python
294 # files when building.
295 #.PHONY: srclinks
296 srclinks: stamp-directories
297         set -e; \
298         for i in man/footer.sgml $(pkgpython_PYTHON) $(hypervisor_PYTHON) $(rapi_PYTHON); do \
299                 if test ! -f $$i -a -f $(abs_top_srcdir)/$$i; then \
300                         $(LN_S) $(abs_top_srcdir)/$$i $$i; \
301                 fi; \
302         done
303
304 .PHONY: ganeti
305 ganeti:
306         cd $(top_builddir) && rm -f $@ && $(LN_S) lib $@
307
308 # a dist hook rule for catching revision control directories
309 distcheck-hook:
310         if find $(top_distdir) | grep -F -e '.svn' -e '.git'; then \
311                 echo "Found revision control files in final archive" 1>&2 ; \
312                 exit 1; \
313         fi
314
315 install-exec-local:
316         @mkdir_p@ "$(DESTDIR)${localstatedir}/lib/ganeti" \
317           "$(DESTDIR)${localstatedir}/log/ganeti" \
318           "$(DESTDIR)${localstatedir}/run/ganeti"
319
320 stamp-directories: Makefile
321         @mkdir_p@ $(DIRS)
322         touch $@
323
324 .PHONY: apidoc
325 apidoc:
326         test -e doc/api || mkdir doc/api
327         TMPDIR=`mktemp -d ./temp-epydoc.XXXXXX` && { \
328                 cp -r scripts daemons lib $$TMPDIR && \
329                 ( \
330                         cd $$TMPDIR && \
331                         mv lib ganeti && \
332                         epydoc --conf ../epydoc.conf \
333                 ) ; \
334                 rm -rf $$TMPDIR ; \
335         }
336
337 # vim: set noet :