docs: Add supported versions and fix-backport policy

[lttng-tools.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 830dd933e850ac1505c80347a1ffdd66d42dad51..676467aa4cfbe09499994f8232865c24c33666d0 100644 (file)
--- 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]
@@ -54,7 +54,7 @@ components:
 
 * **Linux kernel{nbsp}≥{nbsp}2.6.30**
 
-* **http://www.liburcu.org/[Userspace{nbsp}RCU]{nbsp}≥{nbsp}0.11.0**.
+* **http://www.liburcu.org/[Userspace{nbsp}RCU]{nbsp}≥{nbsp}0.14.0**.
 +
 Debian/Ubuntu package: `liburcu{nbh}dev`.
 
@@ -72,16 +72,14 @@ The following dependencies are optional:
   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`
@@ -133,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**
@@ -144,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.
 
@@ -223,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::
@@ -245,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