barectf v3.1.0

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I3256dc44f7280489dc521e558828b61105691b55

diff --git a/README.adoc b/README.adoc
index 32999b48043421a5560ad5a4a69ddca9c204a2a7..c09468f06e39eb99bf884a04a494268445d2eda8 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -1,17 +1,19 @@
 // Render with Asciidoctor
 
+:version: 3.1
+
 ifndef::env-github[]
 :toc: left
 endif::env-github[]
 
 = barectf
-25 September 2020
+8 March 2022
 Philippe Proulx
 
 image::https://barectf.org/barectf-logo.svg[{nbsp}]
 
 https://pypi.python.org/pypi/barectf[image:https://img.shields.io/pypi/v/barectf.svg[]]
-https://ci.lttng.org/job/barectf_master_build[image:https://img.shields.io/jenkins/s/https/ci.lttng.org/barectf_master_build.svg[]]
+https://ci.lttng.org/job/barectf_stable-{version}_build[image:https://img.shields.io/jenkins/s/https/ci.lttng.org/barectf_stable-{version}_build.svg[]]
 
 [.lead]
 https://barectf.org/[**_barectf_**] (from _bare_ metal and _CTF_)
@@ -24,13 +26,13 @@ https://diamon.org/ctf/[CTF] data streams.
 This README mostly documents barectf development.
 
 To learn how to use barectf, read its
-https://barectf.org/docs/barectf/[documentation].
+https://barectf.org/docs/barectf/{version}/[documentation].
 ====
 
 == Install barectf
 
 See the barectf documentation's
-https://barectf.org/docs/barectf/3.0/install.html[Install barectf]
+https://barectf.org/docs/barectf/{version}/install.html[Install barectf]
 page.
 
 == Build barectf
@@ -52,14 +54,15 @@ The `dist` directory contains the distribution archives.
 == Build the barectf documentation
 
 This repository contains an
-https://docs.antora.org/antora/2.3/component-version/[Antora
+https://docs.antora.org/antora/latest/component-version/[Antora
 documentation component version] under the `docs` directory.
 
 This component version is the source of the
-https://barectf.org/docs/[barectf documentation website].
+https://barectf.org/docs/{version}/[barectf documentation website]
+(version{nbsp}{version}).
 
 You can refer to this component version in your
-https://docs.antora.org/antora/2.3/playbook/[Antora playbook file],
+https://docs.antora.org/antora/latest/playbook/[Antora playbook file],
 for example:
 
 [source,yaml]
@@ -69,7 +72,7 @@ site:
 content:
   sources:
     - url: https://github.com/efficios/barectf
-      branches: [stable-3.0]
+      branches: [stable-3.1]
       start_path: docs
     # ...
 ui:
@@ -104,5 +107,5 @@ $ tox
 == Get help
 
 See the barectf documentation's
-https://barectf.org/docs/barectf/3.0/get-help.html[Get help]
+https://barectf.org/docs/barectf/{version}/get-help.html[Get help]
 page.

diff --git a/barectf/version.py b/barectf/version.py
index e8911a09a8aec95de989f3a6a4495f9c1742e32e..b6ba0257f7cc6838e70b873bafbb12d78f95ce2f 100644 (file)
--- a/barectf/version.py
+++ b/barectf/version.py
@@ -24,5 +24,5 @@
 __major_version__ = 3
 __minor_version__ = 1
 __patch_version__ = 0
-__pre_version__ = '-dev'
+__pre_version__ = ''
 __version__ = f'{__major_version__}.{__minor_version__}.{__patch_version__}{__pre_version__}'

diff --git a/docs/modules/ROOT/pages/whats-new.adoc b/docs/modules/ROOT/pages/whats-new.adoc
index 2245e884039c0c34d9ef9af2c61f0c413547399f..41fe266dfec5ba63fd5b28ae9af8def201f91ff4 100644 (file)
--- a/docs/modules/ROOT/pages/whats-new.adoc
+++ b/docs/modules/ROOT/pages/whats-new.adoc
@@ -1,3 +1,32 @@
-= What's new in barectf{nbsp}3.1?
+= What's new in barectf{nbsp}{page-component-display-version}?
 
-TODO!
+Thanks to a https://review.lttng.org/c/barectf/+/7496[contribution from
+Jon Lamb], the xref:how-barectf-works:ctf-primer.adoc#pkt[CTF packets]
+which a barectf-generated tracer writes can contain an
+automatically-incremented **sequence number** in their context field.
+This is useful for a trace reader/analyzer to detect packets lost at
+transport time, for example. https://babeltrace.org/[Babeltrace{nbsp}2]
+supports such a packet context field out of the box.
+
+To enable this new packet feature, set the
+xref:yaml:dst-obj.adoc#seq-num-ft-prop[`sequence-number-field-type`
+property] of the packet features object, for example:
+
+.Data stream type object with an enabled packet sequence number field type feature.
+====
+[source,yaml]
+----
+$features:
+  packet:
+    sequence-number-field-type: true
+event-record-types:
+  # ...
+----
+====
+
+This feature is disabled (false) by default to avoid breaking changes.
+
+The xref:platform:api.adoc#close[packet closing function] automatically
+increments the current packet sequence number of the barectf context.
+Within platform code, you can get the current value with
+xref:platform:api.adoc#barectf-pkt-seq-num-func[`barectf_packet_sequence_number()`].

diff --git a/pyproject.toml b/pyproject.toml
index 202f88d2184adab7cef263317268b982d3809031..afa294fe875a0070da96cf6342f6207159558c67 100644 (file)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -27,7 +27,7 @@ build-backend = 'poetry.core.masonry.api'
 
 [tool.poetry]
 name = 'barectf'
-version = '3.1.0-dev'
+version = '3.1.0'
 description = 'Generator of ANSI C tracers which output CTF data streams'
 license = 'MIT'
 authors = ['Philippe Proulx <eeppeliteloop@gmail.com>']