From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 18 Sep 2017 20:29:27 +0000 (-0400)
Subject: Doc: babeltrace: mention _legacy_ Python bindings
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=4e5f388fcb9d27babc2e2a5bff5c904127a040cf

Doc: babeltrace: mention _legacy_ Python bindings

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>
---

diff --git a/doc/bindings/python/source/conf.py b/doc/bindings/python/source/conf.py
index 32e1cdf7..9e52c569 100644
--- a/doc/bindings/python/source/conf.py
+++ b/doc/bindings/python/source/conf.py
@@ -14,7 +14,7 @@ templates_path = ['_templates']
 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
diff --git a/doc/bindings/python/source/examples.rst b/doc/bindings/python/source/examples.rst
index 35972316..31757476 100644
--- a/doc/bindings/python/source/examples.rst
+++ b/doc/bindings/python/source/examples.rst
@@ -5,7 +5,7 @@ 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
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 <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.
 
-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 <reader-api>` is exposed by the
   :mod:`babeltrace.reader` module, a set of classes used to
diff --git a/doc/bindings/python/source/reader.rst b/doc/bindings/python/source/reader.rst
index fd98f1d7..93cdaada 100644
--- a/doc/bindings/python/source/reader.rst
+++ b/doc/bindings/python/source/reader.rst
@@ -12,8 +12,8 @@ collection, iterating on their events, reading event names,
 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.