X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=CONTRIBUTING.adoc;h=c31f9a89f403e3a4548599ff564ead11ad78f3c8;hb=223096991003ecb21c555060226717932f6e2180;hp=d5241ff4a8d611b924a9713f94116d292059cbc9;hpb=3e6740247afd3bf18fa282452f4b5c7fc03f065f;p=babeltrace.git diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index d5241ff4..c31f9a89 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1505,11 +1505,11 @@ $ ./tests/plugins/sink.text.pretty/test-enum.sh ==== Python -You can use the `tests/utils/run-python-bt2.sh` script to run any -command within an environment making the build's `bt2` Python package -available. +You can use the `tests/utils/run-in-py-env.sh` script to run any command +within an environment making the build's `bt2` Python package available, +as well as the testing utility Python modules. -`run-python-bt2.sh` uses <> which needs to know the +`run-in-py-env.sh` uses <> which needs to know the build directory, so make sure you set the `BT_TESTS_BUILDDIR` environment variable correctly _if you build out of tree_, for example: @@ -1518,10 +1518,10 @@ $ export BT_TESTS_BUILDDIR=/path/to/build/babeltrace/tests ---- You can run any command which needs the `bt2` Python package through -`run-python-bt2.sh`, for example: +`run-in-py-env.sh`, for example: ---- -$ ./tests/utils/run-python-bt2.sh ipython3 +$ ./tests/utils/run-in-py-env.sh ipython3 ---- === Report format @@ -1567,13 +1567,13 @@ To run all the `bt2` Python package tests: * Run: + ---- -$ ./tests/utils/run-python-bt2.sh ./tests/bindings/python/bt2/test-python-bt2.sh +$ ./tests/utils/run-in-py-env.sh ./tests/bindings/python/bt2/test-python-bt2.sh ---- + or: + ---- -$ ./tests/utils/run-python-bt2.sh python3 ./tests/utils/python/testrunner.py \ +$ ./tests/utils/run-in-py-env.sh python3 ./tests/utils/python/testrunner.py \ ./tests/bindings/python/bt2/ -p '*.py' ---- @@ -1583,7 +1583,7 @@ To run **all the tests** in a test module (for example, * Run: + ---- -$ ./tests/utils/run-python-bt2.sh python3 ./tests/utils/python/testrunner.py \ +$ ./tests/utils/run-in-py-env.sh python3 ./tests/utils/python/testrunner.py \ ./tests/bindings/python/bt2 -t test_value ---- @@ -1593,7 +1593,7 @@ To run a **specific test case** (for example, `RealValueTestCase` within * Run: + ---- -$ ./tests/utils/run-python-bt2.sh python3 ./tests/utils/python/testrunner.py \ +$ ./tests/utils/run-in-py-env.sh python3 ./tests/utils/python/testrunner.py \ ./tests/bindings/python/bt2/ -t test_value.RealValueTestCase ---- @@ -1603,7 +1603,7 @@ To run a **specific test** (for example, * Run: + ---- -$ ./tests/utils/run-python-bt2.sh python3 ./tests/utils/python/testrunner.py \ +$ ./tests/utils/run-in-py-env.sh python3 ./tests/utils/python/testrunner.py \ ./tests/bindings/python/bt2/ -t test_value.RealValueTestCase.test_assign_pos_int ---- @@ -1680,20 +1680,20 @@ You need clang-format{nbsp}15 to use the project's `.clang-format` file. To automatically format all the project's {cpp} files, run: ---- -$ ./tools/format-cpp +$ ./tools/format-cpp.sh ---- Pass a directory path to only format the {cpp} files it contains: ---- -$ ./tools/format-cpp ./src/cli +$ ./tools/format-cpp.sh ./src/cli ---- Use the `FORMATTER` environment variable to override the default formatter (`clang-format{nbsp}-i`): ---- -$ FORMATTER='my-clang-format-15 -i' ./tools/format-cpp +$ FORMATTER='my-clang-format-15 -i' ./tools/format-cpp.sh ---- ==== Naming