// Render with Asciidoctor
= Babeltrace
-15 October 2019
+13 April 2020
:btversion: 2.0
:bt2: Babeltrace{nbsp}2
https://scan.coverity.com/projects/babeltrace[image:https://img.shields.io/coverity/scan/babeltrace.svg[]]
The **_{bt2}_** project offers a library with a
-https://diamon.org/babeltrace/docs/v{btversion}/libbabeltrace2[C{nbsp}API],
-https://diamon.org/babeltrace/docs/v{btversion}/python/bt2[Python{nbsp}3 bindings],
+https://babeltrace.org/docs/v{btversion}/libbabeltrace2[C{nbsp}API],
+https://babeltrace.org/docs/v{btversion}/python/bt2[Python{nbsp}3 bindings],
and a
-https://diamon.org/babeltrace/docs/v{btversion}/man1/babeltrace2.1/[command-line tool]
+https://babeltrace.org/docs/v{btversion}/man1/babeltrace2.1/[command-line tool]
(CLI) which makes it very easy for mere mortals to view, convert,
transform, and analyze traces.
https://barectf.org/[barectf]. The {bt2} library and its Python bindings
can read and write CTF traces.
-See Babeltrace's https://diamon.org/babeltrace[official website], in
+See Babeltrace's https://babeltrace.org[official website], in
particular the
-https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-intro.7[`**babeltrace2-intro**(7)`]
+https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-intro.7[`**babeltrace2-intro**(7)`]
manual page, to learn more about the project.
[NOTE]
.Babeltrace{nbsp}1 vs. {bt2}
====
-The Babeltrace project exists since 2010. In 2019, {bt2} was
+The Babeltrace project exists since 2010. In 2020, {bt2} was
released. {bt2} is a complete rewrite of the library, Python
bindings, and CLI. It is plugin-based and offers much more features and
potential than Babeltrace{nbsp}1 while showing comparable performance.
Tools::
* https://www.gnu.org/software/make/[GNU Make]
* **If you build from a Git clone**:
- ** https://www.gnu.org/software/automake/[GNU Automake]{nbsp}≥{nbsp}1.10
+ ** https://www.gnu.org/software/automake/[GNU Automake]{nbsp}≥{nbsp}1.12
** https://www.gnu.org/software/autoconf/[GNU Autoconf]{nbsp}≥{nbsp}2.64
** https://www.gnu.org/software/libtool/[GNU Libtool]{nbsp}≥{nbsp}2.2
** https://github.com/westes/flex[flex]{nbsp}≥{nbsp}2.5.35
- ** https://www.gnu.org/software/bison/bison.html[GNU Bison]{nbsp}≥{nbsp}2.4
+ ** https://www.gnu.org/software/bison/bison.html[GNU Bison]{nbsp}≥{nbsp}2.5
Libraries::
* A C library (for example,
https://www.gnu.org/software/libc/[GNU{nbsp}C Library],
https://www.musl-libc.org/[musl libc])
- * https://developer.gnome.org/glib/[GLib]{nbsp}≥{nbsp}2.22
+ * https://developer.gnome.org/glib/[GLib]{nbsp}≥{nbsp}2.28
(Debian/Ubuntu: `libglib2.0-dev`; Fedora: `glib2-devel`)
_**If you need the `bt2` Python bindings**_::
(Debian/Ubuntu: `python3-dev`; Fedora: `python3-devel`)
* http://www.swig.org[SWIG]{nbsp}≥{nbsp}3.0
-_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::
+_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::
* https://sourceware.org/elfutils/[elfutils]{nbsp}≥{nbsp}0.154
(Debian/Ubuntu: `libelf-dev` and `libdw-dev`;
Fedora: `elfutils-devel` and `elfutils-libelf-devel`)
-_**If you need the `bt2` Python bindings documentation**_::
- * Python{nbsp}≥{nbsp}3.4
- (Debian/Ubuntu/Fedora: `python3`)
- * https://www.sphinx-doc.org/en/master/[Sphinx]{nbsp}≥{nbsp}1.6.5
- for Python{nbsp}3 (Debian/Ubuntu/Fedora: `python3-sphinx`)
-
_**If you need the {bt2}{nbsp}C{nbsp}API HTML documentation**_::
* http://www.doxygen.nl/[Doxygen]{nbsp}≥{nbsp}1.8.6
* https://www.methods.co.nz/asciidoc/[Asciidoc]{nbsp}≥{nbsp}8.6.8
* https://pagure.io/xmlto[xmlto]{nbsp}≥{nbsp}0.0.25
+_**If you need the `bt2` Python bindings documentation**_::
+ * https://www.sphinx-doc.org/[Sphinx]{nbsp}≥{nbsp}1.3 for
+ Python{nbsp}3
+ (Debian/Ubuntu/Fedora: `python3-sphinx`)
+
=== Procedure
`--enable-debug-info`::
Build the https://lttng.org/[LTTng] debug information filter
component class
- (https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`]).
+ (https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`]).
`--enable-man-pages`::
Build the {bt2} manual pages.
----
See the
-https://diamon.org/babeltrace/docs/v{btversion}/libbabeltrace2[{bt2}{nbsp}C{nbsp}API]
+https://babeltrace.org/docs/v{btversion}/libbabeltrace2[{bt2}{nbsp}C{nbsp}API]
documentation for more information.
== Use Babeltrace{nbsp}{btversion}
-See the https://diamon.org/babeltrace[Babeltrace website] to learn how
+See the https://babeltrace.org[Babeltrace website] to learn how
to use the different parts of the project.
* A C library (for example,
https://www.gnu.org/software/libc/[GNU{nbsp}C Library],
https://www.musl-libc.org/[musl libc])
- * https://developer.gnome.org/glib/[GLib]{nbsp}≥{nbsp}2.22
+ * https://developer.gnome.org/glib/[GLib]{nbsp}≥{nbsp}2.28
(Debian/Ubuntu: `libglib2.0-0`; Fedora: `glib2`)
_**If you need the `bt2` Python bindings**_::
* https://www.python.org[Python]{nbsp}≥{nbsp}3.4
(Debian/Ubuntu/Fedora: `python3`)
-_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://diamon.org/babeltrace/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::
+_**If you need the https://lttng.org/[LTTng] debug information filter component class (https://babeltrace.org/docs/v{btversion}/man7/babeltrace2-filter.lttng-utils.debug-info.7/[`filter.lttng-utils.debug-info`])**_::
* https://sourceware.org/elfutils/[elfutils]{nbsp}≥{nbsp}0.154
(Debian/Ubuntu: `libelf` and `libdw`; Fedora: `elfutils-libs` and
`elfutils-libelf`)
Babeltrace was born to parse CTF traces produced by LTTng{nbsp}2.0 and
pretty-print their events.
-Even though Babeltrace is independant from the LTTng project today,
+Even though Babeltrace is independent from the LTTng project today,
their communities remain very close, which is why they share some
communication channels and services.
====