Add lttng-ctl SWIG python bindings

[lttng-tools.git] / README

diff --git a/README b/README
index 6c5da7959743fb708a14bde40e9fdf690957cad8..1898af98472ef7686006bb9bade0024702a5e810 100644 (file)
--- a/README
+++ b/README
@@ -28,6 +28,18 @@ REQUIREMENTS:
 
       * Debian/Ubuntu package: libpopt-dev
 
 
       * Debian/Ubuntu package: libpopt-dev
 

+    - SWIG >= 2.0 (optional)
+      Needed for Python bindings
+
+      * Debian/Ubuntu package: swig2.0
+
+    - python-dev (optional)
+      Python headers
+
+      * Debian/Ubuntu package: python-dev
+
+    - For kernel tracing: modprobe
+

 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify
 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify


@@ -41,6 +53,8 @@ compile the git repository tree :
 - GNU Gold >= 2.22
   (Before this version we hit a known bug documented at:
   http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
 - GNU Gold >= 2.22
   (Before this version we hit a known bug documented at:
   http://sourceware.org/bugzilla/show_bug.cgi?id=11317)

+- flex >= 2.5.35
+- bison >= 2.4

 
 If you get the tree from the repository, you will need to use the "bootstrap"
 script in the root of the tree. It calls all the GNU tools needed to prepare the
 
 If you get the tree from the repository, you will need to use the "bootstrap"
 script in the root of the tree. It calls all the GNU tools needed to prepare the


@@ -58,17 +72,25 @@ INSTALLATION INSTRUCTIONS:
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 

+  If you want Python bindings, run ./configure --enable-python-bindings.
+

 USAGE:
 
 Please see doc/quickstart.txt to help you start tracing. You can also use the
 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
 lttng enable-event -h).
 
 USAGE:
 
 Please see doc/quickstart.txt to help you start tracing. You can also use the
 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
 lttng enable-event -h).
 

+A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
+helps you understand how to stream a LTTng 2.0 trace.
+
+A Python HOWTO can be found in doc/python-howto.txt which quickly
+helps you understand how to use the Python module to control the LTTng API.
+

 PACKAGE CONTENTS:
 
     This package contains the following elements:
 
 PACKAGE CONTENTS:
 
     This package contains the following elements:
 

-    - liblttngctl
+    - liblttng-ctl

       The LTTng tracing control library.
 
     - libsessiond-comm (internal)
       The LTTng tracing control library.
 
     - libsessiond-comm (internal)


@@ -90,6 +112,18 @@ PACKAGE CONTENTS:
        - libhashtable (internal)
          Library wrapper over URCU hashtables.
 
        - libhashtable (internal)
          Library wrapper over URCU hashtables.
 

+       - libcommon (internal)
+         Contains multiple useful function call used by the whole tree.
+
+       - libcompat (internal)
+         Compatibility library mostly for FreeBSD and Linux.
+       
+       - librelayd (internal)
+         Library for all relayd interactions over the network.
+
+       - lttng-relayd
+         The relay daemon used for network streaming
+

     - lttng-consumerd
       The consumer daemon which uses libconsumer.
 
     - lttng-consumerd
       The consumer daemon which uses libconsumer.
 


@@ -107,3 +141,6 @@ PACKAGE CONTENTS:
 
        - doc
          Various documentations and quickstart guide.
 
        - doc
          Various documentations and quickstart guide.

+
+       - extras
+         Contains extra data such as bash completion file.