README

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