Clare Macrae
119569a67e
Add 'Introduced in Catch 2.4.0.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
ab713894cc
Add docs for AND_GIVEN macro - see #1360
2019-08-02 19:18:47 +02:00
Clare Macrae
69fc94d6f8
Add 'Introduced in Catch 2.4.1.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
49cd7c96b4
Add 'Introduced in Catch 2.4.2.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
e998d152cc
Add 'Introduced in Catch 2.5.0.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
42a5903188
Add 'Introduced in Catch 2.6.0.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
c071f07e1a
Add 'Introduced in Catch 2.7.0.' note
2019-08-02 19:18:47 +02:00
Clare Macrae
53776a90cf
Add 'Introduced in Catch 2.7.1.' note
2019-08-02 19:18:47 +02:00
Clare Macrae
4511dc0c16
Add 'Introduced in Catch 2.8.0.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
e7c3bdb351
Add 'Introduced in Catch 2.8.0.' text
2019-08-02 19:18:47 +02:00
Clare Macrae
9aab958667
Add section headers, so I can later say when features were introduced
2019-08-02 19:18:47 +02:00
Clare Macrae
8cd58f75ec
Add missing struct Template_Fixture_2 so that the example compiles.
...
Code copied from projects/SelfTest/UsageTests/Class.tests.cpp
2019-08-02 19:18:47 +02:00
Clare Macrae
d5a69cd400
Add 'Introduced in Catch 2.9.0.' text
2019-08-02 19:18:47 +02:00
Martin Hořeňovský
de0674c116
Add a template for creating new documentation page
...
Related to #1695
2019-08-02 13:17:22 +02:00
Martin Hořeňovský
3d7282c2bd
Add a section on documentation to contributing.md
...
Related to #1695
2019-08-02 10:58:51 +02:00
Czapa10
7b70b11c23
Add PopHead to Open Source projects using Catch
2019-07-30 09:37:05 +02:00
Martin Hořeňovský
ab80277a86
Improve the REQUIRE_THROWS_MATCHES documentation a bit
2019-07-29 20:39:02 +02:00
Martin Hořeňovský
425957dc63
Update vector matcher documentation
...
As it turns out, there were 2 undocumented vector matchers. I also
improved the documentation of them all.
Closes #1699
2019-07-27 18:41:42 +02:00
Martin Hořeňovský
d017f6d18f
Document CATCH_CONFIG_CPP17_BYTE macro
...
Leftover from #1686
2019-07-26 21:43:46 +02:00
Martin Hořeňovský
91244d30a7
Document CATCH_CONFIG_CPP17_OPTIONAL macro
2019-07-26 21:42:54 +02:00
Clare Macrae
032068b889
Fix typo in 2.7.1 release notes
...
GENERATE_VAR -> GENERATE_REF
2019-07-21 22:04:50 +01:00
Martin Hořeňovský
03ffc1014c
Add a notice that benchmarking supports needs opt-in
2019-07-14 15:49:17 +02:00
Clare Macrae
0c27554af5
Update Contents in docs #1667
2019-07-06 17:25:55 +02:00
Scott Hutchinson
6f32c67ea7
Adding to documentation for --order and --rng-seed
2019-06-21 15:17:55 +02:00
Martin Hořeňovský
2f631bb808
v2.9.1
2019-06-17 12:02:14 +02:00
Martin Hořeňovský
f9dce28e7d
v2.9.0
2019-06-16 10:42:59 +02:00
Jozef Grajciar
e90d5a86e4
docs for TEMPLATE_LIST_TEST_CASE
2019-06-15 15:40:39 +02:00
Martin Hořeňovský
c365ac392b
Standardize and document the parallel processing toggle
2019-06-15 12:50:36 +02: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ý
e340ab8db6
Various improvements to the benchmarking support
...
* Units from <ratio> are no longer redeclared in our own namespace
* The default clock is `steady_clock`, not `high_resolution_clock`,
because, as HH says "high_resolution_clock is useless. If you want
measure the passing of time, use steady_clock. If you want user
friendly time, use system_clock".
* Benchmarking support is opt-in, not opt-out, to avoid the large
(~10%) compile time penalty.
* Benchmarking-related options in CLI are always present, to decrease
the amount of code that is only compiled conditionally and making
the whole shebang more maintainble.
2019-06-06 21:28:56 +02:00
Joachim Meyer
ce2560ca95
Integrate Nonius benchmark into Catch2
...
Changes done to Nonius:
* Moved things into "Catch::Benchmark" namespace
* Benchmarks were integrated with `TEST_CASE`/`SECTION`/`GENERATE` macros
* Removed Nonius's parameters for benchmarks, Generators should be used instead
* Added relevant methods to the reporter interface (default-implemented, to avoid
breaking existing 3rd party reporters)
* Async processing is guarded with `_REENTRANT` macro for GCC/Clang, used by default
on MSVC
* Added a macro `CATCH_CONFIG_DISABLE_BENCHMARKING` that removes all traces of
benchmarking from Catch
2019-06-06 19:33:37 +02:00
Martin Hořeňovský
00347f1e79
v2.8.0
2019-05-26 22:47:00 +02:00
Jozef Grajciar
732e4b06db
docs for signature based parametrised test cases
2019-05-23 21:03:47 +02:00
mlimber
f1e14a1168
Add missing word
2019-05-09 22:40:59 +02:00
Martin Hořeňovský
e2862a8d71
Add documentation for custom precision in float stringification
2019-05-03 15:40:21 +02:00
Phil nash
979bbf03bb
Removed another redundant ; (from docs)
2019-04-27 18:52:38 +01:00
Phil nash
33ce3f3953
added cpp to another code block in docs
2019-04-27 18:51:26 +01:00
Phil nash
87a9424c9d
Removed redundant ;
2019-04-27 18:50:05 +01:00
Phil nash
46066ede17
Merge branch enum stringification work
2019-04-26 11:26:45 +01:00
Wu Yuanshou
182fc3e46e
fix example's mistake in slow-compiles.md
...
the example lack the generation of factorial.o file which lead to an undefined reference error.
2019-04-25 09:48:22 +02:00
Martin Hořeňovský
7c37501b07
v2.7.2
2019-04-22 23:15:59 +02:00
Phil Nash
e02d9e788f
Document CATCH_REGISTER_ENUM
2019-04-21 20:32:20 +03:00
Martin Hořeňovský
3978e9653b
Add more documentation on contributing
2019-04-18 16:18:30 +02:00
Martin Hořeňovský
c3c82f539c
Merge pull request #1336 from ax3l/topic-overrideVirtualRedundant
...
Refactor: override implies virtual
2019-04-18 14:10:24 +02:00
Ryan Pavlik
edde6f4736
Fix typos identified by codespell.
...
Self test baselines also modified accordingly, due to
one typo found in a string in test code.
2019-04-10 09:42:11 +02:00
Martin Hořeňovský
b9dd1936e5
v2.7.1
2019-04-08 13:38:00 +02:00
Robin Lindén
7be35af167
Use correct filename in CMake integration docs
2019-04-07 15:41:34 +02:00
Martin Hořeňovský
3816e99d0c
Add GENERATE_COPY and GENERATE_VAR capturing generator macros
2019-03-31 14:11:10 +02:00
Omer Ozarslan
54089c4c8c
Deducing return type of map generator helper ( #1576 )
...
* Deduce map return type implicitly
Giving the first template argument to map generator function to deduce
return type is now optional even if the return type is different from
the type generated by mapped generator.
2019-03-24 15:44:22 +01:00
Tadeusz Puźniakowski
a1cdff4f18
raspigcd - opensource-users
...
Added raspigcd that uses Catch2 for tests
2019-03-19 20:35:59 +01:00
Steve Hollasch
4611125801
generators.md: fix extraneous back tick in doc
2019-03-14 09:14:02 +01:00
Clare Macrae
e509012e64
Update blog URL and fic typos in tutorial.md
2019-03-09 18:02:29 +01:00
Clare Macrae
448825db03
Readability improvements for assertions.md
2019-03-09 18:02:29 +01:00
Clare Macrae
0fff8e7791
Add ApprovalTests.cpp to list of open source users
2019-03-09 18:02:29 +01:00
Yurii Nakonechnyi
37a4e32319
Added override keyword near IntRange::describe() method
2019-03-09 15:05:27 +02:00
Martin Hořeňovský
d633072794
v2.7.0
2019-03-07 21:44:57 +01:00
Omer Ozarslan
1701325caa
Document unscoped info
2019-03-06 22:04:35 +01:00
Martin Hořeňovský
5bf6e47381
Add another example for generators
2019-02-26 12:52:21 +01:00
Martin Hořeňovský
693647c43f
Add ChunkGenerator
...
This generator collects values from the underlying generator until it
has a specified amount of them, and then returns them in one "chunk".
In case the underlying generator does not have enough elements for
a specific chunk, the left-over elements are discarded.
Closes #1538
2019-02-23 20:28:58 +01:00
Martin Hořeňovský
288387fa10
Cleanup: move things around
2019-02-23 17:16:28 +01:00
Rick de Water
165de9b072
Add RangeGenerator
2019-02-23 16:58:34 +01:00
Martin Hořeňovský
269303d9d9
Introduce random number (Integral and Float) generators
2019-02-20 00:09:15 +01:00
Matt Clarke
95f7712808
Missing hyphens and full-stops added
...
The use of full-stops is inconsistent, so I have added them where there are none.
The other option was to remove them instead.
2019-02-13 10:13:14 +01:00
Martin Hořeňovský
dbbab8727c
v2.6.1
2019-02-12 19:58:12 +01:00
Martin Hořeňovský
5d4061af12
Update release process docs to include PGP-signing
2019-02-12 19:33:08 +01:00
Jozef Grajciar
c03b23c84b
Added Makimo to list of commercial users
...
Closes #1528
2019-02-04 20:04:48 +01:00
Martin Hořeňovský
d75e9b3c0f
v2.6.0
2019-01-31 22:32:55 +01:00
Martin Hořeňovský
67308bb606
Add documentation for CATCH_CONFIG_ENABLE_OPTIONAL_STRINGMAKER
...
Related to #1510
2019-01-31 15:36:52 +01:00
Martin Hořeňovský
061f1f836a
Update documentation and examples for generators
2019-01-31 10:43:25 +01:00
Jozef Grajciar
8d5d54e529
Docs: note to INFO
2019-01-22 12:37:03 +01:00
Martin Hořeňovský
084b1d5fe6
Fix colourized output to file
...
This change should be backwards compatible, but it would be better
to make the console colour API take an argument in the long term.
Fixes #1502
2019-01-19 13:32:39 +01:00
Martin Hořeňovský
4109870435
Merge pull request #1484 from Lotterleben/extend_contributing
...
contributing.md: Add build instructions
2019-01-19 13:06:06 +01:00
Martin Hořeňovský
2988e9f6cf
Update contributing.md to reflect current test setup
2019-01-19 13:05:27 +01:00
Lotte Steenbrink
bc02ada4b0
Add build instructions to contributing.md
2019-01-19 13:05:22 +01:00
Torfinn Berset
0387fb64ce
Added Bloomlife to list of commercial users
2019-01-14 18:11:38 +01:00
NeroBurner
23f023f9ed
cpp higlighting for test-cases-and-sections.md
...
add c++ highlighting for the last two examples, all others already have highlighting
2019-01-10 12:29:21 +01:00
Jozef Grajciar
5b4ffd3c93
Docs: added docs for TEMPLATE_PRODUCT_TEST_CASE
2018-12-10 08:24:08 +01:00
Martin Hořeňovský
d0de666362
Merge pull request #1458 from ndusart/cppcodec
...
Add cppcodec in opensource users
2018-11-26 21:11:51 +01:00
Martin Hořeňovský
6ccd467094
v2.5.0
2018-11-26 20:50:38 +01:00
Martin Hořeňovský
16656c4c9e
Update the release process documentation
2018-11-26 20:41:14 +01:00
Nicolas Dusart
862955d657
add cppcodec in opensource users
2018-11-26 11:49:14 +01: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ý
59087f74d9
Fix CAPTURE macro for nontrivial uses
...
The previous implemetation was just plain broken for most of
possible uses, the new one should work (even though it is ugly
as all hell, and should be improved ASAP).
Fixes #1436
2018-11-21 16:48:09 +01:00
Martin Hořeňovský
77f29c2f1c
Add more deprecations
2018-11-17 21:13:56 +01:00
Martin Hořeňovský
a9d5b7193d
Add note about release signing to release docs
2018-11-17 14:41:34 +01:00
Martin Hořeňovský
396e0951c8
Add ToC to "Test cases and sections" documentation
2018-11-17 11:09:15 +01:00
Martin Hořeňovský
68860ff129
Add deprecations documentation
2018-11-17 11:08:38 +01:00
Martin Hořeňovský
99b37a4c62
Merge pull request #1445 from thecppzoo/master
...
operator<< works from the global namespace
2018-11-17 10:36:37 +01:00
Martin Hořeňovský
1dccd26de7
Fix link in documentation
2018-11-17 10:21:46 +01:00
thecppzoo
3f3238edf0
operator<< works from the global namespace
...
Since https://github.com/catchorg/Catch2/pull/1405 was merged and propagated to the single include declaring a user operator<< in the global namespace makes it available to Catch2 string converters.
2018-11-16 16:45:13 -08:00
Martin Hořeňovský
00d4f5d3c6
Add documentation for templated tests
2018-11-16 21:21:30 +01:00
Antonio Borondo
87950d9cfa
Fix Cute test framework URL
2018-11-05 19:38:37 +01:00
Martin Hořeňovský
03d122a35c
v2.4.2
2018-10-26 21:14:16 +02: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
Stephane Del Pino
544c7d7cbf
Add the optional variable OptionalCatchTestLauncher
...
This variable is set to allow the use of the nice ParseAndAddCatchTests script
in the case where a launcher is needed to execute the script.
This is introduced to allow to launch unit tests using mpi. In this case one can
write for instance
set(OptionalCatchTestLauncher ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${NUMPROC})
before calling the ParseAndAddCatchTests function.
2018-10-25 15:51:15 +02:00
Martin Hořeňovský
9e1bdca466
v2.4.1
2018-09-28 15:52:51 +02:00
Martin Moene
558bbe7d24
Add example for TeamCity reporter and refer to it
...
Prevent warnings
- gnu: -Wcomment: multi-line comment
- clang: -Wweak-vtables 'class' has no out-of-line virtual method definitions; its vtable will be emitted in every translation unit
- clang: -Winconsistent-missing-override: 'method' overrides a member function but is not marked 'override'
- MSVC: C4702: unreachable code
2018-09-27 23:20:02 +02:00
Martin Hořeňovský
4dd6e81d0f
Update "Known limitations" section of documentation
...
This fixes some wording that implies C++98 standard, updates
the recommended solution to looped SECTION macros and mentioned
the "last section failed, test needs to be rerun" problem.
Related to #1367
Related to #1384
Related to #1389
2018-09-21 21:03:14 +02:00
Martin Hořeňovský
9e6d7bbf00
Add documentation for installing Catch from the repository
...
This might prove helpful when the package managers either doesn't
have Catch at all, or provides it in obsolete version (Ubuntu 16.04,
I am looking at you).
Closes #1383
2018-09-21 20:48:18 +02:00
Martin Hořeňovský
dfb025cf08
Change wording of Approx documentation to be less misleading
...
The "percentage" suggests that the expected epsilon can be in
[0, 100], but the expected values are in [0, 1]. The new wording
uses "coefficient", to make it clearer that we are talking about
values in [0, 1].
Closes #1388
2018-09-21 20:04:56 +02:00