diff options
| author | Clare Macrae | 2020-10-23 19:47:05 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2020-10-28 11:38:06 +0100 |
| commit | c6352c3e1f63725ca39e48ee3fd79e47e5ecae76 (patch) | |
| tree | 5e3a6622a20e07461edf60a8f5a42674ece47d9a /docs | |
| parent | 4035beb98848153b535ddfa746271ee2d4658699 (diff) | |
| download | catch3-c6352c3e1f63725ca39e48ee3fd79e47e5ecae76.tar.gz | |
Embed the script buildAndTest.sh inside the docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.md | 39 |
1 files changed, 23 insertions, 16 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 020dbfca..1d3143fb 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -78,23 +78,30 @@ the invocation of CMake configuration step. Bringing this all together, the steps below should configure, build, and run all tests in the `Debug` compilation. -1. Regenerate the amalgamated distribution -``` -$ cd Catch2 -$ ./tools/scripts/generateAmalgamatedFiles.py -``` -2. Configure the full test build -``` -$ cmake -Bdebug-build -H. -DCMAKE_BUILD_TYPE=Debug -DCATCH_BUILD_EXAMPLES=ON -DCATCH_BUILD_EXTRA_TESTS=ON -``` -3. Run the actual build -``` -$ cmake --build debug-build -``` -4. Run the tests using CTest +<!-- snippet: catch2-build-and-test --> +<a id='snippet-catch2-build-and-test'></a> +```sh +# 1. Regenerate the amalgamated distribution +./tools/scripts/generateAmalgamatedFiles.py + +# 2. Configure the full test build +cmake -Bdebug-build -H. -DCMAKE_BUILD_TYPE=Debug -DCATCH_BUILD_EXAMPLES=ON -DCATCH_BUILD_EXTRA_TESTS=ON + +# 3. Run the actual build +cmake --build debug-build + +# 4. Run the tests using CTest +cd debug-build +ctest -j 4 --output-on-failure -C Debug ``` -$ cd debug-build -$ ctest -j 4 --output-on-failure -C Debug +<sup><a href='/tools/scripts/buildAndTest.sh#L6-L19' title='File snippet `catch2-build-and-test` was extracted from'>snippet source</a> | <a href='#snippet-catch2-build-and-test' title='Navigate to start of snippet `catch2-build-and-test`'>anchor</a></sup> +<!-- endSnippet --> + +For convenience, the above commands are in the script `tools/scripts/buildAndTest.sh`, and can be run like this: + +```bash +cd Catch2 +./tools/scripts/buildAndTest.sh ``` If you added new tests, you will likely see `ApprovalTests` failure. |