This is to avoid confusion with the _new_ Babeltrace Python bindings
which are under the `bt2` package (not documented yet).
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
source_suffix = '.rst'
source_encoding = 'utf-8-sig'
master_doc = 'index'
source_suffix = '.rst'
source_encoding = 'utf-8-sig'
master_doc = 'index'
-project = 'Babeltrace Python bindings'
+project = 'Babeltrace legacy Python bindings'
copyright = '2017, EfficiOS Inc.'
version = babeltrace.__version__
release = version
copyright = '2017, EfficiOS Inc.'
version = babeltrace.__version__
release = version
********
This section presents a few short and straightforward examples
********
This section presents a few short and straightforward examples
-of Babeltrace Python bindings usage.
+of Babeltrace legacy Python bindings usage.
The examples are divided into two categories: those which demonstrate
the :ref:`reader API <reader-api>`, and those which demonstrate
The examples are divided into two categories: those which demonstrate
the :ref:`reader API <reader-api>`, and those which demonstrate
-####################################
-Babeltrace |version| Python bindings
-####################################
+###########################################
+Babeltrace |version| legacy Python bindings
+###########################################
========
Welcome to `Babeltrace <http://www.efficios.com/babeltrace>`_'s
========
Welcome to `Babeltrace <http://www.efficios.com/babeltrace>`_'s
-Python bindings' documentation!
+*legacy* Python bindings' documentation!
Babeltrace is a trace format converter. It is able to read and write
different trace formats, such as the
`Common Trace Format <http://www.efficios.com/ctf>`_ (CTF).
Babeltrace also acts as the CTF reference implementation.
Babeltrace is a trace format converter. It is able to read and write
different trace formats, such as the
`Common Trace Format <http://www.efficios.com/ctf>`_ (CTF).
Babeltrace also acts as the CTF reference implementation.
-The Babeltrace Python bindings rely on the ``libbabeltrace`` library,
-the current public C API of Babeltrace.
+The Babeltrace legacy Python bindings rely on the ``libbabeltrace``
+library, the public C API of Babeltrace.
-The Python bindings may be enabled when configuring Babeltrace's build::
+The bindings may be enabled when configuring Babeltrace's build::
./configure --enable-python-bindings
./configure --enable-python-bindings
-On Debian and Ubuntu, the Python bindings are available in the
+On Debian and Ubuntu, the bindings are available in the
``python3-babeltrace`` package.
.. note::
``python3-babeltrace`` package.
.. note::
- Currently, the Babeltrace Python bindings only works with Python 3.
+ Currently, the Babeltrace legacy Python bindings only works
+ with Python 3.
-The Babeltrace Python bindings are available as a single Python package,
-:py:mod:`babeltrace`.
+The Babeltrace legacy Python bindings are available as a single Python
+package, :py:mod:`babeltrace`.
-The Babeltrace Python bindings' API is divided into two parts:
+The Babeltrace legacy Python bindings' API is divided into two parts:
* The :ref:`reader API <reader-api>` is exposed by the
:mod:`babeltrace.reader` module, a set of classes used to
* The :ref:`reader API <reader-api>` is exposed by the
:mod:`babeltrace.reader` module, a set of classes used to
timestamps, contexts and payloads can be accomplished by using these
classes.
timestamps, contexts and payloads can be accomplished by using these
classes.
-The Babeltrace Python bindings' reader API exposes two categories of
-classes. The first category is used to open traces and iterate on
+The Babeltrace Python legacy bindings' reader API exposes two categories
+of classes. The first category is used to open traces and iterate on
theirs events. The typical procedure for reading traces is:
1. Create a :class:`TraceCollection` instance.
theirs events. The typical procedure for reading traces is:
1. Create a :class:`TraceCollection` instance.