3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
4,503 Commits 8 Branches 131 Tags 77 MiB
Commit Graph

37 Commits

Author SHA1 Message Date
Martin Hořeňovský 16f48f8c7c
Add SUCCEED and FAIL docs next to SKIP docs 2023-01-12 20:38:58 +01:00
Philip Salzmann d548be26e3
Add new SKIP macro for skipping tests at runtime (#2360) 
* Add new SKIP macro for skipping tests at runtime

This adds a new `SKIP` macro for dynamically skipping tests at runtime.
The "skipped" status of a test case is treated as a first-class citizen,
like "succeeded" or "failed", and is reported with a new color on the
console.

* Don't show "skipped assertions" in console/compact reporters

Also extend skip tests to cover a few more use cases.

* Return exit code 4 if all test cases are skipped

* Use LightGrey for the skip colour

This isn't great, but is better than the deep blue that was borderline
invisible on dark backgrounds. The fix is to redo the colouring
a bit, including introducing light-blue that is actually visible.

* Add support for explicit skips in all reporters

* --allow-running-no-tests also allows all tests to be skipped

* Add docs for SKIP macro, deprecate IEventListener::skipTest

Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
 2023-01-12 15:01:47 +01:00
Martin Hořeňovský 2d0dcc36e8
Add Bazel support to the documentation 2022-10-21 10:53:55 +02:00
Martin Hořeňovský 6a422bae0b
Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
Martin Hořeňovský 95cd95e591
Add extra explanations to some items in docs/readme.md 
This should make it easier for people to find what they need, e.g.
finding generators by looking for "value parameterized tests".
 2022-10-15 23:50:20 +02:00
Martin Hořeňovský eb7397544c
Bold section 'headings' in docs/readme.md 2022-10-15 23:50:18 +02:00
Martin Hořeňovský 0c962d11b3
Centralize and update docs for floating point comparisons 
The new docs mention that Approx is deprecated and should not be
used, and explain the reasons behind it.

Closes #1444
 2022-10-15 11:02:58 +02:00
Martin Hořeňovský 95a1206805
Add doc page with best practices and other usage tips 2022-06-24 11:20:22 +02:00
Martin Hořeňovský acdb85c398
Add FAQ page to the documentation 2021-11-19 15:23:50 +01:00
Martin Hořeňovský e8e28ba401
Remove obsolete documentation page 2021-09-23 23:42:16 +02:00
Martin Hořeňovský 52a3144145
Update users docs 2021-08-08 23:42:24 +02:00
Martin Hořeňovský a62974eb6a
Update why-catch.md 2021-08-08 23:42:17 +02:00
Martin Hořeňovský 735f46ed6d
Link to the migration docs from main readme and docs/readme 2020-10-31 09:08:58 +01:00
Clare Macrae 442283ee11
Add link to list of commercial user projects 2020-02-16 16:05:18 +01:00
Martin Hořeňovský b468d7cbff
Link benchmarking docs from the doc main page 2019-06-15 09:23:00 +02:00
Martin Hořeňovský df019cc113
Turn "deprecations" into "deprecations and planned changes" 
This captures the intent better, as some changes are indeed plain
deprecations leading to removal, but other changes can be viewed
as minor tune-ups instead.
 2018-11-24 18:04:56 +01:00
Martin Hořeňovský 68860ff129
Add deprecations documentation 2018-11-17 11:08:38 +01:00
Martin Hořeňovský 1d9b506e39 Add documentation for some miscellaneous and less important macros 
Fixes #1367
 2018-10-26 20:50:32 +02:00
Martin Hořeňovský 94121a5f6d Add a basic documentation for generators 2018-08-24 13:34:27 +02:00
Martin Hořeňovský bf221583b1 Update CMake and build documentation 2018-06-24 12:32:22 +02:00
Phil Nash 7423a481eb Updated some Catch references to Catch2 2017-11-03 13:05:09 +00:00
Martin Moene 071f49b12b Add page titles 2017-08-24 22:56:27 +02:00
Martin Moene 6c09b45a20 Let toplevel links to .md files link to .md#top 2017-08-24 19:40:36 +02:00
Martin Moene e8225052f1 Add html anchor 'top' 2017-08-24 19:40:36 +02:00
Martin Hořeňovský 3e018ef131 Add link to external gcov/lcov example to documentation 
An alternate take on #916, that better slots into the existing
documentation.

Closes #916
 2017-06-04 12:17:59 +02:00
Phil Nash e7984e3711 Reorganised the readme/ ref docs TOC and added link to reporters docs 2017-03-15 09:08:20 +00:00
Phil Nash 485dbdc0e7 Added link to event listeners docs 2017-03-13 19:27:18 +00:00
Phil Nash 044b616127 Added link to matchers docs from readme 2017-02-15 08:30:47 +00:00
Phil Nash 9a3788d98c Added links to open source users page from general pages 2017-02-10 22:50:40 +00:00
Martin Hořeňovský 7e7c813486 New documentation section: "known limitations" 
It contains known limitation such as the fact that Catch is not thread
safe, it does not support running tests in forked process or running
multiple tests in parallel

closes #399
closes #681
closes #246
closes #483
 2017-02-06 00:53:39 +01:00
Phil Nash 713ec400e8 Fixed type in “Release Notes” link 2017-01-11 16:46:09 +00:00
Phil Nash 3b2f206191 v1.6.0 build - including release notes 2017-01-11 16:44:36 +00:00
Trevor Hickey e52ad48fb7 removes link to missing readme file 2016-02-26 10:29:23 -05:00
Phil Nash c6d9bde04e fixed case of tostring.md link 2014-12-09 22:58:28 +00:00
Phil Nash 15a8bdf45b Added string conversions link 2014-12-09 19:15:49 +00:00
Phil Nash 32186db1b0 Added first cut of docs for configuring Catch 
- initially just covers new colour config
- also updated all [Home] links in footers to go to local readme
 2014-10-21 18:25:57 +01:00
Martin Moene 6336bb1b6e Add Readme as documentation entry 2014-08-15 14:12:53 +02:00