X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=README.adoc;h=b9669d941302a26ce00cdbd1147095b699d5d57a;hp=24d85c1aca25b2313bb9b82b9876551d59803765;hb=HEAD;hpb=ae403e46640d0614bd6e7df6a04b19093c770124 diff --git a/README.adoc b/README.adoc index 24d85c1ac..676467aa4 100644 --- a/README.adoc +++ b/README.adoc @@ -16,7 +16,7 @@ endif::env-github[] 5 May 2020 [.normal] -https://ci.lttng.org/job/lttng-tools_master_build/[image:https://img.shields.io/jenkins/s/https/ci.lttng.org/lttng-tools_master_build.svg[Jenkins, title="Jenkins"]] +https://ci.lttng.org/job/lttng-tools_master_linuxbuild/[image:https://img.shields.io/jenkins/build.svg?jobUrl=https://ci.lttng.org/job/lttng-tools_master_linuxbuild/[Jenkins, title="Jenkins"]] https://scan.coverity.com/projects/lttng-tools[image:https://img.shields.io/coverity/scan/lttng-tools.svg[Coverity, title="Coverity"]] [.lead] @@ -52,13 +52,9 @@ endif::env-github[] You need the following dependencies to build and run the {lt} components: -* **Linux kernel{nbsp}≥{nbsp}2.6.27** -+ -Use `{nbh}{nbh}disable{nbh}epoll` at <> -time to build {lt} for an older kernel. However, note that we can't -provide any guarantee below 2.6.27. +* **Linux kernel{nbsp}≥{nbsp}2.6.30** -* **http://www.liburcu.org/[Userspace{nbsp}RCU]{nbsp}≥{nbsp}0.9.0**. +* **http://www.liburcu.org/[Userspace{nbsp}RCU]{nbsp}≥{nbsp}0.14.0**. + Debian/Ubuntu package: `liburcu{nbh}dev`. @@ -73,18 +69,17 @@ Debian/Ubuntu package: `libxml2{nbh}dev` The following dependencies are optional: * **https://babeltrace.org/[Babeltrace{nbsp}2]**: default viewer - of the https://lttng.org/man/1/lttng-view/[`lttng view`] command. + of the https://lttng.org/man/1/lttng-view/[`lttng view`] command, + `make{nbsp}check` and tests. + -Debian/Ubuntu package: `babeltrace2` +Debian/Ubuntu package: `babeltrace2 libbabeltrace2-dev` * **https://lttng.org/[LTTng{nbh}UST]** (same minor version as {lt}): LTTng user space tracing (applications and libraries). + Debian/Ubuntu package: `liblttng{nbh}ust{nbh}dev` -* **Perl**: `make{nbsp}check` and tests. - -* **https://www.python.org/[Python]{nbsp}≥{nbsp}3.0**: +* **https://www.python.org/[Python]{nbsp}≥{nbsp}3.4**: `make{nbsp}check` and tests. + Debian/Ubuntu package: `python3` @@ -136,7 +131,7 @@ information on versioning. You need the following tools to build {lt}: * **https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html[GNU{nbsp}Autotools]** - (**Automake{nbsp}≥{nbsp}1.10**, + (**Automake{nbsp}≥{nbsp}1.12**, **Autoconf{nbsp}≥{nbsp}2.64**, and **Autoheader{nbsp}≥{nbsp}2.50**) * **http://www.gnu.org/software/autoconf/[GNU{nbsp}Libtool]{nbsp}≥{nbsp}2.2** @@ -147,7 +142,7 @@ You need the following tools to build {lt}: To build the {lt} manual pages: -* **https://www.methods.co.nz/asciidoc/[AsciiDoc]{nbsp}≥{nbsp}8.4.5** +* **https://asciidoc.org/[AsciiDoc]{nbsp}≥{nbsp}8.4.5** + NOTE: Previous versions could work, but were not tested. @@ -192,9 +187,6 @@ If you want to embed the manual pages into the `lttng`, so that you don't need `man` to view them, use the `{nbh}{nbh}enable{nbh}embedded{nbh}help` option. -If your Linux kernel is older than 2.6.27, use the -`{nbh}{nbh}disable{nbh}epoll` option. - This build configuration script finds LTTng{nbh}UST with https://www.freedesktop.org/wiki/Software/pkg-config/[pkg{nbh}config]: set the `PKG_CONFIG_PATH` environment variable accordingly if @@ -229,6 +221,21 @@ As there's no official {lib} Python bindings yet, see link:doc/python-howto.txt[`doc/python-howto.txt`] to understand how to use them. +== Supported versions + +The LTTng project supports the last two released stable versions +(e.g. stable-2.13 and stable-2.12). + +Fixes are backported from the master branch to the last stable version unless +those fixes would break the ABI or API. Those fixes may be backported to the +second-last stable version, depending on complexity and ABI/API compatibility. + +Security fixes are backported from the master branch to both of the last stable +version and the second-last stable version. + +New features are integrated into the master branch and not backported to the +last stable branch. + == Community Mailing list:: @@ -251,3 +258,6 @@ Continuous integration:: Code review:: https://review.lttng.org/q/project:lttng-tools[_lttng{nbh}tools_ project] on LTTng Review + +Contributor's guide:: + https://github.com/lttng/lttng-tools/blob/master/CONTRIBUTING.md \ No newline at end of file