sphinx: Treat warnings as errors
[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_BASH_COMPLETION = $(top_srcdir)/autotools/build-bash-completion
15 RUN_IN_TEMPDIR = $(top_srcdir)/autotools/run-in-tempdir
16 CHECK_PYTHON_CODE = $(top_srcdir)/autotools/check-python-code
17 REPLACE_VARS_SED = autotools/replace_vars.sed
18
19 hypervisordir = $(pkgpythondir)/hypervisor
20 httpdir = $(pkgpythondir)/http
21 confddir = $(pkgpythondir)/confd
22 rapidir = $(pkgpythondir)/rapi
23 toolsdir = $(pkglibdir)/tools
24 docdir = $(datadir)/doc/$(PACKAGE)
25
26 DIRS = \
27         autotools \
28         daemons \
29         devel \
30         doc \
31         doc/examples \
32         doc/examples/hooks \
33         lib \
34         lib/build \
35         lib/http \
36         lib/hypervisor \
37         lib/rapi \
38         lib/confd \
39         man \
40         qa \
41         scripts \
42         test \
43         test/data \
44         tools
45
46 MAINTAINERCLEANFILES = \
47         $(docpng) \
48         $(maninput) \
49         doc/install-quick.rst \
50         doc/news.rst
51
52 maintainer-clean-local:
53         rm -rf doc/api doc/html
54
55 CLEANFILES = \
56         autotools/replace_vars.sed \
57         daemons/daemon-util \
58         daemons/ganeti-cleaner \
59         devel/upload \
60         doc/examples/bash_completion \
61         doc/examples/ganeti.initd \
62         doc/examples/ganeti.cron \
63         doc/examples/gnt-config-backup \
64         doc/examples/hooks/ipsec \
65         lib/*.py[co] \
66         lib/build/*.py[co] \
67         lib/http/*.py[co] \
68         lib/hypervisor/*.py[co] \
69         lib/rapi/*.py[co] \
70         $(man_MANS) \
71         $(manhtml) \
72         qa/*.py[co] \
73         test/*.py[co] \
74         stamp-directories \
75         stamp-srclinks \
76         $(nodist_pkgpython_PYTHON)
77
78 BUILT_SOURCES = \
79         ganeti \
80         stamp-srclinks \
81         stamp-directories \
82         lib/_autoconf.py
83
84 nodist_pkgpython_PYTHON = \
85         lib/_autoconf.py
86
87 noinst_PYTHON = \
88         lib/build/__init__.py
89
90 pkgpython_PYTHON = \
91         lib/__init__.py \
92         lib/asyncnotifier.py \
93         lib/backend.py \
94         lib/bdev.py \
95         lib/bootstrap.py \
96         lib/cli.py \
97         lib/cmdlib.py \
98         lib/config.py \
99         lib/constants.py \
100         lib/daemon.py \
101         lib/errors.py \
102         lib/jqueue.py \
103         lib/jstore.py \
104         lib/locking.py \
105         lib/luxi.py \
106         lib/mcpu.py \
107         lib/objects.py \
108         lib/opcodes.py \
109         lib/rpc.py \
110         lib/serializer.py \
111         lib/ssconf.py \
112         lib/ssh.py \
113         lib/storage.py \
114         lib/utils.py \
115         lib/workerpool.py
116
117 hypervisor_PYTHON = \
118         lib/hypervisor/__init__.py \
119         lib/hypervisor/hv_base.py \
120         lib/hypervisor/hv_chroot.py \
121         lib/hypervisor/hv_fake.py \
122         lib/hypervisor/hv_kvm.py \
123         lib/hypervisor/hv_xen.py
124
125 rapi_PYTHON = \
126         lib/rapi/__init__.py \
127         lib/rapi/baserlib.py \
128         lib/rapi/connector.py \
129         lib/rapi/rlib2.py
130
131 http_PYTHON = \
132         lib/http/__init__.py \
133         lib/http/auth.py \
134         lib/http/client.py \
135         lib/http/server.py
136
137 confd_PYTHON = \
138         lib/confd/__init__.py \
139         lib/confd/client.py \
140         lib/confd/server.py \
141         lib/confd/querylib.py
142
143 docrst = \
144         doc/admin.rst \
145         doc/design-2.0.rst \
146         doc/design-2.1.rst \
147         doc/devnotes.rst \
148         doc/glossary.rst \
149         doc/hooks.rst \
150         doc/iallocator.rst \
151         doc/index.rst \
152         doc/install-quick.rst \
153         doc/install.rst \
154         doc/locking.rst \
155         doc/news.rst \
156         doc/rapi.rst \
157         doc/security.rst \
158         doc/walkthrough.rst
159
160 doc/html/.stamp: $(docrst) $(docpng) doc/conf.py configure.ac
161         @test -n "$(SPHINX)" || \
162             { echo 'sphinx-build' not found during configure; exit 1; }
163         PYTHONPATH=. $(RUN_IN_TEMPDIR) $(SPHINX) -q -W -b html \
164             -d . \
165             -D version="$(VERSION_MAJOR).$(VERSION_MINOR)" \
166             -D release="$(PACKAGE_VERSION)" \
167             $(abs_top_srcdir)/doc $(CURDIR)/doc/html
168         rm -f doc/html/.buildinfo doc/html/objects.inv
169         touch $@
170
171 doc/html: doc/html/.stamp
172
173 doc/news.rst: NEWS
174         set -e; \
175         { echo '.. This file is automatically updated at build time from $<.'; \
176           echo '.. Do not edit.'; \
177           echo; \
178           cat $<; \
179         } > $@
180
181 doc/install-quick.rst: INSTALL
182         set -e; \
183         { echo '.. This file is automatically updated at build time from $<.'; \
184           echo '.. Do not edit.'; \
185           echo; \
186           cat $<; \
187         } > $@
188
189 docdot = \
190         doc/arch-2.0.dot \
191         doc/design-2.1-lock-acquire.dot \
192         doc/design-2.1-lock-release.dot
193
194 docpng = $(patsubst %.dot,%.png,$(docdot))
195
196 # Things to build but not to install (add it to EXTRA_DIST if it should be
197 # distributed)
198 noinst_DATA = \
199         devel/upload \
200         doc/html \
201         doc/examples/bash_completion \
202         doc/examples/ganeti.cron \
203         doc/examples/ganeti.initd \
204         doc/examples/gnt-config-backup \
205         doc/examples/hooks/ipsec \
206         $(manhtml)
207
208 gnt_scripts = \
209         scripts/gnt-backup \
210         scripts/gnt-cluster \
211         scripts/gnt-debug \
212         scripts/gnt-instance \
213         scripts/gnt-job \
214         scripts/gnt-node \
215         scripts/gnt-os
216
217 dist_sbin_SCRIPTS = \
218         daemons/ganeti-noded \
219         daemons/ganeti-watcher \
220         daemons/ganeti-masterd \
221         daemons/ganeti-confd \
222         daemons/ganeti-rapi \
223         $(gnt_scripts)
224
225 nodist_sbin_SCRIPTS = \
226         daemons/ganeti-cleaner
227
228 dist_tools_SCRIPTS = \
229         tools/burnin \
230         tools/cfgshell \
231         tools/cfgupgrade \
232         tools/lvmstrap
233
234 pkglib_SCRIPTS = \
235         daemons/daemon-util
236
237 EXTRA_DIST = \
238         NEWS \
239         pylintrc \
240         autotools/build-bash-completion \
241         autotools/check-python-code \
242         autotools/docbook-wrapper \
243         $(RUN_IN_TEMPDIR) \
244         daemons/daemon-util.in \
245         daemons/ganeti-cleaner.in \
246         devel/upload.in \
247         $(docdot) \
248         $(docpng) \
249         $(docrst) \
250         doc/conf.py \
251         doc/html \
252         doc/examples/ganeti.initd.in \
253         doc/examples/ganeti.cron.in \
254         doc/examples/gnt-config-backup.in \
255         doc/examples/dumb-allocator \
256         doc/examples/hooks/ethers \
257         doc/examples/hooks/ipsec.in \
258         test/testutils.py \
259         test/mocks.py \
260         $(dist_TESTS) \
261         $(TEST_FILES) \
262         man/footer.sgml \
263         $(mansgml) \
264         $(maninput) \
265         qa/ganeti-qa.py \
266         qa/qa-sample.json \
267         qa/qa_cluster.py \
268         qa/qa_config.py \
269         qa/qa_daemon.py \
270         qa/qa_env.py \
271         qa/qa_error.py \
272         qa/qa_instance.py \
273         qa/qa_node.py \
274         qa/qa_os.py \
275         qa/qa_rapi.py \
276         qa/qa_tags.py \
277         qa/qa_utils.py
278
279 man_MANS = \
280         man/ganeti.7 \
281         man/ganeti-cleaner.8 \
282         man/ganeti-confd.8 \
283         man/ganeti-masterd.8 \
284         man/ganeti-noded.8 \
285         man/ganeti-os-interface.7 \
286         man/ganeti-rapi.8 \
287         man/ganeti-watcher.8 \
288         man/gnt-backup.8 \
289         man/gnt-cluster.8 \
290         man/gnt-debug.8 \
291         man/gnt-instance.8 \
292         man/gnt-job.8 \
293         man/gnt-node.8 \
294         man/gnt-os.8
295
296 mansgml = $(patsubst %.7,%.sgml,$(patsubst %.8,%.sgml,$(man_MANS)))
297 manhtml = $(patsubst %.sgml,%.html,$(mansgml))
298 maninput = \
299         $(patsubst %.7,%.7.in,$(patsubst %.8,%.8.in,$(man_MANS))) \
300         $(patsubst %.html,%.html.in,$(manhtml))
301
302 TEST_FILES = \
303         test/data/bdev-both.txt \
304         test/data/bdev-8.3-both.txt \
305         test/data/bdev-disk.txt \
306         test/data/bdev-net.txt \
307         test/data/proc_drbd8.txt \
308         test/data/proc_drbd80-emptyline.txt \
309         test/data/proc_drbd83.txt
310
311 dist_TESTS = \
312         test/ganeti.bdev_unittest.py \
313         test/ganeti.cli_unittest.py \
314         test/ganeti.cmdlib_unittest.py \
315         test/ganeti.confd_client_unittest.py \
316         test/ganeti.config_unittest.py \
317         test/ganeti.constants_unittest.py \
318         test/ganeti.hooks_unittest.py \
319         test/ganeti.http_unittest.py \
320         test/ganeti.locking_unittest.py \
321         test/ganeti.mcpu_unittest.py \
322         test/ganeti.objects_unittest.py \
323         test/ganeti.rapi.resources_unittest.py \
324         test/ganeti.serializer_unittest.py \
325         test/ganeti.ssh_unittest.py \
326         test/ganeti.utils_unittest.py \
327         test/ganeti.workerpool_unittest.py \
328         test/docs_unittest.py
329
330 nodist_TESTS =
331
332 TESTS = $(dist_TESTS) $(nodist_TESTS)
333
334 TESTS_ENVIRONMENT = \
335         PYTHONPATH=. TOP_SRCDIR=$(abs_top_srcdir) \
336         $(RUN_IN_TEMPDIR) $(PYTHON)
337
338 all_python_code = \
339         $(dist_sbin_SCRIPTS) \
340         $(dist_tools_SCRIPTS) \
341         $(dist_TESTS) \
342         $(pkgpython_PYTHON) \
343         $(hypervisor_PYTHON) \
344         $(rapi_PYTHON) \
345         $(http_PYTHON) \
346         $(confd_PYTHON) \
347         $(noinst_PYTHON)
348
349 srclink_files = \
350         man/footer.sgml \
351         $(all_python_code)
352
353 check_python_code = \
354         $(all_python_code)
355
356 devel/upload: devel/upload.in $(REPLACE_VARS_SED)
357         sed -f $(REPLACE_VARS_SED) < $< > $@
358         chmod u+x $@
359
360 daemons/%: daemons/%.in \
361                 $(REPLACE_VARS_SED)
362         sed -f $(REPLACE_VARS_SED) < $< > $@
363         chmod +x $@
364
365 doc/examples/%: doc/examples/%.in \
366                 $(REPLACE_VARS_SED)
367         sed -f $(REPLACE_VARS_SED) < $< > $@
368
369 doc/examples/hooks/%: doc/examples/hooks/%.in \
370                 $(REPLACE_VARS_SED)
371         sed -f $(REPLACE_VARS_SED) < $< > $@
372
373 doc/examples/bash_completion: $(BUILD_BASH_COMPLETION) $(RUN_IN_TEMPDIR) \
374         lib/cli.py $(gnt_scripts) tools/burnin
375         PYTHONPATH=. $(RUN_IN_TEMPDIR) $(CURDIR)/$(BUILD_BASH_COMPLETION) > $@
376
377 doc/%.png: doc/%.dot
378         @test -n "$(DOT)" || { echo 'dot' not found during configure; exit 1; }
379         $(DOT) -Tpng -o $@ $<
380
381 man/%.7.in man/%.8.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
382         @test -n "$(DOCBOOK2MAN)" || \
383           { echo 'docbook2man' not found during configure; exit 1; }
384         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $(notdir $(@:.in=)) $@
385
386 man/%.html.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
387         @test -n "$(DOCBOOK2HTML)" || \
388           { echo 'docbook2html' not found during configure; exit 1; }
389         $(DOCBOOK_WRAPPER) "$(DOCBOOK2HTML) --nochunks" $< $(notdir $(@:.in=)) $@
390
391 man/%.7: man/%.7.in $(REPLACE_VARS_SED)
392         sed -f $(REPLACE_VARS_SED) < $< > $@
393
394 man/%.8: man/%.8.in $(REPLACE_VARS_SED)
395         sed -f $(REPLACE_VARS_SED) < $< > $@
396
397 man/%.html: man/%.html.in $(REPLACE_VARS_SED)
398         sed -f $(REPLACE_VARS_SED) < $< > $@
399
400 lib/_autoconf.py: Makefile stamp-directories
401         set -e; \
402         { echo '# This file is automatically generated, do not edit!'; \
403           echo '#'; \
404           echo ''; \
405           echo '"""Build-time configuration for Ganeti.'; \
406           echo '';\
407           echo 'This file is autogenerated by the build process.'; \
408           echo 'For any changes you need to re-run ./configure (and'; \
409           echo 'not edit by hand).'; \
410           echo ''; \
411           echo '"""'; \
412           echo ''; \
413           echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
414           echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
415           echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \
416           echo "VERSION_REVISION = '$(VERSION_REVISION)'"; \
417           echo "VERSION_SUFFIX = '$(VERSION_SUFFIX)'"; \
418           echo "VERSION_FULL = '$(VERSION_FULL)'"; \
419           echo "LOCALSTATEDIR = '$(localstatedir)'"; \
420           echo "SYSCONFDIR = '$(sysconfdir)'"; \
421           echo "EXPORT_DIR = '$(EXPORT_DIR)'"; \
422           echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
423           echo "XEN_BOOTLOADER = '$(XEN_BOOTLOADER)'"; \
424           echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
425           echo "XEN_INITRD = '$(XEN_INITRD)'"; \
426           echo "FILE_STORAGE_DIR = '$(FILE_STORAGE_DIR)'"; \
427           echo "IALLOCATOR_SEARCH_PATH = [$(IALLOCATOR_SEARCH_PATH)]"; \
428           echo "KVM_PATH = '$(KVM_PATH)'"; \
429           echo "SOCAT_PATH = '$(SOCAT)'"; \
430           echo "SOCAT_USE_ESCAPE = $(SOCAT_USE_ESCAPE)"; \
431           echo "LVM_STRIPECOUNT = $(LVM_STRIPECOUNT)"; \
432           echo "TOOLSDIR = '$(toolsdir)'"; \
433           echo "GNT_SCRIPTS = [$(foreach i,$(notdir $(gnt_scripts)),'$(i)',)]"; \
434           echo "PKGLIBDIR = '$(pkglibdir)'"; \
435         } > $@
436
437 $(REPLACE_VARS_SED): Makefile
438         set -e; \
439         { echo 's#@PREFIX@#$(prefix)#g'; \
440           echo 's#@SYSCONFDIR@#$(sysconfdir)#g'; \
441           echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
442           echo 's#@BINDIR@#$(bindir)#g'; \
443           echo 's#@SBINDIR@#$(sbindir)#g'; \
444           echo 's#@GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
445           echo 's#@CUSTOM_XEN_BOOTLOADER@#$(XEN_BOOTLOADER)#g'; \
446           echo 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
447           echo 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
448           echo 's#@RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
449           echo 's#@RPL_SSH_INITD_SCRIPT@#$(SSH_INITD_SCRIPT)#g'; \
450           echo 's#@PKGLIBDIR@#$(pkglibdir)#g'; \
451         } > $@
452
453 # We need to create symlinks because "make distcheck" will not install Python
454 # files when building.
455 stamp-srclinks: Makefile stamp-directories
456         set -e; \
457         for i in $(srclink_files); do \
458                 if test ! -f $$i -a -f $(abs_top_srcdir)/$$i; then \
459                         $(LN_S) $(abs_top_srcdir)/$$i $$i; \
460                 fi; \
461         done
462         touch $@
463
464 .PHONY: ganeti
465 ganeti:
466         cd $(top_builddir) && test -h "$@" || { rm -f $@ && $(LN_S) lib $@; }
467
468 check-local:
469         $(CHECK_PYTHON_CODE) $(check_python_code)
470
471 # a dist hook rule for catching revision control directories
472 distcheck-hook:
473         if find $(top_distdir) -name .svn -or -name .git | grep .; then \
474                 echo "Found revision control files in final archive." 1>&2; \
475                 exit 1; \
476         fi
477         if find $(top_distdir) -name '*.py[co]' | grep .; then \
478                 echo "Found Python byte code in final archive." 1>&2; \
479                 exit 1; \
480         fi
481         if find $(top_distdir) -name '*~' | grep .; then \
482                 echo "Found backup files in final archive." 1>&2; \
483                 exit 1; \
484         fi
485
486 install-exec-local:
487         @mkdir_p@ "$(DESTDIR)${localstatedir}/lib/ganeti" \
488           "$(DESTDIR)${localstatedir}/log/ganeti" \
489           "$(DESTDIR)${localstatedir}/run/ganeti"
490
491 stamp-directories: Makefile
492         @mkdir_p@ $(DIRS)
493         touch $@
494
495 .PHONY: apidoc
496 apidoc: epydoc.conf $(RUN_IN_TEMPDIR)
497         test -e doc/api || mkdir doc/api
498         $(RUN_IN_TEMPDIR) epydoc -v \
499                 --conf $(CURDIR)/epydoc.conf \
500                 --output $(CURDIR)/doc/api
501
502 .PHONY: TAGS
503 TAGS:
504         rm -f TAGS
505         find . -path './lib/*.py' -o -path 'scripts/gnt-*' -o \
506           -path 'daemons/ganeti-*' -o -path 'tools/*' | \
507           etags -
508
509 # vim: set noet :