Small doc change in README
[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 httpdir = $(pkgpythondir)/http
19 rapidir = $(pkgpythondir)/rapi
20 toolsdir = $(pkglibdir)/tools
21 docdir = $(datadir)/doc/$(PACKAGE)
22
23 DIRS = \
24         autotools \
25         daemons \
26         devel \
27         doc \
28         doc/examples \
29         lib \
30         lib/http \
31         lib/hypervisor \
32         lib/rapi \
33         man \
34         qa \
35         scripts \
36         test \
37         test/data \
38         tools
39
40 MAINTAINERCLEANFILES = \
41         $(dochtml) \
42         $(patsubst %.dot,%.png,$(docdot)) \
43         $(maninput)
44
45 CLEANFILES = \
46         autotools/replace_vars.sed \
47         devel/upload \
48         doc/rapi-resources.gen \
49         doc/examples/bash_completion \
50         doc/examples/ganeti.initd \
51         doc/examples/ganeti.cron \
52         lib/*.py[co] \
53         lib/http/*.py[co] \
54         lib/hypervisor/*.py[co] \
55         lib/rapi/*.py[co] \
56         $(man_MANS) \
57         $(manhtml) \
58         qa/*.py[co] \
59         test/*.py[co] \
60         stamp-directories \
61         $(nodist_pkgpython_PYTHON)
62
63 nodist_pkgpython_PYTHON = \
64         lib/_autoconf.py
65
66 pkgpython_PYTHON = \
67         lib/__init__.py \
68         lib/backend.py \
69         lib/bdev.py \
70         lib/bootstrap.py \
71         lib/cli.py \
72         lib/cmdlib.py \
73         lib/config.py \
74         lib/constants.py \
75         lib/daemon.py \
76         lib/errors.py \
77         lib/jqueue.py \
78         lib/jstore.py \
79         lib/locking.py \
80         lib/luxi.py \
81         lib/mcpu.py \
82         lib/objects.py \
83         lib/opcodes.py \
84         lib/rpc.py \
85         lib/serializer.py \
86         lib/ssconf.py \
87         lib/ssh.py \
88         lib/utils.py \
89         lib/workerpool.py
90
91 hypervisor_PYTHON = \
92         lib/hypervisor/__init__.py \
93         lib/hypervisor/hv_base.py \
94         lib/hypervisor/hv_fake.py \
95         lib/hypervisor/hv_kvm.py \
96         lib/hypervisor/hv_xen.py
97
98 rapi_PYTHON = \
99         lib/rapi/__init__.py \
100         lib/rapi/baserlib.py \
101         lib/rapi/connector.py \
102         lib/rapi/rlib2.py
103
104 http_PYTHON = \
105         lib/http/__init__.py \
106         lib/http/auth.py \
107         lib/http/client.py \
108         lib/http/server.py
109
110
111 docrst = \
112         doc/admin.rst \
113         doc/design-2.0.rst \
114         doc/hooks.rst \
115         doc/iallocator.rst \
116         doc/install.rst \
117         doc/security.rst
118
119 dochtml = $(patsubst %.rst,%.html,$(docrst))
120
121 docdot = \
122         doc/arch-2.0.dot
123
124 doc_DATA = $(dochtml)
125
126 noinst_DATA = $(manhtml)
127
128 dist_sbin_SCRIPTS = \
129         daemons/ganeti-noded \
130         daemons/ganeti-watcher \
131         daemons/ganeti-masterd \
132         daemons/ganeti-rapi \
133         scripts/gnt-backup \
134         scripts/gnt-cluster \
135         scripts/gnt-debug \
136         scripts/gnt-instance \
137         scripts/gnt-job \
138         scripts/gnt-node \
139         scripts/gnt-os
140
141 dist_tools_SCRIPTS = \
142         tools/burnin \
143         tools/cfgshell \
144         tools/cfgupgrade \
145         tools/lvmstrap
146
147 EXTRA_DIST = \
148         $(MAINTAINERCLEANFILES) \
149         NEWS \
150         DEVNOTES \
151         autotools/docbook-wrapper \
152         devel/upload.in \
153         $(docrst) \
154         $(docdot) \
155         doc/build-rapi-resources-doc \
156         doc/examples/bash_completion.in \
157         doc/examples/ganeti.initd.in \
158         doc/examples/ganeti.cron.in \
159         doc/examples/dumb-allocator \
160         doc/locking.txt \
161         test/testutils.py \
162         test/mocks.py \
163         $(dist_TESTS) \
164         $(TEST_FILES) \
165         man/footer.sgml \
166         $(mansgml) $(maninput) \
167         qa/ganeti-qa.py \
168         qa/qa-sample.json \
169         qa/qa_cluster.py \
170         qa/qa_config.py \
171         qa/qa_daemon.py \
172         qa/qa_env.py \
173         qa/qa_error.py \
174         qa/qa_instance.py \
175         qa/qa_node.py \
176         qa/qa_os.py \
177         qa/qa_rapi.py \
178         qa/qa_tags.py \
179         qa/qa_utils.py
180
181 man_MANS = \
182         man/ganeti.7 \
183         man/ganeti-masterd.8 \
184         man/ganeti-noded.8 \
185         man/ganeti-os-interface.7 \
186         man/ganeti-rapi.8 \
187         man/ganeti-watcher.8 \
188         man/gnt-backup.8 \
189         man/gnt-cluster.8 \
190         man/gnt-debug.8 \
191         man/gnt-instance.8 \
192         man/gnt-job.8 \
193         man/gnt-node.8 \
194         man/gnt-os.8
195
196 mansgml = $(patsubst %.7,%.sgml,$(patsubst %.8,%.sgml,$(man_MANS)))
197 manhtml = $(patsubst %.sgml,%.html,$(mansgml))
198 maninput = $(patsubst %.7,%.7.in,$(patsubst %.8,%.8.in,$(man_MANS))) $(patsubst %.html,%.html.in,$(manhtml))
199
200 TEST_FILES = \
201         test/data/bdev-both.txt \
202         test/data/bdev-disk.txt \
203         test/data/bdev-net.txt \
204         test/data/proc_drbd8.txt
205
206 dist_TESTS = \
207         test/ganeti.bdev_unittest.py \
208         test/ganeti.cli_unittest.py \
209         test/ganeti.cmdlib_unittest.py \
210         test/ganeti.config_unittest.py \
211         test/ganeti.constants_unittest.py \
212         test/ganeti.hooks_unittest.py \
213         test/ganeti.http_unittest.py \
214         test/ganeti.locking_unittest.py \
215         test/ganeti.rapi.resources_unittest.py \
216         test/ganeti.serializer_unittest.py \
217         test/ganeti.ssh_unittest.py \
218         test/ganeti.utils_unittest.py \
219         test/ganeti.workerpool_unittest.py
220
221 nodist_TESTS =
222
223 TESTS = $(dist_TESTS) $(nodist_TESTS)
224
225 TESTS_ENVIRONMENT = PYTHONPATH=.:$(top_builddir)
226
227 RAPI_RESOURCES = $(wildcard lib/rapi/*.py)
228
229 all-local: stamp-directories lib/_autoconf.py devel/upload \
230         doc/examples/bash_completion \
231         doc/examples/ganeti.initd doc/examples/ganeti.cron
232
233 devel/upload: devel/upload.in stamp-directories $(REPLACE_VARS_SED)
234         sed -f $(REPLACE_VARS_SED) < $< > $@
235         chmod u+x $@
236
237 doc/examples/%: doc/examples/%.in stamp-directories \
238                 $(REPLACE_VARS_SED)
239         sed -f $(REPLACE_VARS_SED) < $< > $@
240
241 doc/%.html: doc/%.rst
242         @test -n "$(RST2HTML)" || { echo 'rst2html' not found during configure; exit 1; }
243         $(RST2HTML) $< $@
244
245 doc/%.png: doc/%.dot
246         @test -n "$(DOT)" || { echo 'dot' not found during configure; exit 1; }
247         $(DOT) -Tpng -o $@ $<
248
249 doc/design-2.0.html: doc/design-2.0.rst doc/arch-2.0.png
250
251 doc/rapi.html: doc/rapi-resources.gen
252
253 doc/rapi-resources.gen: $(BUILD_RAPI_RESOURCE_DOC) $(RAPI_RESOURCES)
254         PYTHONPATH=.:$(top_builddir) $(BUILD_RAPI_RESOURCE_DOC) > $@ || \
255           rm -f $@
256
257 man/%.7.in man/%.8.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
258         @test -n "$(DOCBOOK2MAN)" || { echo 'docbook2html' not found during configure; exit 1; }
259         TMPDIR=`mktemp -d` && { \
260         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $$TMPDIR/$(patsubst man/%.in,%,$@) ; \
261         mv $$TMPDIR/$(patsubst man/%.in,%,$@) $@ ; \
262         rm -rf "$$TMPDIR" ; \
263         }
264
265 man/%.html.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
266         @test -n "$(DOCBOOK2HTML)" || { echo 'docbook2html' not found during configure; exit 1; }
267         TMPDIR=`mktemp -d` && { \
268         $(DOCBOOK_WRAPPER) "$(DOCBOOK2HTML) --nochunks" $< $$TMPDIR/$(patsubst man/%.in,%,$@) ; \
269         mv $$TMPDIR/$(patsubst man/%.in,%,$@) $@ ; \
270         rm -rf "$$TMPDIR" ; \
271         }
272
273 man/%.7: man/%.7.in stamp-directories $(REPLACE_VARS_SED)
274         sed -f $(REPLACE_VARS_SED) < $< > $@
275
276 man/%.8: man/%.8.in stamp-directories $(REPLACE_VARS_SED)
277         sed -f $(REPLACE_VARS_SED) < $< > $@
278
279 man/%.html: man/%.html.in stamp-directories $(REPLACE_VARS_SED)
280         sed -f $(REPLACE_VARS_SED) < $< > $@
281
282 man/footer.sgml $(TESTS): srclinks
283
284 $(TESTS) $(BUILD_RAPI_RESOURCE_DOC): ganeti lib/_autoconf.py
285
286 lib/_autoconf.py: Makefile stamp-directories
287         set -e; \
288         { echo '# This file is automatically generated, do not edit!'; \
289           echo '#'; \
290           echo ''; \
291           echo '"""Build-time configuration for Ganeti.'; \
292           echo '';\
293           echo 'This file is autogenerated by the build process.'; \
294           echo 'For any changes you need to re-run ./configure (and'; \
295           echo 'not edit by hand).'; \
296           echo ''; \
297           echo '"""'; \
298           echo ''; \
299           echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
300           echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
301           echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \
302           echo "VERSION_REVISION = '$(VERSION_REVISION)'"; \
303           echo "VERSION_SUFFIX = '$(VERSION_SUFFIX)'"; \
304           echo "VERSION_FULL = '$(VERSION_FULL)'"; \
305           echo "LOCALSTATEDIR = '$(localstatedir)'"; \
306           echo "SYSCONFDIR = '$(sysconfdir)'"; \
307           echo "SSH_INITD_SCRIPT = '$(SSH_INITD_SCRIPT)'"; \
308           echo "EXPORT_DIR = '$(EXPORT_DIR)'"; \
309           echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
310           echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
311           echo "XEN_INITRD = '$(XEN_INITRD)'"; \
312           echo "FILE_STORAGE_DIR = '$(FILE_STORAGE_DIR)'"; \
313           echo "IALLOCATOR_SEARCH_PATH = [$(IALLOCATOR_SEARCH_PATH)]"; \
314           echo "KVM_PATH = '$(KVM_PATH)'"; \
315           echo "KVM_MIGRATION_PORT = '$(KVM_MIGRATION_PORT)'"; \
316           echo "SOCAT_PATH = '$(SOCAT_PATH)'"; \
317         } > $@
318
319 $(REPLACE_VARS_SED): Makefile stamp-directories
320         set -e; \
321         { echo 's#@PREFIX@#$(prefix)#g'; \
322           echo 's#@SYSCONFDIR@#$(sysconfdir)#g'; \
323           echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
324           echo 's#@SBINDIR@#$(sbindir)#g'; \
325           echo 's#@GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
326           echo 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
327           echo 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
328           echo 's#@RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
329         } > $@
330
331 # We need to create symlinks because "make distcheck" will not install Python
332 # files when building.
333 #.PHONY: srclinks
334 srclinks: stamp-directories
335         set -e; \
336         for i in man/footer.sgml $(pkgpython_PYTHON) $(hypervisor_PYTHON) \
337                         $(rapi_PYTHON) $(http_PYTHON); do \
338                 if test ! -f $$i -a -f $(abs_top_srcdir)/$$i; then \
339                         $(LN_S) $(abs_top_srcdir)/$$i $$i; \
340                 fi; \
341         done
342
343 .PHONY: ganeti
344 ganeti:
345         cd $(top_builddir) && test -h "$@" || { rm -f $@ && $(LN_S) lib $@; }
346
347 # a dist hook rule for catching revision control directories
348 distcheck-hook:
349         if find $(top_distdir) | grep -F -e '.svn' -e '.git'; then \
350                 echo "Found revision control files in final archive" 1>&2 ; \
351                 exit 1; \
352         fi
353
354 install-exec-local:
355         @mkdir_p@ "$(DESTDIR)${localstatedir}/lib/ganeti" \
356           "$(DESTDIR)${localstatedir}/log/ganeti" \
357           "$(DESTDIR)${localstatedir}/run/ganeti"
358
359 stamp-directories: Makefile
360         @mkdir_p@ $(DIRS)
361         touch $@
362
363 .PHONY: apidoc
364 apidoc:
365         test -e doc/api || mkdir doc/api
366         TMPDIR=`mktemp -d ` && { \
367                 cp -r scripts daemons lib $$TMPDIR && \
368                 ( \
369                         CDIR=`pwd` && \
370                         cd $$TMPDIR && \
371                         mv lib ganeti && \
372                         epydoc -v --conf $$CDIR/epydoc.conf -o $$CDIR/doc/api \
373                 ) ; \
374                 rm -rf $$TMPDIR ; \
375         }
376
377 # vim: set noet :