// Render with Asciidoctor
-:version: 3.1
-
ifndef::env-github[]
:toc: left
endif::env-github[]
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_stable-{version}_build[image:https://img.shields.io/jenkins/s/https/ci.lttng.org/barectf_stable-{version}_build.svg[]]
+https://ci.lttng.org/job/barectf_master_linuxbuild[image:https://img.shields.io/jenkins/s/https/ci.lttng.org/barectf_master_linuxbuild.svg[]]
[.lead]
https://barectf.org/[**_barectf_**] (from _bare_ metal and _CTF_)
This README mostly documents barectf development.
To learn how to use barectf, read its
-https://barectf.org/docs/barectf/{version}/[documentation].
+https://barectf.org/docs/barectf/[documentation].
====
== Install barectf
See the barectf documentation's
-https://barectf.org/docs/barectf/{version}/install.html[Install barectf]
+https://barectf.org/docs/barectf/3.1/install.html[Install barectf]
page.
== Build barectf
documentation component version] under the `docs` directory.
This component version is the source of the
-https://barectf.org/docs/{version}/[barectf documentation website]
-(version{nbsp}{version}).
+https://barectf.org/docs/[barectf documentation website].
You can refer to this component version in your
https://docs.antora.org/antora/latest/playbook/[Antora playbook file],
== Get help
See the barectf documentation's
-https://barectf.org/docs/barectf/{version}/get-help.html[Get help]
-page.
+https://barectf.org/docs/barectf/3.1/get-help.html[Get help] page.
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
__major_version__ = 3
-__minor_version__ = 1
+__minor_version__ = 2
__patch_version__ = 0
-__pre_version__ = ''
+__pre_version__ = '-dev'
__version__ = f'{__major_version__}.{__minor_version__}.{__patch_version__}{__pre_version__}'
name: barectf
title: barectf
-version: '3.1'
+version: '3.2'
asciidoc:
attributes:
req-abbr: '<abbr title="Required?">Req?</abbr>'
= What's new in barectf{nbsp}{page-component-display-version}?
-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()`].
+TODO!
[tool.poetry]
name = 'barectf'
-version = '3.1.0'
+version = '3.2.0-dev'
description = 'Generator of ANSI C tracers which output CTF data streams'
license = 'MIT'
authors = ['Philippe Proulx <eeppeliteloop@gmail.com>']