X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=CONTRIBUTING.adoc;h=9af7a419c8f1968534ab28ccdb2111f716a7bb00;hp=7052f2e8e232714565579f60112f8462bf20c195;hb=5ce9818ba4e76858b2ef12c81ba75c1306f195d3;hpb=b61d54652477503ef2b058fd8304e6c16cd5cef8 diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 7052f2e8..9af7a419 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -585,10 +585,6 @@ of `+BT_LOG*()+`: Library error logging statement, and unconditional error cause appending. -`+BT_LIB_LOGF_APPEND_CAUSE("format string", ...)+`:: - Library fatal logging statement, and unconditional error cause - appending. - The macros above accept the typical `printf()` conversion specifiers with the following limitations: @@ -1490,26 +1486,23 @@ backtrace when Valgrind shows errors. [[test-env]] === Environment -`tests/utils/utils.sh` sets the environment variables for any {bt2} -test script. +Running `make check` in the build directory (regardless of whether the build is +in-tree or out-of-tree) automatically sets up the appropriate environment for +tests to run in, so nothing more is needed. + +If building in-tree, you can run single tests from the tree directly: -`utils.sh` only needs to know the path to the `tests` directory within -the source and the build directories. By default, `utils.sh` assumes the -build is in tree, that is, you ran `./configure` from the source's root -directory, and sets the `BT_TESTS_SRCDIR` and `BT_TESTS_BUILDDIR` -environment variables accordingly. You can override those variables, for -example if you build out of tree. +---- +$ ./tests/plugins/sink.text.pretty/test_enum +---- -All test scripts eventually do something like this to source `utils.sh`, -according to where they are located relative to the `tests` directory: +If building out-of-tree, you can get the appropriate environment by sourcing +the `tests/utils/env.sh` file residing in the build directory against which you +want to run tests. -[source,bash] ---- -if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then - UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh" -else - UTILSSH="$(dirname "$0")/../utils/utils.sh" -fi +$ source /path/to/my/build/tests/utils/env.sh +$ ./tests/plugins/sink.text.pretty/test_enum ---- ==== Python @@ -1683,8 +1676,7 @@ https://clang.llvm.org/docs/ClangFormatStyleOptions.html[style] of the You _must_ format modified and new {cpp} files with clang-format before you create a contribution patch. -You need clang-format{nbsp}≥{nbsp}10 to use the project's `.clang-format` -file. +You need clang-format{nbsp}14 to use the project's `.clang-format` file. To automatically format all the project's {cpp} files, run: