X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=doc%2Fbindings%2Fpython%2Fsource%2Findex.rst;fp=doc%2Fbindings%2Fpython%2Fsource%2Findex.rst;h=fc02e8d18fbd137d803e86119339e890cfdb5724;hb=4e5f388fcb9d27babc2e2a5bff5c904127a040cf;hp=99d0f79a79725cc6ba662b01d6c1e74b08bbfbd0;hpb=d6681ce0d1108ffcabdf9aa05ae771857f799da2;p=babeltrace.git diff --git a/doc/bindings/python/source/index.rst b/doc/bindings/python/source/index.rst index 99d0f79a..fc02e8d1 100644 --- a/doc/bindings/python/source/index.rst +++ b/doc/bindings/python/source/index.rst @@ -1,6 +1,6 @@ -#################################### -Babeltrace |version| Python bindings -#################################### +########################################### +Babeltrace |version| legacy Python bindings +########################################### Generated on |today|. @@ -9,39 +9,40 @@ Welcome! ======== Welcome to `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 `_ (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. Installing ========== -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 -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:: - Currently, the Babeltrace Python bindings only works with Python 3. + Currently, the Babeltrace legacy Python bindings only works + with Python 3. Bindings ======== -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 ` is exposed by the :mod:`babeltrace.reader` module, a set of classes used to