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
melak47
c638c57209
Add StringMaker for std::variant, std::monostate ( #1380 )
...
The StringMaker is off by default and can be enabled by a new macro `CATCH_CONFIG_ENABLE_VARIANT_STRINGMAKER`, to avoid increasing the footprint of stringification machinery by default.
2018-09-20 14:13:35 +02:00
melak47
a575536abe
Add StringMaker for std::(w)string_view
...
Fixes #1375
2018-09-10 11:37:26 +02:00
Martin Hořeňovský
46e99e258f
Fixup TOC script sluggification and documentation
2018-09-09 17:09:57 +02:00
Martin Moene
a81c01d4f9
Updated documentation TOCs
2018-09-08 11:05:52 +02:00
Martin Hořeňovský
60b05b2041
v2.4.0
2018-09-04 11:59:15 +02:00
Martin Hořeňovský
232ea3c456
Add documentation for no-exception support
...
Closes #703
Closes #1358
2018-09-04 10:06:31 +02:00
Axel Huebl
7667a7d89c
Docs: TABs to Spaces
...
Replace TABs with four (4) spaces in code docs.
2018-08-29 18:05:22 +02:00
George Fotopoulos
2067c8d3bd
Update opensource-users.md
...
Add "thor"
Update "forest" description
2018-08-29 14:51:17 +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ý
15cf3caace
v2.3.0
2018-07-23 10:12:15 +02:00
Martin Hořeňovský
797d3b04df
Reinstate CATCH_BUILD_TESTING CMake option
2018-07-22 18:01:42 +02:00
Martin Hořeňovský
ce80358306
Document Approx's UDL support
2018-07-15 17:38:57 +02:00
Axel Huebl
5347ff9e5f
Refactor: override implies virtual
...
If not used with `final`, override implies `virtual`.
Detected via CodeFactor score.
Another reference on SO:
https://stackoverflow.com/questions/43466863/isnt-virtual-keyword-redundant-when-override-or-final-specifiers-are-used
2018-07-12 14:27:06 +02:00
Unknown
e21c6aa94d
Fix the second Multiple-file example file link
...
Previously it pointed to the first file as well.
2018-07-09 15:47:03 +02:00
Martin Hořeňovský
7a59d5027f
Link the example from CATCH_CONFIG_NOSTDOUT documentation
2018-07-08 13:58:44 +02:00
Martin Hořeňovský
c8941cccb5
Add an example on providing streams with CATCH_CONFIG_NOSTDOUT
...
Related to #1037
Closes #1290
2018-07-08 13:38:42 +02:00
Martin Hořeňovský
5eeb6aa361
Update Approx documentation
...
Fixes #1328
2018-07-05 17:28:00 +02:00
Stephen McDowell
ad120965cf
fix link to single header version catch.hpp
2018-07-01 12:37:13 +02:00
Martin Hořeňovský
f460a7d8f9
Fix documentation of CATCH_CONFIG_FAST_COMPILE
...
Related to issue #1279
2018-06-30 12:31:46 +02:00
Martin Hořeňovský
ebf89000f1
Update thread safety documentation
...
Closes #1302
2018-06-28 22:35:42 +02:00
Martin Hořeňovský
e69afb6252
Remove removed macros from documentation
2018-06-28 09:43:10 +02:00
Martin Hořeňovský
bf221583b1
Update CMake and build documentation
2018-06-24 12:32:22 +02:00
Martin Hořeňovský
c5301bf8bf
Updated release process documentation to reflect vcpkg autoupdate
2018-06-11 22:44:14 +02:00
Martin Hořeňovský
d2a130f243
v2.2.3
2018-06-06 23:19:06 +02:00
Cristian Morales Vega
7abd7db2c8
Fix minor typo in the documentation
2018-06-01 22:24:49 +02:00
Martin Hořeňovský
df0b0e64e1
Make FALLBACK_STRINGIFIER documentation more explicit
...
Related to #1024
2018-05-14 21:03:07 +02:00
Martin Hořeňovský
db570b7e24
Split list of examples into "done" and "planned".
...
Closes #1282
2018-05-09 22:49:04 +02:00
Martin Hořeňovský
0074926e5c
Provide a polyfill over std::to_string
...
Android apparently does not support `std::to_string`, so we add a
small polyfill over it. Right now only the ULP matcher uses it,
but we have had plans to use it in `StringMaker<int>` and friends,
as it performs a lot better than `std::stringstream` based
stringification on MSVC.
See #1280 for more details
2018-05-09 21:47:42 +02:00
Palotás Boldizsár
dd99a66cf4
Add documentation for --use-colour
...
The documentation added is based on output from `-?` (help),
and comments to #590 .
2018-05-06 11:37:00 +02:00
Christian Berger
7f791fa08f
Suggestion for adding libcluon that is also using Catch2 for testing
2018-04-30 16:02:41 +02:00
Martin Hořeňovský
e92b9c07c3
Add an experimental new way of capturing stdout/stderr
...
Unlike the relatively non-invasive old way of capturing stdout/stderr,
this new way is also able to capture output from C's stdlib functions
such as `printf`. This is done by redirecting stdout and stderr file
descriptors to a file, and then reading this file back.
This approach has two sizeable drawbacks:
1) Performance, obviously. Previously an installed capture made the
program run faster (as long as it was then discarded), because a call
to `std::cout` did not result in text output to the console. This new
capture method in fact forces disk IO. While it is likely that any
modern OS will keep this file in memory-cache and might never actually
issue the IO to the backing storage, it is still a possibility and
calls to the file system are not free.
2) Nonportability. While POSIX is usually assumed portable, and this
implementation relies only on a very common parts of it, it is no
longer standard C++ (or just plain C) and thus might not be available
on some obscure platforms. Different C libs might also implement the
relevant functions in a less-than-useful ways (e.g. MS's `tmpfile`
generates a temp file inside system folder, so it will not work
without elevated privileges and thus is useless).
These two drawbacks mean that, at least for now, the new capture is
opt-in. To opt-in, `CATCH_CONFIG_EXPERIMENTAL_REDIRECT` needs to be
defined in the implementation file.
Closes #1243
2018-04-29 22:25:49 +02:00
Barry
200d3ad824
Support for parenthesizing types with commas.
2018-04-20 15:11:09 +02:00
Martin Hořeňovský
d2d8455b57
v2.2.2
2018-04-06 12:11:22 +02:00
Martin Hořeňovský
1ca8f43b01
Add PredicateMatcher that takes an arbitrary predicate functions
...
Also adds `Predicate` helper function to create `PredicateMatcher`.
Because of limitations in type inference it needs to be explicitly
typed, like so
`Predicate<std::string>([](std::string const& str) { ... })`.
It also takes an optional second argument for description of the
predicate.
It is possible to infer the argument with sufficient TMP, see
https://stackoverflow.com/questions/43560492/how-to-extract-lambdas-return-type-and-variadic-parameters-pack-back-from-gener/43561563#43561563
but I don't think that the magic is worth introducing ATM.
Closes #1236
2018-04-04 11:14:19 +02:00
Martin Hořeňovský
0a34cc201e
v2.2.1
2018-03-11 12:04:28 +01:00
Martin Hořeňovský
d14b7563c2
v2.2.0
2018-03-07 11:06:15 +01:00
Martin Hořeňovský
552589f25b
Merge branch 'master' into master
2018-03-07 10:37:50 +01:00
Tomas Zeman
352853ed7e
Introduce conditional wchar_t (and std::wstring) support
...
The support is turned on by default but the user might need to be able
to turn it off which is now possible by defining CATCH_CONFIG_NO_WCHAR.
2018-03-07 10:35:31 +01:00
Josh Soref
b11175548a
Fixup various spelling errors ( #1208 )
2018-03-07 10:08:35 +01:00
Martin Hořeňovský
cf4b7eead9
Document CATCH_CONFIG_CPP17_UNCAUGHT_EXCEPTIONS macro
...
Also fix how it can be disabled.
2018-02-25 21:22:38 +01:00
Nils Deppe
e84768fff1
Add SpECTRE project to list of users.
2018-02-14 08:31:33 +01:00
Martin Hořeňovský
31673ee0ca
Document CATCH_CONFIG_DEFAULT_REPORTER macro
2018-02-11 18:10:28 +01:00
Martin Hořeňovský
34d7a33574
Add a way to change fallback stringifier
...
This allows reuse of projects existing stringification machinery
Closes #1024
2018-02-11 16:31:12 +01:00
Martin Hořeňovský
082c3b84bc
Fix typos in documentation
2018-02-10 22:16:32 +01:00
Martin Hořeňovský
a90305f857
Add another known bug to limitations.md
...
Related to #1183
2018-02-10 13:51:33 +01:00
dvirtz
355b3f9952
Add option to warn when no tests ran
...
Closes #1158
2018-02-09 18:49:36 +01:00
Martin Hořeňovský
7cbd0b587a
v2.1.2
2018-02-09 17:10:27 +01:00
Martin Hořeňovský
5e484862f2
Add Catch::is_range to documentation
2018-02-01 20:29:49 +01:00
George Fotopoulos
5e8df1c384
Update opensource-users.md
2018-01-28 21:05:24 +01:00
Martin Hořeňovský
44dbda9f01
Add CATCH_VERSION_* defines for external use
...
I wonder how much use they will actually see, but their cost is
fairly minor.
Closes #1131
2018-01-26 20:56:14 +01:00
Martin Hořeňovský
62dae592c3
v2.1.1
2018-01-26 16:06:07 +01:00
Phil Nash
d5959907f5
Added Catch::clara namespace to doc for adding Opt
...
- Thanks to sakamoto-poteko in #1159 for point out its ommission
2018-01-23 07:44:09 +00:00
Martin Hořeňovský
9700ee4fc0
Update CTest autodiscovery documentation
2018-01-12 12:28:14 +01:00
Martin Hořeňovský
bbda8cd77c
Update reporter docs with their new location
2018-01-12 12:20:52 +01:00
Martin Hořeňovský
5774c4f9c2
Update release process with the need to release reporters
2018-01-11 21:06:35 +01:00
Martin Hořeňovský
cd76f5730c
v2.1.0
2018-01-10 13:53:04 +01:00
Aivars Kalvans
13ea4225e7
Add fuxedo.io to open source users
2018-01-06 14:02:01 +01:00
Phil Nash
fc88313d45
Added DtCraft to Open Source users
2017-12-12 17:22:40 +00:00
Dan Nissenbaum
88d2bac624
Trivial typo fix. ( #1119 )
2017-12-09 21:29:39 +01:00
Martin Hořeňovský
24851dff99
Add release notes from the EOL of Catch Classic
2017-12-03 14:19:02 +01:00
lbersch
516dbc83bc
Add inja to open source users ( #1106 )
...
* Add Inja to open-source users
* Capitalize first letter in user description
* Fix url
2017-11-17 11:49:39 +01:00
Martin Moene
2bbba4f544
Refer to example code from the Tutorial
2017-11-15 15:37:39 +01:00
Martin Moene
29cdd6c526
Add link to event listener example to documentation
2017-11-15 15:37:39 +01:00
Martin Moene
dfb7217613
Add list of examples to documentation
2017-11-15 15:37:39 +01:00
Martin Hořeňovský
97a8640cbf
Update 3rd party bugs documentation
...
Removes bugs from no longer supported compilers
Adds a confirmed 3rd party bug in VS 2015
Closes #881
2017-11-14 22:05:30 +01:00
Martin Hořeňovský
033e078320
Fix typo in build system docs
2017-11-14 21:42:28 +01:00
Martin Hořeňovský
9796a77a37
Initial prototype of PCH support
...
Related to #1061
2017-11-14 21:41:36 +01:00
Martin Hořeňovský
b0857e846f
Provide a regex matcher against std::string
...
Related to #1040
2017-11-13 15:35:31 +01:00
Martin Hořeňovský
0b1f1b1003
Add ULP and margin matcher
...
Closes #1074
2017-11-10 18:33:00 +01:00
