GitHub - efficios/barectf: Generator of ANSI C tracers which output CTF data streams

barectf build?jobUrl=https%3A%2F%2Fci.lttng

barectf (from bare metal and CTF) is a generator of tracers that produce CTF data streams.

Note

This README mostly documents barectf development.

Install barectf

Build barectf

barectf is a Poetry project.

To build barectf from this repository:

  1. Install Poetry.

  2. Build the project:

    The dist directory contains the distribution archives.

Build the barectf documentation

You can refer to this component version in your Antora playbook file, for example:

site:
  # ...
content:
  sources:
    - url: https://github.com/efficios/barectf
      branches: [stable-3.1]
      start_path: docs
    # ...
ui:
  # ...

Test barectf

To run the barectf tests:

  1. Make sure you have the testing requirements:

    • A little-endian architecture.

      YAML configuration files of tracing tests use a little-endian native byte order.

    • tox

    • A C compiler.

      If your C compiler is not the command cc, then set the CC environment variable to your compiler’s path and export it to run the barectf tests.

    • GNU Make

  2. Run the tests:

Get help

See the barectf documentation’s Get help page.