README.md: add asciidoc and xmlto build dependencies

[lttng-tools.git] / README.md

diff --git a/README.md b/README.md
index 8c412cd41709fcbec447aeb351a3f3bf0e5bb51d..f5697e4ed12ce2301d8a7b12e25fa6676f2cc0d4 100644 (file)
--- 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
 --------
@@ -66,6 +76,13 @@ order to compile the Git repository tree:
   - Flex >= 2.5.35
   - Bison >= 2.4
 
+Optional packages to build LTTng-tools man pages:
+
+  - **AsciiDoc >= 8.4.5** (previous versions may work, but were
+    not tested)
+  - **xmlto >= 0.0.21** (previous versions may work, but were
+    not tested)
+
 If you use GNU gold, which is _not_ mandatory, make sure you have this
 version: