CHECK_PYTHON_CODE = $(top_srcdir)/autotools/check-python-code
CHECK_HEADER = $(top_srcdir)/autotools/check-header
CHECK_MAN_DASHES = $(top_srcdir)/autotools/check-man-dashes
+CHECK_MAN_REFERENCES = $(top_srcdir)/autotools/check-man-references
CHECK_MAN_WARNINGS = $(top_srcdir)/autotools/check-man-warnings
CHECK_VERSION = $(top_srcdir)/autotools/check-version
CHECK_NEWS = $(top_srcdir)/autotools/check-news
daemons \
devel \
doc \
+ doc/css \
doc/examples \
- doc/examples/css \
doc/examples/gnt-debug \
doc/examples/hooks \
test/data/htools \
qa \
test \
test/data \
+ test/data/bdev-rbd \
test/data/ovfdata \
test/data/ovfdata/other \
test/py \
BUILDTIME_DIRS = \
$(BUILDTIME_DIR_AUTOCREATE) \
- doc/html
+ doc/html \
+ doc/man-html
DIRCHECK_EXCLUDE = \
$(BUILDTIME_DIRS) \
ganeti-[0-9]*.[0-9]*.[0-9]* \
doc/html/_* \
+ doc/man-html/_* \
autom4te.cache
# some helper vars
$(SHELL_ENV_INIT) \
daemons/daemon-util \
daemons/ganeti-cleaner \
+ $(mandocrst) \
+ doc/manpages-enabled.rst \
$(BUILT_EXAMPLES) \
doc/examples/bash_completion \
doc/examples/bash_completion-debug \
lib/mcpu.py \
lib/netutils.py \
lib/objects.py \
- lib/objectutils.py \
lib/opcodes.py \
+ lib/outils.py \
lib/ovf.py \
lib/pathutils.py \
lib/qlang.py \
pytools_PYTHON = \
lib/tools/__init__.py \
+ lib/tools/burnin.py \
lib/tools/ensure_dirs.py \
lib/tools/node_cleanup.py \
lib/tools/node_daemon_setup.py \
lib/utils/wrapper.py \
lib/utils/x509.py
-docrst = \
+docinput = \
+ doc/conf.py \
+ doc/css/style.css \
doc/admin.rst \
doc/cluster-merge.rst \
doc/design-2.0.rst \
doc/design-partitioned.rst \
doc/design-query-splitting.rst \
doc/design-query2.rst \
- doc/design-remote-commands.rst \
doc/design-resource-model.rst \
+ doc/design-restricted-commands.rst \
doc/design-shared-storage.rst \
doc/design-monitoring-agent.rst \
doc/design-virtual-clusters.rst \
doc/install-quick.rst \
doc/install.rst \
doc/locking.rst \
+ doc/manpages-disabled.rst \
doc/move-instance.rst \
doc/news.rst \
doc/ovfconverter.rst \
doc/virtual-cluster.rst \
doc/walkthrough.rst
+# Generates file names such as "doc/man-gnt-instance.rst"
+mandocrst = $(addprefix doc/man-,$(notdir $(manrst)))
+
# Haskell programs to be installed in $PREFIX/bin
HS_BIN_PROGS=src/htools
src/Ganeti/DataCollectors/CLI.hs \
src/Ganeti/DataCollectors/Drbd.hs \
src/Ganeti/DataCollectors/Program.hs \
+ src/Ganeti/DataCollectors/Types.hs \
src/Ganeti/Errors.hs \
src/Ganeti/HTools/Backend/IAlloc.hs \
src/Ganeti/HTools/Backend/Luxi.hs \
test/hs/Test/Ganeti/Query/Language.hs \
test/hs/Test/Ganeti/Query/Query.hs \
test/hs/Test/Ganeti/Rpc.hs \
+ test/hs/Test/Ganeti/Runtime.hs \
test/hs/Test/Ganeti/Ssconf.hs \
test/hs/Test/Ganeti/THH.hs \
test/hs/Test/Ganeti/TestCommon.hs \
$(RUN_IN_TEMPDIR): | stamp-directories
+doc/html/index.html: ENABLE_MANPAGES =
+doc/man-html/index.html: ENABLE_MANPAGES = 1
+doc/man-html/index.html: doc/manpages-enabled.rst $(mandocrst)
+
# Note: we use here an order-only prerequisite, as the contents of
# _autoconf.py are not actually influencing the html build output: it
# has to exist in order for the sphinx module to be loaded
# successfully, but we certainly don't want the docs to be rebuilt if
# it changes
-doc/html/index.html: $(docrst) doc/conf.py configure.ac \
- $(RUN_IN_TEMPDIR) lib/build/sphinx_ext.py \
+doc/html/index.html doc/man-html/index.html: $(docinput) doc/conf.py \
+ configure.ac $(RUN_IN_TEMPDIR) lib/build/sphinx_ext.py \
lib/build/shell_example_lexer.py lib/opcodes.py lib/ht.py \
doc/css/style.css \
| $(BUILT_PYTHON_SOURCES)
@test -n "$(SPHINX)" || \
{ echo 'sphinx-build' not found during configure; exit 1; }
- @mkdir_p@ $(dir $@)
- PYTHONPATH=. $(RUN_IN_TEMPDIR) $(SPHINX) -q -W -b html \
+if !MANPAGES_IN_DOC
+ if test -n '$(ENABLE_MANPAGES)'; then \
+ echo 'Man pages in documentation were disabled at configure time' >&2; \
+ exit 1; \
+ fi
+endif
+## Sphinx provides little control over what content should be included. Some
+## mechanisms exist, but they all have drawbacks or actual issues. Since we
+## build two different versions of the documentation--once without man pages and
+## once, if enabled, with them--some control is necessary. xmpp-wrapper provides
+## us with this, but requires running in a temporary directory. It moves the
+## correct files into place depending on environment variables.
+ dir=$(dir $@) && \
+ @mkdir_p@ $$dir && \
+ PYTHONPATH=. ENABLE_MANPAGES=$(ENABLE_MANPAGES) COPY_DOC=1 \
+ $(RUN_IN_TEMPDIR) autotools/sphinx-wrapper $(SPHINX) -q -W -b html \
-d . \
-D version="$(VERSION_MAJOR).$(VERSION_MINOR)" \
-D release="$(PACKAGE_VERSION)" \
-D graphviz_dot="$(DOT)" \
- $(abs_top_srcdir)/doc $(CURDIR)/doc/html
- rm -f doc/html/.buildinfo doc/html/objects.inv
+ -D enable_manpages="$(ENABLE_MANPAGES)" \
+ doc $(CURDIR)/$$dir && \
+ rm -f $$dir/.buildinfo $$dir/objects.inv
touch $@
doc/html: doc/html/index.html
+doc/man-html: doc/man-html/index.html
+
doc/install-quick.rst: INSTALL
doc/news.rst: NEWS
doc/upgrade.rst: UPGRADE
cat $<; \
} > $@
+doc/manpages-enabled.rst: Makefile | $(built_base_sources)
+ { echo '.. This file is automatically generated, do not edit!'; \
+ echo ''; \
+ echo 'Man pages'; \
+ echo '========='; \
+ echo; \
+ echo '.. toctree::'; \
+ echo ' :maxdepth: 1'; \
+ echo; \
+ for i in $(notdir $(mandocrst)); do \
+ echo " $$i"; \
+ done | LC_ALL=C sort; \
+ } > $@
+
+doc/man-%.rst: man/%.gen Makefile $(REPLACE_VARS_SED) | $(built_base_sources)
+if MANPAGES_IN_DOC
+ { echo '.. This file is automatically updated at build time from $<.'; \
+ echo '.. Do not edit.'; \
+ echo; \
+ echo "$*"; \
+ echo '=========================================='; \
+ tail -n +3 $< | sed -f $(REPLACE_VARS_SED); \
+ } > $@
+else
+ echo 'Man pages in documentation were disabled at configure time' >&2; \
+ exit 1;
+endif
+
# Things to build but not to install (add it to EXTRA_DIST if it should be
# distributed)
noinst_DATA = \
doc/examples/bash_completion-debug \
$(manhtml)
+if MANPAGES_IN_DOC
+noinst_DATA += doc/man-html
+endif
+
gnt_scripts = \
scripts/gnt-backup \
scripts/gnt-cluster \
PYTHON_BOOTSTRAP = \
$(PYTHON_BOOTSTRAP_SBIN) \
+ tools/burnin \
tools/ensure-dirs \
tools/node-cleanup \
tools/node-daemon-setup \
endif
python_scripts = \
- tools/burnin \
tools/cfgshell \
tools/cfgupgrade \
tools/cfgupgrade12 \
tools/check-cert-expired
nodist_pkglib_python_scripts = \
+ tools/burnin \
tools/ensure-dirs \
tools/node-daemon-setup \
tools/prepare-node-join
autotools/check-header \
autotools/check-imports \
autotools/check-man-dashes \
+ autotools/check-man-references \
autotools/check-man-warnings \
autotools/check-news \
autotools/check-python-code \
autotools/convert-constants \
autotools/docpp \
autotools/gen-py-coverage \
+ autotools/sphinx-wrapper \
autotools/testrunner \
autotools/wrong-hardcoded-paths \
$(RUN_IN_TEMPDIR) \
devel/webserver \
tools/kvm-ifup.in \
tools/vcluster-setup.in \
- $(docrst) \
- doc/conf.py \
- doc/css/style.css \
+ $(docinput) \
doc/html \
$(BUILT_EXAMPLES:%=%.in) \
doc/examples/ganeti.default \
man/htools.1 \
man/mon-collector.7
-manrst = $(patsubst %.1,%.rst,$(patsubst %.7,%.rst,$(patsubst %.8,%.rst,$(man_MANS))))
+# Remove extensions from all filenames in man_MANS
+mannoext = $(patsubst %.1,%,$(patsubst %.7,%,$(patsubst %.8,%,$(man_MANS))))
+
+manrst = $(patsubst %,%.rst,$(mannoext))
manhtml = $(patsubst %.rst,%.html,$(manrst))
mangen = $(patsubst %.rst,%.gen,$(manrst))
maninput = \
test/data/bdev-drbd-disk.txt \
test/data/bdev-drbd-net-ip4.txt \
test/data/bdev-drbd-net-ip6.txt \
+ test/data/bdev-rbd/json_output_empty.txt \
+ test/data/bdev-rbd/json_output_extra_matches.txt \
+ test/data/bdev-rbd/json_output_no_matches.txt \
+ test/data/bdev-rbd/json_output_ok.txt \
+ test/data/bdev-rbd/plain_output_new_extra_matches.txt \
+ test/data/bdev-rbd/plain_output_new_no_matches.txt \
+ test/data/bdev-rbd/plain_output_new_ok.txt \
+ test/data/bdev-rbd/plain_output_old_empty.txt \
+ test/data/bdev-rbd/plain_output_old_extra_matches.txt \
+ test/data/bdev-rbd/plain_output_old_no_matches.txt \
+ test/data/bdev-rbd/plain_output_old_ok.txt \
+ test/data/bdev-rbd/output_invalid.txt \
test/data/cert1.pem \
test/data/cert2.pem \
test/data/instance-minor-pairing.txt \
test/data/kvm_0.12.5_help.txt \
test/data/kvm_0.15.90_help.txt \
test/data/kvm_0.9.1_help.txt \
+ test/data/kvm_0.9.1_help_boot_test.txt \
test/data/kvm_1.0_help.txt \
+ test/data/kvm_1.1.2_help.txt \
test/data/ovfdata/compr_disk.vmdk.gz \
test/data/ovfdata/config.ini \
test/data/ovfdata/corrupted_resources.ovf \
test/py/ganeti.mcpu_unittest.py \
test/py/ganeti.netutils_unittest.py \
test/py/ganeti.objects_unittest.py \
- test/py/ganeti.objectutils_unittest.py \
test/py/ganeti.opcodes_unittest.py \
+ test/py/ganeti.outils_unittest.py \
test/py/ganeti.ovf_unittest.py \
test/py/ganeti.qlang_unittest.py \
test/py/ganeti.query_unittest.py \
test/py/ganeti.ssconf_unittest.py \
test/py/ganeti.ssh_unittest.py \
test/py/ganeti.storage_unittest.py \
+ test/py/ganeti.tools.burnin_unittest.py \
test/py/ganeti.tools.ensure_dirs_unittest.py \
test/py/ganeti.tools.node_daemon_setup_unittest.py \
test/py/ganeti.tools.prepare_node_join_unittest.py \
test/hs/offline-test.sh \
test/hs/cli-tests-defs.sh \
$(all_python_code) \
- $(HS_LIBTEST_SRCS) $(HS_PROG_SRCS)
+ $(HS_LIBTEST_SRCS) $(HS_PROG_SRCS) \
+ $(docinput)
check_python_code = \
$(BUILD_BASH_COMPLETION) \
| $(RUN_IN_TEMPDIR) $(BUILT_PYTHON_SOURCES)
@echo "Checking $< for hardcoded paths..."
@if grep -nEf autotools/wrong-hardcoded-paths $<; then \
- echo "Man page $< has harcoded paths (see above)!" 1>&2 ; \
+ echo "Man page $< has hardcoded paths (see above)!" 1>&2 ; \
exit 1; \
fi
set -e ; \
trap 'echo auto-removing $@; rm $@' EXIT; \
PYTHONPATH=. $(RUN_IN_TEMPDIR) $(CURDIR)/$(DOCPP) < $< > $@ ;\
+ $(CHECK_MAN_REFERENCES) $@; \
trap - EXIT
man/%.7.in man/%.8.in man/%.1.in: man/%.gen man/footer.rst
echo "OS_SEARCH_PATH = [$(OS_SEARCH_PATH)]"; \
echo "ES_SEARCH_PATH = [$(ES_SEARCH_PATH)]"; \
echo "XEN_BOOTLOADER = '$(XEN_BOOTLOADER)'"; \
+ echo "XEN_CONFIG_DIR = '$(XEN_CONFIG_DIR)'"; \
echo "XEN_KERNEL = '$(XEN_KERNEL)'"; \
echo "XEN_INITRD = '$(XEN_INITRD)'"; \
echo "KVM_KERNEL = '$(KVM_KERNEL)'"; \
echo "ENABLE_SPLIT_QUERY = $(ENABLE_SPLIT_QUERY)"; \
echo "ENABLE_RESTRICTED_COMMANDS = $(ENABLE_RESTRICTED_COMMANDS)"; \
echo "ENABLE_MONITORING = $(ENABLE_MONITORING)"; \
+## Write dictionary with man page name as the key and the section number as the
+## value
+ echo "MAN_PAGES = {"; \
+ for i in $(notdir $(man_MANS)); do \
+ echo "$$i" | sed -re 's/^(.*)\.([0-9]+)$$/ "\1": \2,/g'; \
+ done; \
+ echo "}"; \
} > $@
lib/_vcsversion.py: Makefile vcs-version | stamp-directories
echo 'readonly CONF_DIR="$$SYSCONFDIR/ganeti"'; \
} > $@
+## Writes sed script to replace placeholders with build-time values. The
+## additional quotes after the first @ sign are necessary to stop configure
+## from replacing those values as well.
$(REPLACE_VARS_SED): $(SHELL_ENV_INIT) Makefile stamp-directories
set -e; \
- { echo 's#@PREFIX@#$(prefix)#g'; \
- echo 's#@SYSCONFDIR@#$(sysconfdir)#g'; \
- echo 's#@LOCALSTATEDIR@#$(localstatedir)#g'; \
- echo 's#@BINDIR@#$(bindir)#g'; \
- echo 's#@SBINDIR@#$(sbindir)#g'; \
- echo 's#@LIBDIR@#$(libdir)#g'; \
- echo 's#@GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
- echo 's#@CUSTOM_XEN_BOOTLOADER@#$(XEN_BOOTLOADER)#g'; \
- echo 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
- echo 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
- echo 's#@CUSTOM_IALLOCATOR_SEARCH_PATH@#$(IALLOCATOR_SEARCH_PATH)#g'; \
- echo 's#@CUSTOM_EXPORT_DIR@#$(EXPORT_DIR)#g'; \
- echo 's#@RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
- echo 's#@RPL_SSH_INITD_SCRIPT@#$(SSH_INITD_SCRIPT)#g'; \
- echo 's#@PKGLIBDIR@#$(pkglibdir)#g'; \
- echo 's#@GNTMASTERUSER@#$(MASTERD_USER)#g'; \
- echo 's#@GNTRAPIUSER@#$(RAPI_USER)#g'; \
- echo 's#@GNTCONFDUSER@#$(CONFD_USER)#g'; \
- echo 's#@GNTNODEDUSER@#$(NODED_USER)#g'; \
- echo 's#@GNTRAPIGROUP@#$(RAPI_GROUP)#g'; \
- echo 's#@GNTADMINGROUP@#$(ADMIN_GROUP)#g'; \
- echo 's#@GNTCONFDGROUP@#$(CONFD_GROUP)#g'; \
- echo 's#@GNTMASTERDGROUP@#$(MASTERD_GROUP)#g'; \
- echo 's#@GNTDAEMONSGROUP@#$(DAEMONS_GROUP)#g'; \
- echo 's#@CUSTOM_ENABLE_CONFD@#$(ENABLE_CONFD)#g'; \
- echo 's#@MODULES@#$(strip $(lint_python_code))#g'; \
- echo 's#@ENABLE_SPLIT_QUERY@#$(ENABLE_SPLIT_QUERY)#g'; \
+ { echo 's#@''PREFIX@#$(prefix)#g'; \
+ echo 's#@''SYSCONFDIR@#$(sysconfdir)#g'; \
+ echo 's#@''LOCALSTATEDIR@#$(localstatedir)#g'; \
+ echo 's#@''BINDIR@#$(bindir)#g'; \
+ echo 's#@''SBINDIR@#$(sbindir)#g'; \
+ echo 's#@''LIBDIR@#$(libdir)#g'; \
+ echo 's#@''GANETI_VERSION@#$(PACKAGE_VERSION)#g'; \
+ echo 's#@''CUSTOM_XEN_BOOTLOADER@#$(XEN_BOOTLOADER)#g'; \
+ echo 's#@''CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g'; \
+ echo 's#@''CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g'; \
+ echo 's#@''CUSTOM_IALLOCATOR_SEARCH_PATH@#$(IALLOCATOR_SEARCH_PATH)#g'; \
+ echo 's#@''CUSTOM_EXPORT_DIR@#$(EXPORT_DIR)#g'; \
+ echo 's#@''RPL_FILE_STORAGE_DIR@#$(FILE_STORAGE_DIR)#g'; \
+ echo 's#@''RPL_SSH_INITD_SCRIPT@#$(SSH_INITD_SCRIPT)#g'; \
+ echo 's#@''PKGLIBDIR@#$(pkglibdir)#g'; \
+ echo 's#@''GNTMASTERUSER@#$(MASTERD_USER)#g'; \
+ echo 's#@''GNTRAPIUSER@#$(RAPI_USER)#g'; \
+ echo 's#@''GNTCONFDUSER@#$(CONFD_USER)#g'; \
+ echo 's#@''GNTNODEDUSER@#$(NODED_USER)#g'; \
+ echo 's#@''GNTRAPIGROUP@#$(RAPI_GROUP)#g'; \
+ echo 's#@''GNTADMINGROUP@#$(ADMIN_GROUP)#g'; \
+ echo 's#@''GNTCONFDGROUP@#$(CONFD_GROUP)#g'; \
+ echo 's#@''GNTMASTERDGROUP@#$(MASTERD_GROUP)#g'; \
+ echo 's#@''GNTDAEMONSGROUP@#$(DAEMONS_GROUP)#g'; \
+ echo 's#@''CUSTOM_ENABLE_CONFD@#$(ENABLE_CONFD)#g'; \
+ echo 's#@''MODULES@#$(strip $(lint_python_code))#g'; \
+ echo 's#@''XEN_CONFIG_DIR@#$(XEN_CONFIG_DIR)#g'; \
echo; \
echo '/^@SHELL_ENV_INIT@$$/ {'; \
echo ' r $(SHELL_ENV_INIT)'; \
daemons/ganeti-%: MODULE = ganeti.server.$(patsubst ganeti-%,%,$(notdir $@))
daemons/ganeti-watcher: MODULE = ganeti.watcher
scripts/%: MODULE = ganeti.client.$(subst -,_,$(notdir $@))
+tools/burnin: MODULE = ganeti.tools.burnin
tools/ensure-dirs: MODULE = ganeti.tools.ensure_dirs
tools/node-daemon-setup: MODULE = ganeti.tools.node_daemon_setup
tools/prepare-node-join: MODULE = ganeti.tools.prepare_node_join
.PHONY: hlint
hlint: $(HS_BUILT_SRCS) src/lint-hints.hs
@test -n "$(HLINT)" || { echo 'hlint' not found during configure; exit 1; }
+ @rm -f doc/hs-lint.html
if tty -s; then C="-c"; else C=""; fi; \
$(HLINT) --utf8 --report=doc/hs-lint.html --cross $$C \
--ignore "Use first" \
--ignore "Reduce duplication" \
--hint src/lint-hints \
$(filter-out $(HLINT_EXCLUDES),$(HS_LIBTEST_SRCS) $(HS_PROG_SRCS))
+ @if [ ! -f doc/hs-lint.html ]; then \
+ echo "All good" > doc/hs-lint.html; \
+ fi
# a dist hook rule for updating the vcs-version file; this is
# hardcoded due to where it needs to build the file...
echo "Found unreleased version in NEWS." >&2; \
exit 1; \
fi
+ if test -e $(top_distdir)/doc/man-html; then \
+ echo "Found documentation including man pages in final archive" >&2; \
+ exit 1; \
+ fi
# When building a release, stricter checks should be used
distcheck-release dist-release: export BUILD_RELEASE = 1
projects / ganeti-local / blobdiff