Add exclusion data to trace_ust_create_event

[lttng-tools.git] / README

diff --git a/README b/README
index 9aab80f1c4df570eec600a8ed5b3e48949ed3183..e38602d53703a05fbe46343918ff92203c7e62c9 100644 (file)
--- a/README
+++ b/README
@@ -1,27 +1,30 @@
 LTTng Trace Control
 ----------------
 
-Please visit http://lttng.org for more information.
+Please visit https://lttng.org for more information. The current maintainer is
+David Goulet <dgoulet@efficios.com>.
 
 Latest development can be found at:
 
-    * Gitweb :  http://git.lttng.org/lttng-tools.git/
+    * Gitweb :  https://git.lttng.org/?p=lttng-tools.git;a=summary
     * Git :     git://git.lttng.org/lttng-tools.git
 
 REQUIREMENTS:
 
        - Linux kernel >= 2.6.27
-         pipe2(), epoll_create1() and SOCK_CLOEXEC are needed to run the session
-         daemon. There were introduce in the Linux 2.6.27
+         For epoll() support, at least this version is needed. However, poll() is
+         also supported by running "./configure --disable-epoll". Using that, the
+         kernel version can probably be older but we can't provide any guarantee.
+         Please let us know if you are able to go lower without any problems.
 
     - liburcu
       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-      -> Tested with liburcu >= v0.7.2
+      -> Tested with liburcu 0.7.x stable.
 
       * Debian/Ubuntu package: liburcu-dev
       * Git : git://git.lttng.org/userspace-rcu.git
-      * Website:  http://lttng.org/urcu
+      * Website:  https://lttng.org/urcu
 
     - libpopt >= 1.13
       Library for parsing command line parameters
@@ -44,7 +47,7 @@ REQUIREMENTS:
     - python-dev (optional)
       Python headers
 
-      * Debian/Ubuntu package: python-dev
+      * Debian/Ubuntu package: python3-dev
 
     - For kernel tracing: modprobe
 
@@ -60,7 +63,7 @@ compile the git repository tree :
 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
   (make sure your system wide "automake" points to a recent version!)
 - GNU Libtool >=2.2
-  (for more information, go to http://www.gnu.org/software/autoconf/)
+  (for more information, go to https://www.gnu.org/software/autoconf/)
 - flex >= 2.5.35
 - bison >= 2.4
 
@@ -89,6 +92,11 @@ INSTALLATION INSTRUCTIONS:
   the configure script, to generate it.
 
   If you want Python bindings, run ./configure --enable-python-bindings.
+  Please note that some distributions will need the following
+  environment variables set before running configure:
+
+    export PYTHON="python3"
+    export PYTHON_CONFIG="/usr/bin/python3-config"
 
 USAGE:
 
@@ -106,7 +114,7 @@ PACKAGE CONTENTS:
 
     This package contains the following elements:
 
-    - liblttng-ctl
+    - liblttng-ctl (public API)
       The LTTng tracing control library.
 
     - libsessiond-comm (internal)
@@ -149,7 +157,7 @@ PACKAGE CONTENTS:
     - lttng
       The LTTng tracer command line control tool.
 
-    - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
+    - include (installed in $(includedir)/lttng/)
       The liblttngctl API header file.
 
     - tests
@@ -159,4 +167,5 @@ PACKAGE CONTENTS:
          Various documentations and quickstart guide.
 
        - extras
-         Contains extra data such as bash completion file.
+         Contains extra data such as bash completion file. Python bindings for
+         liblttng-ctl are also available there.