Commit Graph

52 Commits

Author SHA1 Message Date
Martin Hořeňovský 6d803cba5d
Add example of negated tag selection to the CLI test spec docs
Close #2180
2021-02-25 15:54:27 +01:00
Augustas dc3c22f9ec
update from Hudson to Jenkins
Hudson is discontinued in 2016. Changed to Jenkins
2020-10-31 21:48:28 +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
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
Martin Hořeňovský 4aefbbcd02
Pick docs for v2.12.0 2020-05-03 07:49:05 +02:00
Martin Hořeňovský 89fab65382
Update documentation for --order 2020-05-01 14:46:14 +02:00
Martin Hořeňovský 08f8a81b2c
Picking v2.11.2 docs changes 2020-04-30 21:44:16 +02:00
Tristan Stenner 6a2c025bfc
Add command line option 'never' to --wait-for-keypress (#1866)
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2020-02-16 16:11:11 +01:00
khyperia 3c7e737a7b
Allow configuring of benchmark warmup time 2020-02-16 15:44:23 +01:00
Martin Hostettler 8fb1219013 docs: command-line: Add example to specify tests by file name. 2019-10-21 23:51:33 +02:00
Clare Macrae d5a69cd400 Add 'Introduced in Catch 2.9.0.' text 2019-08-02 19:18:47 +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
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
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 Moene a81c01d4f9 Updated documentation TOCs 2018-09-08 11:05:52 +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
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
Josh Soref b11175548a Fixup various spelling errors (#1208) 2018-03-07 10:08:35 +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ý 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 Moene 07211cea9c Add table of contents 2017-08-29 17:25:24 +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
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
Kevin Wojniak f88049169e Fix wrong short option for section 2017-02-15 08:17:43 +01:00
Phil Nash 324260f253 Removed reference to DEBUG in command line docs 2017-02-11 23:39:38 +00: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
Phil Nash e6aa1f4e4e Added note on escaping names on command line to docs 2017-01-11 17:14:28 +00:00
Kylo Ginsberg 10c44847f4 Make backticks symmetric in markdown 2017-01-09 18:03:40 +01:00
Phil Nash 7abc9fa8b7 Added docs for --invisibles
also reordered command line docs jump list to match order listed when getting usage from Catch itself.
2014-12-16 18:38:40 +00:00
Phil Nash f5c9859131 Try again to fix --order docs 2014-12-16 18:21:42 +00:00
Phil Nash 0b1fa6a080 fixed (hopefully) formatting of '--order' docs
if only there was a standard-markdown!
2014-12-16 18:19:28 +00:00
Phil Nash 840b99af92 Added docs for --input-file
(somehow missing from previous commit)
2014-12-16 18:13:29 +00:00
Phil Nash 5259b78fea Updated command line docs
Added docs for:
  -f, --input-file
  --list-test-names-only
  --order
  --rng-seed
2014-12-16 18:11:13 +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 3e025cc2b6 Added bundled compact reporter 2014-08-19 23:43:51 +02:00
Phil Nash 94f47d5f8c Updated docs with new [!throws] behaviour 2014-04-16 07:58:09 +01:00
Phil Nash f15b74c0d2 Added some more docs 2013-11-14 19:08:19 +00:00
Phil Nash d17bb40030 Converted all html anchors in command line docs to match github generated anchors 2013-11-07 13:38:48 +00:00
Phil Nash 6916298c22 Attempt to match html anchors (which github strips out) with the ones github generates. 2013-11-07 13:30:39 +00:00
Phil Nash 0d4894e4bf Updated command line docs with -w and -d 2013-11-07 10:35:40 +00:00
Phil Nash bdb718471f Fixed typo 2013-10-17 22:45:37 +01:00
Phil Nash b9c6d30631 minor doc tweaks 2013-10-02 07:58:15 +01:00
Phil Nash 4ab680a4fb Expanded docs on tests cases and sections (still work-in-progress)
- also touched up some outdated bits in the tutorial
2013-10-01 08:20:08 +01:00
Phil Nash a26ddc9ca7 New docs for command line and logging 2013-06-14 08:32:48 +01:00