Switch the documentation to sphinx
[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 REPLACE_VARS_SED = autotools/replace_vars.sed
15
16 hypervisordir = $(pkgpythondir)/hypervisor
17 httpdir = $(pkgpythondir)/http
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/http \
30         lib/hypervisor \
31         lib/rapi \
32         man \
33         qa \
34         scripts \
35         test \
36         test/data \
37         tools
38
39 MAINTAINERCLEANFILES = \
40         $(docpng) \
41         $(maninput)
42
43 maintainer-clean-local:
44         -rm -rf doc/api doc/build doc/html
45
46 CLEANFILES = \
47         autotools/replace_vars.sed \
48         devel/upload \
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/index.rst \
117         doc/install.rst \
118         doc/rapi.rst \
119         doc/security.rst
120
121 doc/html: $(docrst) $(docpng) doc/conf.py configure.ac
122         @test -n "$(SPHINX)" || \
123             { echo 'sphinx-build' not found during configure; exit 1; }
124         mkdir -p doc/build/doctrees
125         PYTHONPATH=.:$(top_builddir) sphinx-build -q -b html \
126             -d doc/build/doctrees \
127             -D version="$(VERSION_MAJOR).$(VERSION_MINOR)" \
128             -D release="$(PACKAGE_VERSION)" \
129             $(top_srcdir)/doc doc/html
130         touch "$@"
131
132 docdot = \
133         doc/arch-2.0.dot
134
135 docpng = $(patsubst %.dot,%.png,$(docdot))
136
137 noinst_DATA = $(manhtml) doc/html
138
139 dist_sbin_SCRIPTS = \
140         daemons/ganeti-noded \
141         daemons/ganeti-watcher \
142         daemons/ganeti-masterd \
143         daemons/ganeti-rapi \
144         scripts/gnt-backup \
145         scripts/gnt-cluster \
146         scripts/gnt-debug \
147         scripts/gnt-instance \
148         scripts/gnt-job \
149         scripts/gnt-node \
150         scripts/gnt-os
151
152 dist_tools_SCRIPTS = \
153         tools/burnin \
154         tools/cfgshell \
155         tools/cfgupgrade \
156         tools/lvmstrap
157
158 EXTRA_DIST = \
159         $(MAINTAINERCLEANFILES) \
160         NEWS \
161         DEVNOTES \
162         autotools/docbook-wrapper \
163         devel/upload.in \
164         $(docdot) \
165         $(docrst) \
166         doc/conf.py \
167         doc/html \
168         doc/examples/bash_completion.in \
169         doc/examples/ganeti.initd.in \
170         doc/examples/ganeti.cron.in \
171         doc/examples/dumb-allocator \
172         doc/locking.txt \
173         test/testutils.py \
174         test/mocks.py \
175         $(dist_TESTS) \
176         $(TEST_FILES) \
177         man/footer.sgml \
178         $(mansgml) $(maninput) \
179         qa/ganeti-qa.py \
180         qa/qa-sample.json \
181         qa/qa_cluster.py \
182         qa/qa_config.py \
183         qa/qa_daemon.py \
184         qa/qa_env.py \
185         qa/qa_error.py \
186         qa/qa_instance.py \
187         qa/qa_node.py \
188         qa/qa_os.py \
189         qa/qa_rapi.py \
190         qa/qa_tags.py \
191         qa/qa_utils.py
192
193 man_MANS = \
194         man/ganeti.7 \
195         man/ganeti-masterd.8 \
196         man/ganeti-noded.8 \
197         man/ganeti-os-interface.7 \
198         man/ganeti-rapi.8 \
199         man/ganeti-watcher.8 \
200         man/gnt-backup.8 \
201         man/gnt-cluster.8 \
202         man/gnt-debug.8 \
203         man/gnt-instance.8 \
204         man/gnt-job.8 \
205         man/gnt-node.8 \
206         man/gnt-os.8
207
208 mansgml = $(patsubst %.7,%.sgml,$(patsubst %.8,%.sgml,$(man_MANS)))
209 manhtml = $(patsubst %.sgml,%.html,$(mansgml))
210 maninput = $(patsubst %.7,%.7.in,$(patsubst %.8,%.8.in,$(man_MANS))) $(patsubst %.html,%.html.in,$(manhtml))
211
212 TEST_FILES = \
213         test/data/bdev-both.txt \
214         test/data/bdev-disk.txt \
215         test/data/bdev-net.txt \
216         test/data/proc_drbd8.txt
217
218 dist_TESTS = \
219         test/ganeti.bdev_unittest.py \
220         test/ganeti.cli_unittest.py \
221         test/ganeti.cmdlib_unittest.py \
222         test/ganeti.config_unittest.py \
223         test/ganeti.constants_unittest.py \
224         test/ganeti.hooks_unittest.py \
225         test/ganeti.http_unittest.py \
226         test/ganeti.locking_unittest.py \
227         test/ganeti.rapi.resources_unittest.py \
228         test/ganeti.serializer_unittest.py \
229         test/ganeti.ssh_unittest.py \
230         test/ganeti.utils_unittest.py \
231         test/ganeti.workerpool_unittest.py
232
233 nodist_TESTS =
234
235 TESTS = $(dist_TESTS) $(nodist_TESTS)
236
237 TESTS_ENVIRONMENT = PYTHONPATH=.:$(top_builddir)
238
239 all-local: stamp-directories lib/_autoconf.py devel/upload \
240         doc/examples/bash_completion \
241         doc/examples/ganeti.initd doc/examples/ganeti.cron
242
243 devel/upload: devel/upload.in stamp-directories $(REPLACE_VARS_SED)
244         sed -f $(REPLACE_VARS_SED) < $< > $@
245         chmod u+x $@
246
247 doc/examples/%: doc/examples/%.in stamp-directories \
248                 $(REPLACE_VARS_SED)
249         sed -f $(REPLACE_VARS_SED) < $< > $@
250
251 doc/%.png: doc/%.dot
252         @test -n "$(DOT)" || { echo 'dot' not found during configure; exit 1; }
253         $(DOT) -Tpng -o $@ $<
254
255 man/%.7.in man/%.8.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
256         @test -n "$(DOCBOOK2MAN)" || { echo 'docbook2html' not found during configure; exit 1; }
257         TMPDIR=`mktemp -d` && { \
258         $(DOCBOOK_WRAPPER) "$(DOCBOOK2MAN)" $< $$TMPDIR/$(patsubst man/%.in,%,$@) ; \
259         mv $$TMPDIR/$(patsubst man/%.in,%,$@) $@ ; \
260         rm -rf "$$TMPDIR" ; \
261         }
262
263 man/%.html.in: man/%.sgml man/footer.sgml $(DOCBOOK_WRAPPER)
264         @test -n "$(DOCBOOK2HTML)" || { echo 'docbook2html' not found during configure; exit 1; }
265         TMPDIR=`mktemp -d` && { \
266         $(DOCBOOK_WRAPPER) "$(DOCBOOK2HTML) --nochunks" $< $$TMPDIR/$(patsubst man/%.in,%,$@) ; \
267         mv $$TMPDIR/$(patsubst man/%.in,%,$@) $@ ; \
268         rm -rf "$$TMPDIR" ; \
269         }
270
271 man/%.7: man/%.7.in stamp-directories $(REPLACE_VARS_SED)
272         sed -f $(REPLACE_VARS_SED) < $< > $@
273
274 man/%.8: man/%.8.in stamp-directories $(REPLACE_VARS_SED)
275         sed -f $(REPLACE_VARS_SED) < $< > $@
276
277 man/%.html: man/%.html.in stamp-directories $(REPLACE_VARS_SED)
278         sed -f $(REPLACE_VARS_SED) < $< > $@
279
280 man/footer.sgml $(TESTS): srclinks
281
282 $(TESTS): ganeti lib/_autoconf.py
283
284 lib/_autoconf.py: Makefile stamp-directories
285         set -e; \
286         { echo '# This file is automatically generated, do not edit!'; \
287           echo '#'; \
288           echo ''; \
289           echo '"""Build-time configuration for Ganeti.'; \
290           echo '';\
291           echo 'This file is autogenerated by the build process.'; \
292           echo 'For any changes you need to re-run ./configure (and'; \
293           echo 'not edit by hand).'; \
294           echo ''; \
295           echo '"""'; \
296           echo ''; \
297           echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
298           echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
299           echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \
300           echo "VERSION_REVISION = '$(VERSION_REVISION)'"; \
301           echo "VERSION_SUFFIX = '$(VERSION_SUFFIX)'"; \
302           echo "VERSION_FULL = '$(VERSION_FULL)'"; \
303           echo "LOCALSTATEDIR = '$(localstatedir)'"; \
304           echo "SYSCONFDIR = '$(sysconfdir)'"; \
305           echo "SSH_INITD_SCRIPT = '$(SSH_INITD_SCRIPT)'"; \
306           echo "EXPORT_DIR = '$(EXPORT_DIR)'"; \
307           echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
308           echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
309           echo "XEN_INITRD = '$(XEN_INITRD)'"; \
310           echo "FILE_STORAGE_DIR = '$(FILE_STORAGE_DIR)'"; \
311           echo "IALLOCATOR_SEARCH_PATH = [$(IALLOCATOR_SEARCH_PATH)]"; \
312           echo "KVM_PATH = '$(KVM_PATH)'"; \
313           echo "KVM_MIGRATION_PORT = '$(KVM_MIGRATION_PORT)'"; \
314           echo "SOCAT_PATH = '$(SOCAT_PATH)'"; \
315         } > $@
316
317 $(REPLACE_VARS_SED): Makefile stamp-directories
318         set -e; \
319         { echo 's#@PREFIX@#$(prefix)#g'; \
320           echo 's#@SYSCONFDIR@#$(sysconfdir)#g'; \
321           echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
322           echo 's#@SBINDIR@#$(sbindir)#g'; \
323           echo 's#@GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
324           echo 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
325           echo 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
326           echo 's#@RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
327         } > $@
328
329 # We need to create symlinks because "make distcheck" will not install Python
330 # files when building.
331 #.PHONY: srclinks
332 srclinks: stamp-directories
333         set -e; \
334         for i in man/footer.sgml $(pkgpython_PYTHON) $(hypervisor_PYTHON) \
335                         $(rapi_PYTHON) $(http_PYTHON); do \
336                 if test ! -f $$i -a -f $(abs_top_srcdir)/$$i; then \
337                         $(LN_S) $(abs_top_srcdir)/$$i $$i; \
338                 fi; \
339         done
340
341 .PHONY: ganeti
342 ganeti:
343         cd $(top_builddir) && test -h "$@" || { rm -f $@ && $(LN_S) lib $@; }
344
345 # a dist hook rule for catching revision control directories
346 distcheck-hook:
347         if find $(top_distdir) | grep -F -e '.svn' -e '.git'; then \
348                 echo "Found revision control files in final archive" 1>&2 ; \
349                 exit 1; \
350         fi
351
352 install-exec-local:
353         @mkdir_p@ "$(DESTDIR)${localstatedir}/lib/ganeti" \
354           "$(DESTDIR)${localstatedir}/log/ganeti" \
355           "$(DESTDIR)${localstatedir}/run/ganeti"
356
357 stamp-directories: Makefile
358         @mkdir_p@ $(DIRS)
359         touch $@
360
361 .PHONY: apidoc
362 apidoc:
363         test -e doc/api || mkdir doc/api
364         TMPDIR=`mktemp -d ` && { \
365                 cp -r scripts daemons lib $$TMPDIR && \
366                 ( \
367                         CDIR=`pwd` && \
368                         cd $$TMPDIR && \
369                         mv lib ganeti && \
370                         epydoc -v --conf $$CDIR/epydoc.conf -o $$CDIR/doc/api \
371                 ) ; \
372                 rm -rf $$TMPDIR ; \
373         }
374
375 # vim: set noet :