Roger Standridge
b56c474260
Update comparing-floating-point-numbers.md
2022-10-29 12:42:45 +02:00
Lars Toenning
f1084fb309
Fix references to license file
...
The license file was renamed with 6a502cc2f5
2022-10-28 11:30:15 +02:00
Martin Hořeňovský
2d0dcc36e8
Add Bazel support to the documentation
2022-10-21 10:53:55 +02:00
Martin Hořeňovský
5df88da16e
3.1.1
2022-10-17 19:57:58 +02:00
Martin Hořeňovský
5cd8938905
Update explanation of REQUIRE_FALSE in docs/assertions.md
2022-10-17 15:13:00 +02:00
Martin Hořeňovský
6a422bae0b
Trim superfluous whitespace in docs
2022-10-17 15:02:45 +02:00
Martin Hořeňovský
a07ac3f935
Rewrite explanation of problems with && and || in assertions
2022-10-17 12:36:02 +02:00
Martin Hořeňovský
d8619f076b
Fixup shard index docs
...
Closes #2547
2022-10-16 17:00:29 +02:00
Martin Hořeňovský
95cd95e591
Add extra explanations to some items in docs/readme.md
...
This should make it easier for people to find what they need, e.g.
finding generators by looking for "value parameterized tests".
2022-10-15 23:50:20 +02:00
Martin Hořeňovský
eb7397544c
Bold section 'headings' in docs/readme.md
2022-10-15 23:50:18 +02:00
Sam Cunliffe
d1394a7064
Link to SECTIONS doc at top of test fixtures page.
...
I came here looking for a way to use a fixture. But what I really wanted was better done in the SECTION macro. Feels like a link right at the top would've made it clearer faster.
2022-10-15 16:59:52 +02:00
Martin Hořeňovský
0c962d11b3
Centralize and update docs for floating point comparisons
...
The new docs mention that Approx is deprecated and should not be
used, and explain the reasons behind it.
Closes #1444
2022-10-15 11:02:58 +02:00
tocic
dea1a6abd9
Fix typos in docs ( #2514 )
2022-09-09 16:00:39 +02:00
Martin Hořeňovský
4adf010549
Mention dynamic library stuff in the FAQ
...
Closes #2497
2022-09-03 22:31:29 +02:00
Martin Hořeňovský
686468d185
Explain TU as translation unit where appropriate
2022-09-03 22:22:10 +02:00
Martin Hořeňovský
33e70194d3
Link to the randomized-shard-registration script from usage tips
2022-08-18 00:14:07 +02:00
Martin Hořeňovský
9bb206fc61
Remove obsoleted sections of ci-and-misc.md
2022-08-18 00:05:55 +02:00
Martin Hořeňovský
ab04e599e7
Improve v2->v3 migration docs
2022-08-18 00:02:33 +02:00
Martin Hořeňovský
97c48e0c34
v3.1.0
2022-07-17 20:18:44 +02:00
Raphael Schaller
1bd233866c
Add AllTrue, AnyTrue, NoneTrue matchers
2022-07-16 16:16:05 +02:00
Martin Hořeňovský
a6d59b62b2
Remove obsolete link to benchmarking tests
...
The benchmarking feature is now documented, so there is no need
to direct our users towards our test file to understand how it
works.
Closes #2471
2022-07-15 19:49:24 +02:00
Martin Hořeňovský
34d9724058
Add experimental CMake script for sharding tests in binaries
2022-06-24 14:12:55 +02:00
Martin Hořeňovský
5d269045b2
Add section on running tests in parallel to the FAQ
2022-06-24 11:20:31 +02:00
Martin Hořeňovský
95a1206805
Add doc page with best practices and other usage tips
2022-06-24 11:20:22 +02:00
Martin Hořeňovský
6f9f1465c3
Shorten lines in sharding docs
2022-06-22 00:12:16 +02:00
Frank Dana
a369267874
test-fixtures.md: Line-wrap code examples ( #2464 )
...
* test-fixtures.md: Line-wrap code examples
* relinebreak
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2022-06-19 16:24:59 +02:00
Nexus Web Development
1f381a1f62
Update commercial-users.md ( #2465 )
...
Using Catch2 and now Catch3 for our client's as well as our own projects and loving it. Especially the easy C++ BDD setup and implementation.
2022-06-18 23:47:49 +02:00
Brandon Jones
7e4ec432d0
Change Bazel XML support to depend upon BAZEL_TEST
2022-06-17 16:36:14 +02:00
Martin Hořeňovský
372b7575f6
Remove deprecation notice for console colour CLI
...
The required changes were one of the last commits before the full
v3 release.
2022-06-13 23:52:31 +02:00
Elizabeth Sherrock
0a810c5e59
Added Cytopia to opensource-users.md
2022-06-07 09:06:10 -04:00
Martin Hořeňovský
8822e28772
Update CE link in BDD documentation for 3.0.1
...
The old compiler was no longer built-for, so it couldn't link
against new versions, and also didn't properly provide the
user-config header.
Closes #2396
2022-06-06 00:29:02 +02:00
Petr Kubánek
0c13d021da
Update documentation - add pkg-config examples.
...
Use -std=c++14 (instead of c++11). Pointers how to integrate with
pkg-config for non-CMake projects.
2022-06-05 15:58:41 +02:00
balus
3644b4135d
Doc: correct the address of the link to the command-line doc in tutorial.md
2022-06-04 10:20:01 +02:00
Sergio Losilla
231c58a048
Add table with verbosity levels (missing --list-listeners) ( #2443 )
...
Co-authored-by: Sergio Losilla <sergio.losilla@nt-bnct.com>
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2022-06-02 21:50:51 +02:00
Martin Hořeňovský
8c952bd076
Point to 3.0.1 in FetchContent example
...
Closes #2326
Closes #2438
2022-05-31 11:49:24 +02:00
Martin Hořeňovský
3a18a688a0
Mention CMake's integration with CATCH_CONFIG options
2022-05-21 13:04:09 +02:00
Martin Hořeňovský
605a34765a
v3.0.1
2022-05-17 22:13:36 +02:00
Martin Hořeňovský
5a49285e9c
Add --list-listeners option
2022-05-10 20:57:59 +02:00
Martin Hořeňovský
9dc229693d
Document the stability guarantees of '--order rand' option
2022-04-25 21:45:50 +02:00
Martin Hořeňovský
db57a4956f
Fixup ToC in command-line.md
2022-04-25 21:39:48 +02:00
Martin Hořeňovský
48177831ee
Add version placeholder to the example doc in contributing.md
2022-04-25 21:36:03 +02:00
Martin Hořeňovský
ee3bbecf51
Improve include guard docs in contributing.md
2022-04-25 21:33:05 +02:00
Martin Hořeňovský
431dcf36ea
Document Catch2's API/ABI stability policies
2022-04-25 18:58:50 +02:00
Martin Hořeňovský
e882cb8eb1
Document the new --skip-benchmarks flag
2022-04-25 18:36:40 +02:00
Daniel Feist
291b35b389
Added --skip-benchmarks command-line option. ( #2408 )
...
Closes #2392
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2022-04-23 23:14:49 +02:00
Martin Hořeňovský
73d8fb5bca
Update release-notes.md
2022-04-10 21:43:28 +02:00
Martin Hořeňovský
0a33405983
Mention Bazel support in release notes
2022-04-09 20:55:13 +02:00
Lukasz Okraszewski
cb551b4f6d
Add default reporter for Bazel integration ( #2399 )
...
When the added Bazel configuration flag is enabled,
a default JUnit reporter will be added if the XML
envrioment variable is defined.
Fix include paths for generated config header.
Enable Bazel config by default when building with
Bazel.
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
2022-04-08 18:01:59 +02:00
Martin Hořeňovský
46b3f7ee5f
Document magic %-prefixed streams
2022-04-07 12:50:18 +02:00
Martin Hořeňovský
f9f4e58dfb
Add missing version placeholder to --colour-mode cli option docs
2022-04-07 12:50:14 +02:00
