X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=README.md;h=e8038f636392afeb0fe4a01801baf99b35ad1e4d;hp=2cb75b1665cc2a3aebcd0f38bc0709d3412036c3;hb=0b1e16b80fae6103cce51a647cff0edb9786f5b6;hpb=99ad328584e02d6a0e90e0840e7c2820688c29ab diff --git a/README.md b/README.md index 2cb75b166..e8038f636 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ The following items are _optional_ dependencies: - **[Babeltrace](https://lttng.org/babeltrace)**: trace viewer. Enables the use of `lttng view` command. - Debian/Ubuntu package: `babeltrace` - - **[LTTng UST](https://lttng.org) (same version as LTTng Tools)**: userspace tracer. - Enables the tracing of userspace applications. + - **[LTTng UST](https://lttng.org) (same minor version as LTTng Tools)**: + userspace tracer. Enables the tracing of userspace applications. - Debian/Ubuntu package: `liblttng-ust-dev` - **Perl**: needed for `make check` and tests. - **Python >= 3.0**: needed for `make check` and tests. @@ -51,6 +51,16 @@ The following items are _optional_ dependencies: (kernel tracing). - **bash**: needed for running `make check`. +LTTng-tools supports both the [LTTng Linux Kernel tracer](https://lttng.org) +and [LTTng user space tracer](https://lttng.org) released as part of the same +**minor** release series. While some releases do not change the tracer ABIs and +should work with, no testing is performed to ensure cross-version compatibility +is maintained. + +Note that applications instrumented with older versions of the LTTng UST project +do not have to be rebuilt or modified to work with the latest LTTng-tools. +For more information on versioning, please refer to the +[LTTng documentation](https://lttng.org/docs). Building -------- @@ -59,7 +69,7 @@ This source tree is based on the Autotools suite from GNU to simplify portability. Here are some things you should have on your system in order to compile the Git repository tree: - - GNU Autotools (Automake >= 1.10, Autoconf >= 2.50, + - GNU Autotools (Automake >= 1.10, Autoconf >= 2.64, Autoheader >= 2.50; make sure your system-wide `automake` points to a recent version!) - [GNU Libtool](http://www.gnu.org/software/autoconf/) >= 2.2