From: Jérémie Galarneau Date: Thu, 18 Feb 2016 17:23:44 +0000 (-0500) Subject: Docs: clarify cross-version tracer compatibility X-Git-Tag: v2.8.0-rc1~155 X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=4c780623524ec3bb612279a687f1eb6edafa49fe;p=lttng-tools.git Docs: clarify cross-version tracer compatibility Signed-off-by: Jérémie Galarneau --- diff --git a/README.md b/README.md index 8c412cd41..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 --------