-dnl Process this file with autoconf to produce a configure script.
-dnl
-dnl Copyright (c) 2017 EfficiOS, Inc.
+dnl SPDX-License-Identifier: MIT
dnl
-dnl Permission is hereby granted, free of charge, to any person obtaining a copy
-dnl of this software and associated documentation files (the "Software"), to deal
-dnl in the Software without restriction, including without limitation the rights
-dnl to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-dnl copies of the Software, and to permit persons to whom the Software is
-dnl furnished to do so, subject to the following conditions:
+dnl Copyright (C) 2017 EfficiOS, Inc.
dnl
-dnl The above copyright notice and this permission notice shall be included in
-dnl all copies or substantial portions of the Software.
-dnl
-dnl THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-dnl IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-dnl FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-dnl AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-dnl LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-dnl OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-dnl SOFTWARE.
+dnl Process this file with autoconf to produce a configure script.
## ##
## Autoconf base setup ##
AS_IF([test "x$BABELTRACE_DEV_MODE" = x1], [
AC_DEFINE([BT_DEV_MODE], 1, [Babeltrace developer mode])
], [BABELTRACE_DEV_MODE=0])
+AM_CONDITIONAL([DEV_MODE], [test "x$BABELTRACE_DEV_MODE" = x1])
# BABELTRACE_DEBUG_MODE:
AC_ARG_VAR([BABELTRACE_DEBUG_MODE], [Set to 1 to enable the Babeltrace debug mode (enables internal assertions for Babeltrace maintainers)])
AC_ARG_ENABLE([python-bindings],
[AC_HELP_STRING([--enable-python-bindings], [build the Python bindings])],
[], dnl AC_ARG_ENABLE will fill enable_python_bindings with the user choice
- [enable_python_bindings=no]
+ [enable_python_bindings=unspecified]
+)
+
+# Python bindings documentation
+# Disabled by default
+AC_ARG_ENABLE([python-bindings-doc],
+ [AC_HELP_STRING([--enable-python-bindings-doc], [build the Python bindings documentation])],
+ [], dnl AC_ARG_ENABLE will fill enable_python_bindings_doc with the user choice
+ [enable_python_bindings_doc=no]
)
# Python plugins
# Disabled by default
AC_ARG_ENABLE([python-plugins],
- [AC_HELP_STRING([--enable-python-plugins], [enable the Python plugins support for the library and converter])],
- [], dnl AC_ARG_ENABLE will fill enable_python_plugins with the user choice
- [enable_python_plugins=no]
+ [AC_HELP_STRING([--enable-python-plugins], [enable the Python plugins support for the library and converter])]
+ dnl AC_ARG_ENABLE will fill enable_python_plugins with the user choice
)
# Debug info
# Disabled by default
AC_ARG_ENABLE([api-doc],
[AC_HELP_STRING([--enable-api-doc], [build the HTML API documentation])],
- [enable_api_doc=$enableval],
- [enable_api_doc=no]
+ [enable_api_doc=$enableval]
)
# Built-in plugins
# Disabled by default
AC_ARG_ENABLE([built-in-plugins],
- [AC_HELP_STRING([--enable-built-in-plugins], [Statically-link in-tree plug-ins into the babeltrace2 executable])],
- [], dnl AC_ARG_ENABLE will fill enable_built_in_plugins with the user choice
- [enable_built_in_plugins=no]
+ [AC_HELP_STRING([--enable-built-in-plugins], [Statically-link in-tree plug-ins into the babeltrace2 executable])]
+ dnl AC_ARG_ENABLE will fill enable_built_in_plugins with the user choice
)
# Built-in python plugin support
# Disabled by default
AC_ARG_ENABLE([built-in-python-plugin-support],
- [AC_HELP_STRING([--enable-built-in-python-plugin-support], [Statically-link Python plugin support into the babeltrace library])],
- [], dnl AC_ARG_ENABLE will fill enable_built_in_python_plugin_support with the user choice
- [enable_built_in_python_plugin_support=no]
+ [AC_HELP_STRING([--enable-built-in-python-plugin-support], [Statically-link Python plugin support into the babeltrace library])]
+ dnl AC_ARG_ENABLE will fill enable_built_in_python_plugin_support with the user choice
)
# Man pages
# Enabled by default
AC_ARG_ENABLE([man-pages],
[AS_HELP_STRING([--disable-man-pages], [Do not build and install man pages (already built in a distributed tarball])],
- [], dnl AC_ARG_ENABLE will fill enable_built_in_plugins with the user choice
+ [], dnl AC_ARG_ENABLE will fill enable_man_pages with the user choice
[enable_man_pages=yes]
)
# Set automake variables for optionnal feature conditionnals in Makefile.am
AM_CONDITIONAL([ENABLE_PYTHON_BINDINGS], [test "x$enable_python_bindings" = xyes])
+AM_CONDITIONAL([ENABLE_PYTHON_BINDINGS_DOC], [test "x$enable_python_bindings_doc" = xyes])
AM_CONDITIONAL([ENABLE_PYTHON_PLUGINS], [test "x$enable_python_plugins" = xyes])
AM_CONDITIONAL([ENABLE_DEBUG_INFO], [test "x$enable_debug_info" = xyes])
AM_CONDITIONAL([ENABLE_API_DOC], [test "x$enable_api_doc" = xyes])
AC_SUBST([ENABLE_DEBUG_INFO_VAL])
+# Check for conflicting Python related features user choices.
+AS_IF([test "x$enable_python_plugins" = xyes],
+ [
+ AS_IF([test "x$enable_python_bindings" = xunspecified],
+ [
+ # --enable-python-plugins was provided but --enable-python-bindings was
+ # omitted. Turn the Python bindings ON anyway because it's needed to
+ # use the Python plugins.
+ enable_python_bindings=yes
+ ],
+ [
+ AS_IF([test "x$enable_python_bindings" = xno],
+ [
+ # --enable-python-plugins _and_ --disable-python-bindings were
+ # used. This is invalid because Python plugins need the Python
+ # bindings to be useful.
+ AC_MSG_ERROR(--enable-python-bindings must be used to support Python plugins)
+ ]
+ )
+ ]
+ )
+ ]
+)
# Check for conflicting optional features user choices
AS_IF([test "x$enable_built_in_python_plugin_support" = xyes],
[
- AS_IF([test "x$enable_python_plugins" = xno], [AC_MSG_ERROR([--enable-python-plugins must be used to bundle Python plugin support in the babeltrace2 executable])])
+ AS_IF([test "x$enable_python_plugins" != xyes], [AC_MSG_ERROR([--enable-python-plugins must be used to bundle Python plugin support in the babeltrace2 executable])])
# Built-in plug-ins are only available when the --disable-shared --enable-static options are used.
AS_IF([test "x$enable_static" != xyes], [AC_MSG_ERROR(--enable-static must be used to bundle Python plugin support in the babeltrace2 executable)])
AS_IF([test "x$enable_shared" = xyes], [AC_MSG_ERROR(--disable-shared must be used to bundle Python plugin support in the babeltrace2 executable)])
])
])
+AS_IF([test "x$enable_python_bindings_doc" = xyes],
+ [
+ AM_CHECK_PYTHON_SPHINX([PYTHON])
+ AS_IF([test "x$PYTHON_SPHINX_EXISTS" = xno], [
+ AC_MSG_ERROR([The Sphinx package for Python 3 is required to build the Python bindings documentation])
+ ])
+
+ AS_IF([test "x$enable_python_bindings" != xyes], [
+ AC_MSG_ERROR([The Python bindings are required to build their documentation])
+ ])
+ ]
+)
+
AS_IF([test "x$enable_debug_info" = xyes],
[
# Check if libelf and libdw are present
CFLAGS=${save_CFLAGS}
# Detect C and LD warning flags supported by the compiler.
-AX_COMPILER_FLAGS(
- [WARN_CFLAGS], dnl CFLAGS variable name
- [WARN_LDFLAGS], dnl LDFLAGS variable name (unused for now)
- [], dnl is-release
- [], dnl Extra base CFLAGS
- [ dnl Extra "yes" CFLAGS
- dnl Disable these flags, either because we don't want them
- dnl or because we want them but are not ready to enable them
- dnl yet.
+
+# Detect warning flags supported by the compiler, append them to WARN_CFLAGS.
+#
+# Pass -Werror as an extra flag during the test: this is needed to make the
+# -Wunknown-warning-option diagnostic fatal with clang.
+AX_APPEND_COMPILE_FLAGS([ dnl
+ -Wall dnl
+ -Wextra dnl
+ -Wstrict-prototypes dnl
+ -Wmissing-prototypes dnl
+ -Wmissing-declarations dnl
+ -Wnull-dereference dnl
+ -Wundef dnl
+ -Wredundant-decls dnl
+ -Wshadow dnl
+ -Wjump-misses-init dnl
+ -Wsuggest-attribute=format dnl
+ -Wtautological-constant-out-of-range-compare dnl
+ -Wnested-externs dnl
+ -Wwrite-strings dnl
+ -Wformat=2 dnl
+ -Wstrict-aliasing dnl
+ -Wmissing-noreturn dnl
+ -Winit-self dnl
+ -Wduplicated-cond dnl
+ -Wduplicated-branches dnl
+ -Wlogical-op dnl
+ -Wno-unused-parameter dnl
-Wno-sign-compare dnl
- -Wno-inline dnl
- -Wno-declaration-after-statement dnl
- -Wno-switch-enum dnl
- -Wno-switch-default dnl
- -Wno-packed dnl
- -Wno-pointer-arith dnl
- -Wno-format-nonliteral dnl
- -Wno-double-promotion dnl
- -Wno-cast-align dnl
dnl
dnl Some versions of SWIG (like 3.0.12) generate code that produces
dnl -Wcast-function-type warnings. This warning is present in gcc >= 8. This
dnl
dnl Ref: https://github.com/swig/swig/issues/1259
-Wno-cast-function-type dnl
- ])
-
-# CFLAGS from AX_COMPILER_FLAGS.
-AM_CFLAGS="${AM_CFLAGS} ${WARN_CFLAGS}"
+ -Wno-missing-field-initializers dnl
+ ],
+ [WARN_CFLAGS],
+ [-Werror])
+
+# When given, add -Werror to WARN_CFLAGS.
+AC_ARG_ENABLE([Werror],
+ [AS_HELP_STRING([--enable-Werror], [Treat compiler warnings as errors.])]
+)
+AS_IF([test "x$enable_Werror" = "xyes"],
+ [WARN_CFLAGS="${WARN_CFLAGS} -Werror"]
+)
-# The test used in AX_COMPILER_FLAGS, generated using AC_LANG_PROGRAM, is
+# The test used in AX_APPEND_COMPILE_FLAGS, generated using AC_LANG_PROGRAM, is
# written in such a way that it triggers a -Wold-style-definition warning. So
-# if the user has -Werror in their CFLAGS, that warning flag will end up
-# disabled, because the test program will not build.
+# this warning always ends up disabled if we put it there, because the test
+# program does not build.
#
# Enable it here unconditionally. It is supported by GCC >= 4.8 and by Clang
# (it is accepted for compatibility although it has no effect), and there is
# not reason to not want it.
-AM_CFLAGS="${AM_CFLAGS} -Wold-style-definition"
+WARN_CFLAGS="${WARN_CFLAGS} -Wold-style-definition"
-# We want this one to always be an error.
-AM_CFLAGS="${AM_CFLAGS} -Werror=implicit-function-declaration"
+# CFLAGS from AX_APPEND_COMPILE_FLAGS.
+AM_CFLAGS="${AM_CFLAGS} ${WARN_CFLAGS}"
# Done for AM_CFLAGS.
AC_SUBST(AM_CFLAGS)
doc/api/Makefile
doc/api/libbabeltrace2/Doxyfile
doc/api/libbabeltrace2/Makefile
+ doc/bindings/Makefile
+ doc/bindings/python/Makefile
doc/contributing-images/Makefile
doc/Makefile
doc/man/asciidoc-attrs.conf
tests/ctf-writer/Makefile
tests/lib/Makefile
tests/lib/test-plugin-plugins/Makefile
+ tests/lib/conds/Makefile
tests/Makefile
tests/param-validation/Makefile
tests/plugins/Makefile
test "x$have_python_dev" = "xyes" && value=1 || value=0
PPRINT_PROP_BOOL([Have Python development libraries], $value)
test "x$enable_python_bindings" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL([Python bindings], $value)
+PPRINT_PROP_BOOL_CUSTOM([Python bindings], $value, [To enable, use --enable-python-bindings])
test "x$enable_python_plugins" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL([Python plugin support], $value)
+PPRINT_PROP_BOOL_CUSTOM([Python plugin support], $value, [To enable, use --enable-python-plugins])
AS_IF([test "x$have_python" = "xyes"], [
PPRINT_PROP_STRING([Python interpreter path], [$PYTHON])
])
PPRINT_SUBTITLE([Plugins])
PPRINT_PROP_BOOL(['ctf' plugin], 1)
test "x$enable_debug_info" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL(['lttng-utils' plugin], $value)
+PPRINT_PROP_BOOL_CUSTOM(['lttng-utils' plugin], $value, [To enable, use --enable-debug-info])
PPRINT_PROP_BOOL(['text' plugin], 1)
PPRINT_PROP_BOOL(['utils' plugin], 1)
AS_ECHO
PPRINT_SUBTITLE([Built-in features])
test "x$enable_built_in_plugins" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL([Built-in plugins], $value)
+PPRINT_PROP_BOOL_CUSTOM([Built-in plugins], $value, [To enable, use --enable-built-in-plugins])
test "x$enable_built_in_python_plugin_support" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL([Built-in Python plugin support], $value)
+PPRINT_PROP_BOOL_CUSTOM([Built-in Python plugin support], $value, [To enable, use --enable-built-in-python-plugin-support])
AS_ECHO
PPRINT_SUBTITLE([Documentation])
])
])
], [
- PPRINT_PROP_BOOL([build_man_pages_msg], 0)
+ PPRINT_PROP_BOOL_CUSTOM([build_man_pages_msg], 0, [To build man pages, use --enable-man-pages])
])
m4_popdef([build_man_pages_msg])
test "x$enable_api_doc" = "xyes" && value=1 || value=0
-PPRINT_PROP_BOOL([HTML API documentation], $value)
+PPRINT_PROP_BOOL_CUSTOM([HTML API documentation], $value, [To build documentation, use --enable-api-doc])
+test "x$enable_python_bindings_doc" = "xyes" && value=1 || value=0
+PPRINT_PROP_BOOL_CUSTOM([Python bindings documentation], $value, [To build the Python bindings documentation, use --enable-python-bindings-doc])
AS_ECHO
PPRINT_SUBTITLE([Logging])
AS_ECHO
PPRINT_SUBTITLE([Special build modes])
-PPRINT_PROP_BOOL([Debug mode], $BABELTRACE_DEBUG_MODE)
-PPRINT_PROP_BOOL([Developer mode], $BABELTRACE_DEV_MODE)
+PPRINT_PROP_BOOL_CUSTOM([Debug mode], $BABELTRACE_DEBUG_MODE, [To enable, set the BABELTRACE_DEBUG_MODE environment variable to 1])
+PPRINT_PROP_BOOL_CUSTOM([Developer mode], $BABELTRACE_DEV_MODE, [To enable, set the BABELTRACE_DEV_MODE environment variable to 1])
report_bindir="`eval eval echo $bindir`"
report_libdir="`eval eval echo $libdir`"