Convert the install document to restructured text.
[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 CLEANFILES = \
41         autotools/replace_vars.sed \
42         devel/upload \
43         doc/*.html \
44         doc/*.in \
45         doc/*.pdf \
46         $(patsubst %.dot,%.png,$(docdot)) \
47         doc/rapi-resources.sgml \
48         doc/examples/bash_completion \
49         doc/examples/ganeti.initd \
50         doc/examples/ganeti.cron \
51         lib/*.py[co] \
52         lib/http/*.py[co] \
53         lib/hypervisor/*.py[co] \
54         lib/rapi/*.py[co] \
55         man/*.[78] \
56         man/*.in \
57         man/*.html \
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 docsgml = \
112         doc/rapi.sgml
113
114 docrst = \
115         doc/admin.rst \
116         doc/design-2.0.rst \
117         doc/hooks.rst \
118         doc/iallocator.rst \
119         doc/install.rst \
120         doc/security.rst
121
122 docdot = \
123         doc/arch-2.0.dot
124
125 doc_DATA = \
126         $(patsubst %.rst,%.html,$(docrst)) \
127         $(patsubst %.sgml,%.html,$(docsgml)) \
128         $(patsubst %.sgml,%.pdf,$(docsgml))
129
130 noinst_DATA = $(manhtml)
131
132 dist_sbin_SCRIPTS = \
133         daemons/ganeti-noded \
134         daemons/ganeti-watcher \
135         daemons/ganeti-masterd \
136         daemons/ganeti-rapi \
137         scripts/gnt-backup \
138         scripts/gnt-cluster \
139         scripts/gnt-debug \
140         scripts/gnt-instance \
141         scripts/gnt-job \
142         scripts/gnt-node \
143         scripts/gnt-os
144
145 dist_tools_SCRIPTS = \
146         tools/burnin \
147         tools/cfgshell \
148         tools/cfgupgrade \
149         tools/lvmstrap
150
151 EXTRA_DIST = \
152         NEWS \
153         DEVNOTES \
154         autotools/docbook-wrapper \
155         devel/upload.in \
156         $(docrst) \
157         $(docdot) \
158         $(docsgml) \
159         doc/build-rapi-resources-doc \
160         doc/examples/bash_completion.in \
161         doc/examples/ganeti.initd.in \
162         doc/examples/ganeti.cron.in \
163         doc/examples/dumb-allocator \
164         doc/locking.txt \
165         test/testutils.py \
166         test/mocks.py \
167         $(dist_TESTS) \
168         $(TEST_FILES) \
169         man/footer.sgml \
170         $(mansgml) \
171         qa/ganeti-qa.py \
172         qa/qa-sample.json \
173         qa/qa_cluster.py \
174         qa/qa_config.py \
175         qa/qa_daemon.py \
176         qa/qa_env.py \
177         qa/qa_error.py \
178         qa/qa_instance.py \
179         qa/qa_node.py \
180         qa/qa_os.py \
181         qa/qa_rapi.py \
182         qa/qa_tags.py \
183         qa/qa_utils.py
184
185 man_MANS = \
186         man/ganeti.7 \
187         man/ganeti-masterd.8 \
188         man/ganeti-noded.8 \
189         man/ganeti-os-interface.7 \
190         man/ganeti-rapi.8 \
191         man/ganeti-watcher.8 \
192         man/gnt-backup.8 \
193         man/gnt-cluster.8 \
194         man/gnt-debug.8 \
195         man/gnt-instance.8 \
196         man/gnt-job.8 \
197         man/gnt-node.8 \
198         man/gnt-os.8
199
200 maninput = $(patsubst %.7,%.in,$(patsubst %.8,%.in,$(man_MANS)))
201 mansgml = $(patsubst %.in,%.sgml,$(maninput))
202 manhtml = $(patsubst %.in,%.html,$(maninput))
203
204 TEST_FILES = \
205         test/data/bdev-both.txt \
206         test/data/bdev-disk.txt \
207         test/data/bdev-net.txt \
208         test/data/proc_drbd8.txt
209
210 dist_TESTS = \
211         test/ganeti.bdev_unittest.py \
212         test/ganeti.cli_unittest.py \
213         test/ganeti.cmdlib_unittest.py \
214         test/ganeti.config_unittest.py \
215         test/ganeti.constants_unittest.py \
216         test/ganeti.hooks_unittest.py \
217         test/ganeti.http_unittest.py \
218         test/ganeti.locking_unittest.py \
219         test/ganeti.rapi.resources_unittest.py \
220         test/ganeti.serializer_unittest.py \
221         test/ganeti.ssh_unittest.py \
222         test/ganeti.utils_unittest.py \
223         test/ganeti.workerpool_unittest.py
224
225 nodist_TESTS =
226
227 TESTS = $(dist_TESTS) $(nodist_TESTS)
228
229 TESTS_ENVIRONMENT = PYTHONPATH=.:$(top_builddir)
230
231
232 all-local: stamp-directories lib/_autoconf.py devel/upload \
233         doc/examples/bash_completion \
234         doc/examples/ganeti.initd doc/examples/ganeti.cron
235
236 devel/upload: devel/upload.in stamp-directories $(REPLACE_VARS_SED)
237         sed -f $(REPLACE_VARS_SED) < $< > $@
238         chmod u+x $@
239
240 doc/examples/%: doc/examples/%.in stamp-directories \
241                 $(REPLACE_VARS_SED)
242         sed -f $(REPLACE_VARS_SED) < $< > $@
243
244 doc/%.in: doc/%.sgml stamp-directories $(REPLACE_VARS_SED)
245         sed -f $(REPLACE_VARS_SED) < $< > $@
246
247 man/%.in: man/%.sgml stamp-directories $(REPLACE_VARS_SED)
248         sed -f $(REPLACE_VARS_SED) < $< > $@
249
250 doc/%.pdf: doc/%.in $(DOCBOOK_WRAPPER)
251         $(DOCBOOK_WRAPPER) "$(DOCBOOK2PDF)" $< $@
252
253 doc/%.html: doc/%.in $(DOCBOOK_WRAPPER)
254         $(DOCBOOK_WRAPPER) "$(DOCBOOK2HTML) --nochunks" $< $@
255
256 doc/%.html: doc/%.rst
257         $(RST2HTML) $< $@
258
259 doc/%.png: doc/%.dot
260         $(DOT) -Tpng -o $@ $<
261
262 doc/design-2.0.html: doc/design-2.0.rst doc/arch-2.0.png
263
264 doc/rapi.pdf doc/rapi.html doc/rapi.in: doc/rapi-resources.sgml
265
266 doc/rapi-resources.sgml: $(BUILD_RAPI_RESOURCE_DOC) lib/rapi/connector.py
267         PYTHONPATH=.:$(top_builddir) $(BUILD_RAPI_RESOURCE_DOC) > $@ || rm -f $@
268
269 man/%.7: man/%.in man/footer.sgml $(DOCBOOK_WRAPPER)
270         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $@
271
272 man/%.8: man/%.in man/footer.sgml $(DOCBOOK_WRAPPER)
273         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $@
274
275 man/%.html: man/%.in $(DOCBOOK_WRAPPER)
276         $(DOCBOOK_WRAPPER) "$(DOCBOOK2HTML) --nochunks" $< $@
277
278 man/footer.sgml $(TESTS): srclinks
279
280 $(TESTS) $(BUILD_RAPI_RESOURCE_DOC): ganeti lib/_autoconf.py
281
282 lib/_autoconf.py: Makefile stamp-directories
283         set -e; \
284         { echo '# This file is automatically generated, do not edit!'; \
285           echo '#'; \
286           echo ''; \
287           echo '"""Build-time configuration for Ganeti.'; \
288           echo '';\
289           echo 'This file is autogenerated by the build process.'; \
290           echo 'For any changes you need to re-run ./configure (and'; \
291           echo 'not edit by hand).'; \
292           echo ''; \
293           echo '"""'; \
294           echo ''; \
295           echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
296           echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
297           echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \
298           echo "VERSION_REVISION = '$(VERSION_REVISION)'"; \
299           echo "VERSION_SUFFIX = '$(VERSION_SUFFIX)'"; \
300           echo "VERSION_FULL = '$(VERSION_FULL)'"; \
301           echo "LOCALSTATEDIR = '$(localstatedir)'"; \
302           echo "SYSCONFDIR = '$(sysconfdir)'"; \
303           echo "SSH_INITD_SCRIPT = '$(SSH_INITD_SCRIPT)'"; \
304           echo "EXPORT_DIR = '$(EXPORT_DIR)'"; \
305           echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
306           echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
307           echo "XEN_INITRD = '$(XEN_INITRD)'"; \
308           echo "FILE_STORAGE_DIR = '$(FILE_STORAGE_DIR)'"; \
309           echo "IALLOCATOR_SEARCH_PATH = [$(IALLOCATOR_SEARCH_PATH)]"; \
310           echo "KVM_PATH = '$(KVM_PATH)'"; \
311           echo "KVM_MIGRATION_PORT = '$(KVM_MIGRATION_PORT)'"; \
312           echo "SOCAT_PATH = '$(SOCAT_PATH)'"; \
313         } > $@
314
315 $(REPLACE_VARS_SED): Makefile stamp-directories
316         set -e; \
317         { echo 's#@PREFIX@#$(prefix)#g'; \
318           echo 's#@SYSCONFDIR@#$(sysconfdir)#g'; \
319           echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
320           echo 's#@SBINDIR@#$(sbindir)#g'; \
321           echo 's#@GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
322           echo 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
323           echo 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
324           echo 's#@RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
325           echo '/@INCLUDE_RAPI_RESOURCES@/ {'; \
326           echo '  r $(abs_top_builddir)/doc/rapi-resources.sgml'; \
327           echo '  d'; \
328           echo '}'; \
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 :