Update readme to document opt dep on numa

[lttng-ust.git] / README.md

diff --git a/README.md b/README.md
index 84728dbbe21ba94e99f8debf569608158ffc9e11..ff491701485271c069e691cf4967ba5fc296e2d6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ Prerequisites
 -------------
 
 LTTng-UST depends on [liburcu](http://liburcu.org/) v0.7.2 at build and
-run times.
+run times. It also optionally depends on libnuma.
 
 
 Building
@@ -24,14 +24,16 @@ 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, Autoheader >= 2.50;
+  - [GNU Autotools](http://www.gnu.org/software/autoconf/)
+    (**Automake >= 1.10**, **Autoconf >= 2.50**,
+    **Autoheader >= 2.50**;
     make sure your system-wide `automake` points to a recent version!)
-  - [GNU Libtool](http://www.gnu.org/software/autoconf/) >= 2.2
+  - **[GNU Libtool](https://www.gnu.org/software/libtool/) >= 2.2**
 
 
 ### Optional dependencies
 
-Optional packages to build LTTng-tools man pages:
+Optional packages to build LTTng-ust man pages:
 
   - **[AsciiDoc](http://www.methods.co.nz/asciidoc/) >= 8.4.5**
     (previous versions may work, but were not tested)
@@ -223,15 +225,21 @@ This package contains the following elements:
     It _has_ to be preloaded in order to hijack calls. In contrast,
     `liblttng-ust` may be linked at build time.
   - `liblttng-ust-java`: a simple library that uses JNI to allow tracing
-    in Java programs.
-  - `liblttng-ust-jul`: a package that includes a JNI library and a JAR
-    library to provide an LTTng-UST logging back-end for Java application
-    using Java Util Logging.
+    in Java programs. (Configure with `--enable-jni-interface`).
+  - `liblttng-ust-java-agent`: a package that includes a JNI library and a
+    JAR library to provide an LTTng-UST logging back-end for Java
+    applications using Java Util Logging or Log4j. (Configure with
+    `--enable-java-agent-jul` or `--enable-java-agent-log4j` or
+    `--enable-java-agent-all`).
   - `liblttng-ust-libc-wrapper`: an example library that can be
     preloaded to instrument some calls to libc (currently `malloc()` and
     `free()`) and to POSIX threads (mutexes currently instrumented) in
     any program without need to recompile it.
+  - `liblttng-ust-python-agent`: a library used by python-lttngust to allow
+    tracing in Python applications. (Configure with `--enable-python-agent`)
   - `libringbuffer`: the ring buffer implementation used within LTTng-UST.
+  - `python-lttngust`: a package to provide an LTTng-UST logging back-end
+    for Python applications using the standard logging framework.
   - `snprintf`: an asynchronous signal-safe version of `snprintf()`.
   - `tests`: various test programs.
   - `tools`: home of `lttng-gen-tp`.