BARECTF(1)

NAME
barectf - Generate C99 code that can write native CTF packets

SYNOPSIS

barectf [--prefix=PREFIX] [--dump-config]
        [--code-dir=PATH] [--headers-dir=PATH] [--metadata-dir=PATH]
        [-I PATH]... [--ignore-include-not-found] CONFIG

DESCRIPTION

The barectf command generates C99 code, that itself can write Common Trace Format <http://diamon.org/ctf> packets natively, out of a YAML configuration input file CONFIG. The full documentation of barectf is available on the project’s website <http://barectf.org>.

A prefix is used to scope the generated file names, as well as the generated function names, macro names, structure names, and so on. By default, this prefix is barectf_. It can be overridden by the configuration file, and ultimately by the --prefix option.

By default, all generated C and CTF metadata files are written to the current working directory. The --code-dir, --headers-dir, and --metadata-dir options are used to control where the generated files should go.

You can add directories to be searched into for inclusion files, before the default search directories, by using the -I option one or more times.

By default, if an inclusion file is not found while processing the configuration file CONFIG, an error is emitted. You can instruct barectf to continue silently instead by providing the --ignore-include-not-found option.

To view the effective YAML configuration file used for generating the C and CTF metadata files, after having processed all inclusion files, use the --dump-config option.

OPTIONS

-c PATH, --code-dir=PATH
    Write C source files to directory PATH instead of the current working directory.

--dump-config
    Dump the effective YAML configuration file, after all inclusions are processed, to the standard output.

-H PATH, --headers-dir=PATH
    Write C header files to directory PATH instead of the current working directory.

--ignore-include-not-found
    Do not consider as an error inclusion files that are not found: continue silently.

-I PATH, --include-dir=PATH
    Prepend PATH to the list of directories to search into for include files. The default list of directories is the current working directory, followed by the directory containing the provided, "standard" inclusion files.

-m PATH, --metadata-dir=PATH
    Write CTF metadata file to directory PATH instead of the current working directory.

-p PREFIX, --prefix=PREFIX
    Override the configuration file’s prefix with PREFIX. This prefix is used in file names, function names, macro names, structure names, and the rest. When not specified in the configuration file, the default prefix is barectf_.

-h, --help
    Show command help.

--version
    Show the command’s version.

EXIT STATUS

0
    Success

Not 0
    Error

BUGS

Please report any bug or usability issue as a GitHub issue <https://github.com/efficios/barectf/issues>.

RESOURCES

    • Project’s website <http://barectf.org>

    • Continuous integration <http://ci.lttng.org/job/barectf>

    • Mailing list <http://lists.lttng.org> for support and development: lttng-dev@lists.lttng.org (prefix the subject message with [barectf])

    • IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net (eepp is barectf’s author and maintainer)

COPYRIGHT

Copyright (c) 2014-2016 Philippe Proulx <mailto:pproulx@efficios.com>.

barectf is distributed under the MIT License <https://github.com/efficios/barectf/blob/master/LICENSE>.

AUTHORS

barectf was originally written by and is maintained by, as of this version, Philippe Proulx <mailto:pproulx@efficios.com>. Other, nice people have since contributed to the project.

barectf is supported by EfficiOS <http://www.efficios.com/>.