Martin Hořeňovský
39aabede62
Add a short documentation for migrating from v2 to v3
2020-10-31 08:14:50 +01:00
Clare Macrae
40b9df567f
Add missing cmake option to fix buildAndTest.sh
...
Note that the documentation was updated automatically, by running:
./tools/scripts/updateDocumentSnippets.py
2020-10-28 11:38:06 +01:00
Clare Macrae
c6352c3e1f
Embed the script buildAndTest.sh inside the docs
2020-10-28 11:38:06 +01:00
Clare Macrae
f57689f888
Fix minor typo in docs.
2020-10-28 11:38:06 +01:00
Martin Hořeňovský
0c7f96ba63
Update documentation not to reference master branch
2020-10-21 19:59:59 +02:00
Martin Hořeňovský
b9853b4b35
Bump version to v3.0.0 preview 3
2020-10-08 15:26:30 +02:00
Martin Hořeňovský
853565bfb8
Pick release notes for v2.13.2
2020-10-08 12:51:07 +02:00
Matt Godbolt
b841650253
Add missing syntax highlighting tag
2020-10-08 11:37:31 +02:00
Martin Stump
c522e88afa
Add REPORTER and OUTPUT_* args
2020-10-08 11:35:42 +02:00
Florian Berchtold
b1df96e7e4
Docu/Show how to use CMake FetchContent ( #2028 )
2020-10-08 11:35:18 +02:00
kotaiadam
9e172c707e
fixes bug in example - undeclared identifier
...
j was not declared in `SECTION("two")`
2020-10-08 11:34:25 +02:00
Martin Hořeňovský
340ff00058
Rewrite contributing docs for v3
2020-10-06 12:36:20 +02:00
Martin Hořeňovský
d1625f30b1
Pick release notes from v2.13.1
2020-09-07 14:34:36 +02:00
mattkurz
08fb5cbab2
Fix typo in generators docs
2020-09-07 13:02:38 +02:00
Martin Hořeňovský
33ad1ee2ac
Split EventListener base from streaming_base.hpp
...
The base was also renamed from `TestEventListenerBase` to
`EventListenerBase`, and modified to derive directly from the
reporter interface, rather than deriving from `StreamingReporterBase`.
2020-08-29 19:09:54 +02:00
Martin Hořeňovský
6efeecc179
Cherry-pick doc updates for v2.13.0
2020-07-26 15:14:38 +02:00
Martin Hořeňovský
a004423c7f
Improve documentation for --min-duration
2020-07-26 14:06:52 +02:00
Martin Hořeňovský
4b344f11ea
Document GENERATE's new usage between SECTIONs
2020-07-26 14:06:34 +02:00
John Bytheway
80b0d6975c
Add --min-duration option
...
A test runner already has a --durations option to print durations.
However, this isn't entirely satisfactory.
When there are many tests, this produces output spam which makes it hard
to find the test failure output. Nevertheless, it is helpful to be
informed of tests which are unusually slow.
Therefore, introduce a new option --min-duration that causes all
durations above a certain threshold to be printed. This allows slow
tests to be visible without mentioning every test.
2020-07-26 10:47:53 +02:00
Eric Huber
36131f7ffa
Escaping literal "*" ("times") to fix markdown
2020-07-24 22:36:58 +02:00
Martin Hořeňovský
f52018205d
Cherry pick release notes for v2.12.4
2020-07-24 22:36:13 +02:00
Martin Hořeňovský
e28018c659
Cherry pick release notes for v2.12.3
2020-07-24 22:33:59 +02:00
Martin Hořeňovský
2a25a267ea
Cherry pick release notes for v2.12.2
2020-07-24 22:33:26 +02:00
Richard Ash
2840ce1e70
Add an example of using GENERATE(table())
...
There are some examples on issue #850 of using this feature, but they
are not easily found from the documentation. Adding them here as an
example makes them more findable and ensures they keep working if the
API changes.
2020-07-22 21:49:54 +02:00
Richard Ash
ed9be5a00b
Add notes on compiling the examples.
...
This took me some time to figure out so document for others.
2020-07-22 21:43:53 +02:00
Martin Hořeňovský
314bb7e632
Clarify documentation about nested generators
...
Closes #1947
2020-07-22 21:18:49 +02:00
Martin Hořeňovský
4394d3ae65
Translate exceptions by const reference instead of plain ref
2020-05-20 08:15:27 +02:00
Martin Hořeňovský
e867ce7769
Fix missing backticks on release notes
...
Closes #1932
2020-05-15 10:54:20 +02:00
Martin Hořeňovský
f7fbbac601
Update release notes for v3
2020-05-14 14:57:22 +02:00
Martin Hořeňovský
ddde2f5e33
Remove obsolete configuration macros from the documentation
2020-05-14 14:52:33 +02:00
Martin Hořeňovský
d5e87eabbb
Add provided generic matchers to the documentation
2020-05-14 14:48:48 +02:00
Martin Hořeňovský
04c171f91f
Update CATCH_CONFIG_WINDOWS_CRTDBG docs to reflect new distribution
2020-05-06 18:17:51 +02:00
Martin Hořeňovský
31ff89709f
Pick docs for v2.12.1
2020-05-03 07:54:07 +02:00
Martin Hořeňovský
4aefbbcd02
Pick docs for v2.12.0
2020-05-03 07:49:05 +02:00
Martin Hořeňovský
bbbc7a0d7f
Fix CATCH_CONFIG_CPP17_UNCAUGHT_EXCEPTION interaction with feature macro
2020-05-01 20:26:40 +02:00
Martin Hořeňovský
89fab65382
Update documentation for --order
2020-05-01 14:46:14 +02:00
Phoebe
46cc551b7a
Add vcpkg installation instructions ( #1898 )
...
* Add vcpkg installation instructions
* Add index
2020-05-01 09:31:41 +02:00
Mark Gillard
f34aacfe5f
Added toml++ to opensource-users.md
2020-05-01 09:31:12 +02:00
Mark Gillard
0d3e933d71
Fix alphabetical ordering of opensource-users.md
2020-05-01 09:31:03 +02:00
Martin Hořeňovský
656b15d37b
Pick doc changes for v2.11.3
2020-05-01 09:28:17 +02:00
Martin Hořeňovský
08f8a81b2c
Picking v2.11.2 docs changes
2020-04-30 21:44:16 +02:00
Julius Hülsmann
38a0dfca6d
Update tutorial.md
...
Fix: typo; remove trailing ","
2020-04-29 21:17:54 +02:00
Julius Hülsmann
b014d988fe
Update slow-compiles.md
...
Add missing "."
2020-04-29 21:17:30 +02:00
magnus.ornebring
7a0f8ff4b8
Add king as user
2020-04-29 16:55:03 +02:00
Martin Hořeňovský
4d63c36402
Update release notes with matcher changes
2020-03-29 14:57:29 +02:00
Martin Hořeňovský
ab0ca2f566
Rename some matcher-related files
...
The two changes are
`catch_matchers_templates` -> `catch_matchers_templated` and
`catch_matchers_generic` -> `catch_matchers_predicate`. The former
is mostly cosmetic, but the second was previously significantly
misleading, and as the library is now to be consumed by including
specific headers, this needed to be fixed.
2020-03-27 10:24:08 +01:00
Martin Hořeňovský
3a3efebd16
Add IsEmpty and SizeIs matchers for ranges/containers
...
`SizeIs` can accept both `size_t` and a matcher. In the first case,
it checks whether the size of the range is equal to specified size.
In the second case, it checks whether the provided matcher accepts
the size of the range.
2020-03-27 10:24:08 +01:00
Martin Hořeňovský
c2daf468bb
Standardize matcher headers to use .hpp suffix
2020-03-27 10:22:25 +01:00
Martin Hořeňovský
64d7f9b98a
New and hopefully improved documentation for matchers
2020-03-27 10:22:25 +01:00
Martin Hořeňovský
a15ffb735d
Make ListeningReporter final
...
In general, for Catch2 v3 we are making virtual types `final`,
unless they were explicitly designed to be derived-from.
`ListeningReporter` is definitely not designed to be derived-from.
2020-03-09 21:15:30 +01:00
