Commit Graph

347 Commits

Author SHA1 Message Date
Clare Macrae c43ce85416 Fix very minor typo
it's -> its
2017-10-31 14:28:20 +01:00
Pfiffikus 4220f2eef2 Update build-systems.md
typo correction
2017-10-31 14:28:10 +01:00
Martin Hořeňovský 88e912b4d1 Fix documentation crosslink in configuration.md 2017-10-31 14:19:53 +01:00
Martin Hořeňovský 276393e4e5 Change ToC script to use <br> instead of trailing spaces
Also updated docs that contain ToC. Fixes #1048
2017-10-13 11:17:38 +02:00
Martin Hořeňovský 79b405fd3f Add stringification for std::chrono::{duration,time_point}
Also hides std::chrono, std::pair and std::chrono::* behind
new configuration macros, CATCH_CONFIG_ENABLE_*_STRINGMAKER
to avoid dragging in <utility>, <tuple> and <chrono> in common
path, unless requested.
2017-10-09 13:03:29 +02:00
Martin Hořeňovský b80c5134f0 Updated release notes 2017-10-01 17:03:06 +02:00
Martin Hořeňovský 80bbce8424 Reorganize release notes 2017-09-26 13:38:09 +02:00
Phil Nash e9f0773f37 Updated release notes 2017-09-19 17:36:20 +01:00
Martin Hořeňovský a4df0b2c37 Remove obsoleted utility functions on matchers
Natural operators, &&, || and ! are preferred and do not have
limited arity.
2017-08-30 19:45:09 +02:00
Martin Hořeňovský 13213faa4e Update release notes in regards to CATCH_CONFIG_DISABLE 2017-08-30 12:43:23 +02:00
Martin Moene 07211cea9c Add table of contents 2017-08-29 17:25:24 +02:00
Martin Moene c5553019cc Fix heading levels
- page title (chapter): 1
- sections: 2
2017-08-29 17:25:24 +02:00
Martin Moene 66124d9e38 Make Current, Older releases sections, add subsections for each minor release 2017-08-29 17:25:24 +02:00
Martin Hořeňovský 053c29a2b8 Add partial implementation of CATCH_CONFIG_DISABLE
* Assertions are defined into (void)(0) no-op
* SECTIONs are defined away (leaving {} as scope)
* TEST_CASEs and TEST_CASE_METHODs are not registered.
* REGISTER_TEST_CASE is defined into (void)(0) no-op
* METHOD_AS_TEST_CASE is defined away
2017-08-27 22:05:25 +02:00
Martin Hořeňovský 2a13593885 Update CATCH_CONFIG_FAST_COMPILE documentation
Now it mentions that CHECK family of macros is affected as well
2017-08-27 16:48:15 +02:00
Martin Hořeňovský a0988dabf6 Add the experimental benchmark feature in documentation 2017-08-27 16:47:25 +02:00
Martin Hořeňovský 8f6d6a4a2d Remove legacy [hide] tag
Also removed even legacier "./" prefix for test case name...
2017-08-27 16:45:53 +02:00
Martin Hořeňovský e8d3be3621 Workaround raw string literal bug in VS2017 2017-08-27 12:38:59 +02: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ý 49f5919c41 Add partial release notes for 2.0.0 2017-08-18 20:15:00 +02:00
Martin Hořeňovský c7da5b5128 Remove obsolete note from reporter documentation 2017-08-18 19:33:00 +02:00
Martin Hořeňovský 3dc4de8173 Document implementation of listeners in non-main files
Closes #991
2017-08-18 19:33:00 +02:00
Martin Hořeňovský 626b1d3936 Add problems with `SECTION`s in loops to documentations 2017-08-18 19:33:00 +02:00
Phil Nash ff9aaf3afe Added Clara and TextFlowCpp to open source users 2017-08-17 10:48:53 +01:00
Phil Nash 0b52dbe8bb Small doc updates 2017-08-17 08:28:45 +01:00
Phil Nash 699e571400 Documented benchmark-resolution-multiple command line option
- and increased default to 100
2017-08-15 19:51:22 +01:00
Phil Nash 07ded81541 Added --libidentify and --wait-for-keypress to docs 2017-08-15 19:43:30 +01:00
Monocasual 74dfd0b1e0 Add open-source user 2017-08-15 13:48:43 +01:00
Martin Hořeňovský 0aec06f4c3 Update documentation with changes from 7e4038d 2017-08-14 12:20:27 +01:00
Martin Hořeňovský aa42dd92d1 Merge branch 'master' into dev-modernize 2017-08-10 11:34:26 +02:00
Martin Hořeňovský 705a1bf527 Add wandbox to release process documentation
Also some formatting and wording changes.
2017-08-08 23:04:10 +02:00
Cody Han d5613fb18a Update matchers docs to reflect namespace usage 2017-08-03 19:11:21 +02:00
Markus Werle 28741467d5 Update tutorial.md 2017-08-01 22:29:13 +02:00
Ivan Kush 7a76ff161b added 'args' argument parser library 2017-08-01 22:27:51 +02:00
Martin Hořeňovský 0ca4cfb743 Introduce compile time toggle to remove Matchers from TU
The toggle is `CATCH_CONFIG_DISABLE_MATCHERS` and the only use is
to speed up compilation of small TUs. For large ones it is likely
insignificant, because the speed up is constant relative to
number of tests/assertions in TU.
2017-07-28 21:34:34 +02:00
Martin Hořeňovský a14bd08b27 Update documentation to reflect the last change 2017-07-19 21:34:06 +02:00
Martin Hořeňovský 91c1556078 Moved Catch NotImplementedException out of the common include path
We could probably toss it away completely, currently it is used
only by TeamCity reporter.
2017-07-12 15:05:01 +02:00
Ivan Kush 8d380a7399 added 'args' argument parser library 2017-07-05 15:55:28 +02:00
Markus Werle 6f32db35af Update tutorial.md 2017-06-28 20:54:31 +02:00
Phil Nash cb0a5194af Updated overview docs a bit 2017-06-27 11:45:47 +01:00
Phil Nash 4c1880b35f Clamp exit code internally, so it doesn’t have to be done in every main() implies 2017-06-27 11:37:50 +01:00
Martin Hořeňovský ee67ac6b7c v1.9.6 2017-06-27 12:21:48 +02:00
Martin Hořeňovský c5bac73cad Merge branch 'master' into dev-modernize
This includes the performance commits done recently
2017-06-26 19:08:42 +02:00
Martin Hořeňovský 9382534d59 Added "How to test changes in PR" section to documentation
Also linked it from PR template.

Closes #936
2017-06-26 16:54:14 +01:00
Martin Hořeňovský a6cdcd43aa Added "How to test changes in PR" section to documentation
Also linked it from PR template.

Closes #936
2017-06-22 18:56:10 +02:00
Martin Hořeňovský 017a63da62 v1.9.5 2017-06-15 13:08:26 +02:00
Martin Hořeňovský e0aaba6cf8 Actually link #923 from the documentation 2017-06-06 16:46:46 +02:00
Martin Hořeňovský a09bef23ed Refer to #923 in reporter documentation 2017-06-06 16:43:14 +02:00
Martin Hořeňovský c465fbd0ea Slight documentation improvements 2017-06-05 18:42:04 +02:00
Martin Hořeňovský 950cae9040 Added new assertion macros: `*_THROWS_WITH`
It combines `*_THROWS_AS` and `*_THROWS_WITH` macros, so that the
exception type matches expectetations and its contents match a specific
matcher.
2017-06-05 18:40:50 +02:00
Martin Hořeňovský 7f6773bb4d Merge branch 'master' into dev-modernize
Hopefully nothing went too wrong.
2017-06-05 17:19:42 +02:00
Martin Hořeňovský da0edcbe25 Collect startup exceptions instead of throwing them
Previously, some errors in Catch configuration would cause exceptions to
be thrown before main was even entered. This leads to call to
`std::terminate`, which is not a particularly nice way of ending the
binary.

Now these exceptions are registered with a global collector and used
once Catch enters main. They can also be optionally ignored, if user
supplies his own main and opts not to check them (or ignored them
intentionally).

Closes #921
2017-06-04 21:39:27 +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
Martin Hořeňovský 52a84788e0 Add Inscopix to commercial users
Closes #918
2017-05-27 12:23:35 +02:00
Martin Hořeňovský 67914d8b86 Move back to static StringMaker<T>::convert
This avoids some breakage from the modernization
2017-05-21 23:40:05 +02:00
Austin L Wolfgram b18e67522f fixed spelling error 2017-05-20 15:10:42 -04:00
Martin Hořeňovský d271683c14 Added release process notes/checklist/explanation 2017-05-16 21:33:58 +02:00
Martin Hořeňovský 32d97caf42 Fixed missing ` in tag documentation 2017-05-16 15:45:44 +02:00
Martin Hořeňovský bc93b29789 Expanded tag documentation
It now mentions that most characters are valid as part of tag and other
details.

Closes  #909
2017-05-16 15:28:53 +02:00
Martin Hořeňovský b62c0256b2 Merge branch 'master' of https://github.com/philsquared/Catch 2017-05-16 14:34:27 +02:00
Martin Hořeňovský 1ea84cb734 Expanded logging documentation
Closes #884
2017-05-16 14:34:20 +02:00
Martin Hořeňovský 2a5d3736e8 Merge pull request #908 from pJunger/patch-1
Typo: Added namespace in method testCaseEnded
2017-05-16 14:05:31 +02:00
Martin Hořeňovský 3dcc923351 v1.9.4 2017-05-16 13:59:29 +02:00
Martin Hořeňovský 31f5e2ed81 Updated documentation about stringifying UDTs 2017-05-16 13:38:52 +02:00
Patrick Junger d4e0b1d093 Added namespace in method testCaseEnded
Did not compile as is
2017-05-14 14:11:47 +02:00
Martin Hořeňovský 5604ec7266 Updated toString documentation
It will need another update when Catch 2 goes live.

Closes #741
2017-05-03 21:09:27 +02:00
JayAndCatchFire 6e0fa4be68 Update opensource-users.md
Fixed broken link to LICENSE
2017-04-27 10:29:58 +02:00
Phil Nash a0ada2e935 v1.9.3 2017-04-25 14:23:06 +00:00
Phil Nash 569d355b36 Removed C++11 config macro docs 2017-04-25 14:57:47 +01:00
Martin Hořeňovský fc7f0a02b8 v1.9.2 2017-04-25 11:08:02 +02:00
Martin Hořeňovský 4cdb203ec3 Improve documentation about using Catch with CMake
Also added a note about the `contrib/ParseAndAddCatchTests.cmake`
script.

Closes #882
2017-04-24 16:27:43 +02:00
Alexander Batischev 49d87cf182 Add Newsbeuter to OSS users list (#891) 2017-04-22 16:02:55 +02:00
Phil Nash b591cb9a03 Added note about thread safety in assertions
- closes #875
2017-04-11 14:25:19 +01:00
Martin Hořeňovský c6990cdf91 v1.9.1 release 2017-04-09 21:25:20 +02:00
Phil Nash 5577322062 Added Nonius to open-sources users 2017-04-08 22:47:13 +01:00
Martin Hořeňovský 1b03c5ab6a v1.9.0 release 2017-04-07 22:56:36 +02:00
Phil Nash 7dd3c19027 Added NASA to commercial users list 2017-04-07 19:12:13 +01:00
Martin Hořeňovský 3ae076ce8d Updated REQUIRE* documentation under FAST_COMPILE 2017-04-05 10:26:19 +02:00
Sergey Semushin 94425ad59b Add opt-in c++11 stream insertable check. (#877)
* Add opt-in c++11 stream insertable check.

To opt-in, define CATCH_CONFIG_CPP11_STREAM_INSERTABLE_CHECK.

Opt-in fixes #872 and should fix #757 as well.
2017-04-05 09:53:10 +02:00
Martin Hořeňovský 3a3f152979 Updated documentation of CATCH_CONFIG_FAST_COMPILE 2017-03-29 21:13:51 +02:00
Mateusz Łoskot 2a221b8fcd Add nanodbc library to Catch users 2017-03-26 21:26:08 +02:00
Martin Hořeňovský d762a7ca6c Expanded documentation about THROWS_AS assertions 2017-03-23 21:16:52 +01:00
Phil Nash cffb031ce1 Added polymorphic_value to OSS users 2017-03-22 10:33:52 +00:00
Martin Hořeňovský 6a009fabcb Documented REQUIRE under CATCH_CONFIG_FAST_COMPILE 2017-03-17 17:02:39 +01: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 90d89377ea Added docs on reporters 2017-03-15 09:07:23 +00:00
Phil Nash 0692317bc5 Added Obj-C bindings fix to release notes 2017-03-15 09:04:09 +00:00
Martin Hořeňovský 95fc8d62a2 Fixed up old documentation links in release notes 2017-03-13 21:31:26 +01:00
Martin Hořeňovský 0c015aa887 v1.8.2 release 2017-03-13 21:29:30 +01:00
Phil Nash f69f821853 Updatecd [!shouldFail] docs with extra explanatory note, 2017-03-13 19:35:17 +00:00
Phil Nash 485dbdc0e7 Added link to event listeners docs 2017-03-13 19:27:18 +00:00
Phil Nash 68da5a6d19 Docs for Listeners 2017-03-10 19:17:25 +00:00
Phil Nash 5dd0639520 Added FAIL_CHECK
Works like FAIL, but does not abort test.
As proposed in #765
2017-03-08 15:42:11 +00:00
m0ppers 807941eb31 Add ArangoDB 2017-03-07 12:29:13 +01:00
Martin Hořeňovský af1ed708e4 Copied release note fixes to documentation 2017-03-06 10:46:21 +01:00
Phil Nash 658b5f63ef Updated release notes 2017-03-01 16:06:48 +00:00
Phil Nash 470561cbbd Update release-notes.md
Removed speed up time placeholder
2017-03-01 08:24:16 +00:00
Phil Nash 417202b743 Update release-notes.md
Fixed docs/ paths
2017-03-01 08:22:38 +00:00
Phil Nash 0952b76e16 v1.8.0 release 2017-02-28 14:19:09 +00:00
Martin Hořeňovský e4f4335b07 Improved Approx documentation 2017-02-27 14:22:17 +01:00
Martin Hořeňovský 593161ddd8 Documented the new vector matchers 2017-02-24 15:42:11 +01:00
Martin Hořeňovský 71e500f4b5 Updated reporter documentation 2017-02-24 14:01:38 +01:00
Justin Wilson b753f05d74 Add reporter for Automake (#826)
This allows for integration with Automake's default log compiler.

See #826 for more details.
2017-02-22 11:17:25 +01:00
Martin Hořeňovský 5d8055319e Updated docs to reflect the change to leak checking 2017-02-18 17:24:31 +01:00
Martin Hořeňovský 9202a77498 Documentation improvement 2017-02-16 11:11:52 +01:00
Martin Hořeňovský d8230a8d4d Add opt-in leak detection under MSVC + Windows.
Closes #439
2017-02-16 11:09:09 +01:00
Martin Hořeňovský c6178601c5 Cygwin compatibility fixes 2017-02-15 17:57:22 +01:00
Martin Hořeňovský c9a37c59c4 Added `CATCH_CONFIG_FAST_COMPILE` to documentation. 2017-02-15 10:42:11 +01:00
Phil Nash 5cb9e47034 Added SOCI to open-source users 2017-02-15 08:39:21 +00:00
Phil Nash 044b616127 Added link to matchers docs from readme 2017-02-15 08:30:47 +00:00
Kevin Wojniak f88049169e Fix wrong short option for section 2017-02-15 08:17:43 +01:00
Phil Nash d4ae1b18c0 Matcher documentation 2017-02-14 09:16:54 +00:00
Phil Nash d08cee288f v1.7.2 build 2017-02-13 16:15:42 +00:00
Martin Hořeňovský d890791800 Fixed editing mishap in documentation. 2017-02-12 15:48:32 +01:00
Martin Hořeňovský 26f6012bb9 Expanded the practical example in slow-compiles documentation 2017-02-12 14:47:25 +01:00
Phil Nash 324260f253 Removed reference to DEBUG in command line docs 2017-02-11 23:39:38 +00:00
Martin Hořeňovský fd7dde10d3 Added example of how to separately compile Catch's main
Closes #632
2017-02-11 19:11:57 +01:00
Phil Nash 9a3788d98c Added links to open source users page from general pages 2017-02-10 22:50:40 +00:00
Phil Nash c72ba93f92 Added file for listing commercial users 2017-02-09 17:54:13 +00:00
Phil Nash c1a5391034 Added some more open source projects 2017-02-08 21:47:07 +00:00
Martin Hořeňovský a38ccec33a Added 3rd party bug to documentation 2017-02-08 20:53:39 +01:00
Phil Nash 1ff56301a1 Corrected formatting 2017-02-08 18:35:30 +00:00
Phil Nash aee3675968 Added ChakraCore, Couchbase-lite and MAME rot OS projects 2017-02-08 18:34:19 +00:00
Phil Nash 0579f07092 Added RxCpp to OS page 2017-02-08 18:02:11 +00:00
Phil Nash e9ad954435 Seeded new doc page for tracking open source projects that use Catch 2017-02-08 17:15:37 +00:00
Phil Nash 1e87cae8af Documented the _THROWS_WITH macros, as well as slightly expanding the matchers docs. 2017-02-08 16:18:53 +00:00
Martin Hořeňovský 7b8a27eadb v1.7.1 build 2017-02-07 10:06:52 +01:00
Martin Hořeňovský f126d7943a Add explanation of THROW assertion limits + using lambda 2017-02-06 16:08:13 +01:00
Martin Hořeňovský cd489d9647 More documentation of known issues.
Closes #315
2017-02-06 15:55:01 +01:00
Martin Hořeňovský e991c006b7 Fixes for MinGW compatibility
Some versions of MinGW do not support enough of Win32 API to let us work
with SEH, so SEH is now MSVC only (+ configurable toggle).

Also made use of gmtime_s MSVC only (as oposed to Windows only).

Fixes #805
2017-02-06 01:43:53 +01: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
Martin Hořeňovský ce37f48ffa v1.7.0 build 2017-02-01 21:47:43 +01:00
Phil Nash 8cad76a749 typo 2017-02-01 14:39:06 +00:00
Phil Nash 1a3f6d829b Updated command line docs with info on -c for running sections, as well as -# for filenames as tags 2017-02-01 14:37:02 +00:00
Jan Včelák 1e5176bd69 Cap main exit code to 255 (#797)
Changed default main to clamp exit code to 8 bits because of POSIX limitations.

Updated documentation about declaring non-default main.
2017-01-31 20:48:14 +01:00
Martin Hořeňovský c97ada1910 Improved assertion documentation
Mentioned that decomposing `&&` and `||` is not supported, gave examples
+ possible workarounds.

Closes #621, #787, #341 and maybe others I haven't found.
2017-01-30 19:42:27 +01:00
Martin Hořeňovský 60a9ac7e65 Enabled previous commit under MSVC, introduced new feature toggle 2017-01-26 18:47:29 +01:00
Joshua Gerrard 51860f1568 Change include -> single_include in CMake example 2017-01-26 10:24:48 +01:00
Phil Nash 31c23b9489 Added [!nonportable] tag 2017-01-23 17:44:55 +00:00
Martin Hořeňovský 9a56609569 v1.6.1 build 2017-01-20 12:49:59 +01:00
Martin Hořeňovský cfaf906417 Changed documentation to use standard main function signature 2017-01-19 17:05:01 +01:00
Martin Hořeňovský 2e87f8e328 Merge branch 'windows-header-defines' of https://github.com/horenmar/Catch 2017-01-16 17:00:43 +01:00
Martin Hořeňovský b3907a78e1 Added NOMINMAX and WIN32_LEAN_AND_MEAN defines before including windows.h
This stops the `windows.h` header from defining `min` and `max` macros
and including lot of Windows APIs that are not needed by Catch.
2017-01-12 16:00:02 +01:00
Phil Nash e6aa1f4e4e Added note on escaping names on command line to docs 2017-01-11 17:14:28 +00:00
Phil Nash 1ff0acfe22 Tweaked release notes page with better formatting 2017-01-11 16:50:35 +00: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
Martin Hořeňovský 737f4ea77c Added missing C++11 feature toggle to docs 2017-01-10 22:43:58 +01:00