README

   1 BabelTrace - Trace Format Babel Tower
   2
   3 This project provides trace read and write libraries, as well as a trace
   4 converter. A plugin can be created for any trace format to allow its conversion
   5 to/from another trace format.
   6
   7 The main format expected to be converted to/from is the Common Trace
   8 Format (CTF). The latest version of the CTF specification can be found at:
   9
  10   git tree:   git://git.efficios.com/ctf.git
  11   gitweb:     http://git.efficios.com/?p=ctf.git
  12
  13 The CE Workgroup of the Linux Foundation, Ericsson, and EfficiOS have
  14 sponsored this work.
  15
  16 The current maintainers are:
  17   Jérémie Galarneau <jeremie.galarneau@efficios.com>
  18   Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  19
  20 Questions should be addressed to this mailing list:
  21   lttng-dev@lists.lttng.org
  22
  23
  24 BUILDING
  25 --------
  26
  27         ./bootstrap (skip if using tarball)
  28         ./configure
  29         make
  30         make install
  31         ldconfig
  32
  33
  34 DEPENDENCIES
  35 ------------
  36
  37 To compile Babeltrace, you will need:
  38
  39         gcc 3.2 or better
  40         libc6 development librairies
  41           (Debian : libc6, libc6-dev)
  42           (Fedora : glibc, glibc)
  43         glib 2.22 or better development libraries
  44           (Debian : libglib2.0-0, libglib2.0-dev)
  45           (Fedora : glib2, glib2-devel)
  46         uuid development libraries
  47           (Debian : uuid-dev)
  48           (Fedora : uuid-devel)
  49         libpopt >= 1.13 development libraries
  50           (Debian : libpopt-dev)
  51           (Fedora : popt)
  52         elfutils >= 0.154 development libraries (optional)
  53           (Debian : libelf-dev, libdw-dev)
  54           (Fedora : elfutils-devel, elfutils-libelf-devel)
  55         python headers (optional)
  56           (Debian/Ubuntu : python3-dev)
  57         swig >= 2.0 (optional)
  58           (Debian/Ubuntu : swig2.0)
  59         python >= 3.0 (optional)
  60           (Debian/Ubuntu : python3)
  61         sphinx >= 1.2 (optional)
  62           (Debian/Ubuntu : python3-sphinx)
  63
  64   If you want Python bindings, run ./configure --enable-python-bindings.
  65   Please note that some distributions will need the following
  66   environment variables set before running configure:
  67
  68     export PYTHON="python3"
  69     export PYTHON_CONFIG="/usr/bin/python3-config"
  70
  71 For developers using the git tree:
  72
  73 This source tree is based on the autotools suite from GNU to simplify
  74 portability. Here are some things you should have on your system in order to
  75 compile the git repository tree :
  76
  77 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
  78   (make sure your system wide "automake" points to a recent version!)
  79 - GNU Libtool >=2.2
  80   (for more information, go to http://www.gnu.org/software/autoconf/)
  81 - Flex >=2.5.35.
  82 - Bison >=2.4.
  83
  84 If you get the tree from the repository, you will need to use the "bootstrap"
  85 script in the root of the tree. It calls all the GNU tools needed to prepare the
  86 tree configuration.
  87
  88 Running "make check": bash is required.