Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2017-06-05 17:19:42 +0200
committerMartin Hořeňovský2017-06-05 17:19:42 +0200
commit7f6773bb4d4bcdb7858e63f906e8a80e746bea7e (patch)
tree947fb02bfb2c860cffd6b08c29b461f17bf3c64d /docs
parentb459bb4c431670cb3031a68f4b3cf79f631d0c48 (diff)
parent3e018ef131878f32950d3622300e282c1c8a6594 (diff)
downloadcatch3-7f6773bb4d4bcdb7858e63f906e8a80e746bea7e.tar.gz
Merge branch 'master' into dev-modernize
Hopefully nothing went too wrong.
Diffstat (limited to 'docs')
-rw-r--r--docs/Readme.md2
-rw-r--r--docs/build-systems.md8
-rw-r--r--docs/commercial-users.md2
-rw-r--r--docs/event-listeners.md4
-rw-r--r--docs/logging.md28
-rw-r--r--docs/opensource-users.md2
-rw-r--r--docs/release-notes.md15
-rw-r--r--docs/release-process.md44
-rw-r--r--docs/test-cases-and-sections.md2
-rw-r--r--docs/tutorial.md2
10 files changed, 99 insertions, 10 deletions
diff --git a/docs/Readme.md b/docs/Readme.md
index e7e69080..36048ff8 100644
--- a/docs/Readme.md
+++ b/docs/Readme.md
@@ -17,7 +17,7 @@ Fine tuning:
Running:
* [Command line](command-line.md)
-* [Build systems](build-systems.md)
+* [CI and Build system integration](build-systems.md)
FAQ:
* [Why are my tests slow to compile?](slow-compiles.md)
diff --git a/docs/build-systems.md b/docs/build-systems.md
index 437bedc9..b9644e53 100644
--- a/docs/build-systems.md
+++ b/docs/build-systems.md
@@ -1,4 +1,4 @@
-# Integration with build systems
+# CI and build system integration
Build Systems may refer to low-level tools, like CMake, or larger systems that run on servers, like Jenkins or TeamCity. This page will talk about both.
@@ -134,6 +134,10 @@ TEST_CASE("Test3", "[a][b][c]") {
```
would be registered as 3 tests, `Test1`, `Test2` and `Test3`, and ctest 4 labels would be created, `a`, `b`, `c` and `unit`.
+### CodeCoverage module (GCOV, LCOV...)
+
+If you are using GCOV tool to get testing coverage of your code, and are not sure how to integrate it with CMake and Catch, there should be an external example over at https://github.com/fkromer/catch_cmake_coverage
+
---
-[Home](Readme.md) \ No newline at end of file
+[Home](Readme.md)
diff --git a/docs/commercial-users.md b/docs/commercial-users.md
index 1a7db9c4..424eb22c 100644
--- a/docs/commercial-users.md
+++ b/docs/commercial-users.md
@@ -13,4 +13,4 @@ fact then please let us know - either directly, via a PR or
- Bloomberg
- NASA
-
+ - [Inscopix Inc.](https://www.inscopix.com/)
diff --git a/docs/event-listeners.md b/docs/event-listeners.md
index 9ac5cc77..ab057444 100644
--- a/docs/event-listeners.md
+++ b/docs/event-listeners.md
@@ -31,7 +31,7 @@ struct MyListener : Catch::TestEventListenerBase {
// Perform some setup before a test case is run
}
- virtual void testCaseEnded( TestCaseStats const& testCaseStats ) override {
+ virtual void testCaseEnded( Catch::TestCaseStats const& testCaseStats ) override {
// Tear-down after a test case is run
}
};
@@ -70,4 +70,4 @@ just look in the source code to see what fields are available.
---
-[Home](Readme.md) \ No newline at end of file
+[Home](Readme.md)
diff --git a/docs/logging.md b/docs/logging.md
index 01c6fbc7..afbfd224 100644
--- a/docs/logging.md
+++ b/docs/logging.md
@@ -1,6 +1,32 @@
# Logging macros
-Additional messages can be logged during a test case.
+Additional messages can be logged during a test case. Note that the messages are scoped and thus will not be reported if failure occurs in scope preceding the message declaration. An example:
+
+```cpp
+TEST_CASE("Foo") {
+ INFO("Test case start");
+ for (int i = 0; i < 2; ++i) {
+ INFO("The number is " << i);
+ CHECK(i == 0);
+ }
+}
+
+TEST_CASE("Bar") {
+ INFO("Test case start");
+ for (int i = 0; i < 2; ++i) {
+ INFO("The number is " << i);
+ CHECK(i == i);
+ }
+ CHECK(false);
+}
+```
+When the `CHECK` fails in the "Foo" test case, then two messages will be printed.
+```
+Test case start
+The number is 1
+```
+When the last `CHECK` fails in the "Bar" test case, then only one message will be printed: `Test case start`.
+
## Streaming macros
diff --git a/docs/opensource-users.md b/docs/opensource-users.md
index 05a9a193..d4a96902 100644
--- a/docs/opensource-users.md
+++ b/docs/opensource-users.md
@@ -1,6 +1,6 @@
# Open Source projects using Catch
-Catch is great for open source. With it's [liberal license](../LICENSE_1_0.txt) and single-header, dependency-free, distribution
+Catch is great for open source. With it's [liberal license](../LICENSE.txt) and single-header, dependency-free, distribution
it's easy to just drop the header into your project and start writing tests - what's not to like?
As a result Catch is now being used in many Open Source projects, including some quite well known ones.
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 99445eb5..f98d8475 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1,3 +1,18 @@
+# 1.9.4
+
+### Fixes
+* `CATCH_FAIL` macro no longer causes compilation error without variadic macro support
+* `INFO` messages are no longer cleared after being reported once
+
+### Improvements and minor changes
+* Catch now uses `wmain` when compiled under Windows and `UNICODE` is defined.
+ * Note that Catch still officially supports only ASCII
+
+# 1.9.3
+
+### Fixes
+* Completed the fix for (lack of) uint64_t in earlier Visual Studios
+
# 1.9.2
### Improvements and minor changes
diff --git a/docs/release-process.md b/docs/release-process.md
new file mode 100644
index 00000000..a82c82cc
--- /dev/null
+++ b/docs/release-process.md
@@ -0,0 +1,44 @@
+# How to release
+
+When enough changes have accumulated, it is time to release new version of Catch. This document describes the proces in doing so, that no steps are forgotten. Note that all referenced scripts can be found in the `scripts/` directory.
+
+
+## Approval testing
+
+Catch's releases are primarily validated against output from previous release, stored in `projects/SelfTest/Baselines`. To validate current sources, build the SelfTest binary and pass it to the `approvalTests.py` script: `approvalTests.py <path/to/SelfTest>`.
+
+There should be no differences, as Approval tests should be updated when changes to Catch are made, but if there are, then they need to be manually reviewed and either approved (using `approve.py`) or Catch requires other fixes.
+
+
+## Incrementing version number
+
+Catch uses a variant of [semantic versioning](http://semver.org/), with breaking API changes (and thus major version increments) being very rare. Thus, the release will usually increment the patch version, when it only contains couple of bugfixes, or minor version, when it contains new functionality, or larger changes in implementation of current functionality.
+
+After deciding which part of version number should be incremented, you can use one of the `*Release.py` scripts to perform the required changes to Catch.
+
+
+## Generate updated single-include header
+
+After updating version number, regenerate single-include header using `generateSingleHeader.py`.
+
+
+## Release notes
+
+Once a release is ready, release notes need to be written. They should summarize changes done since last release. For rough idea of expected notes see previous releases. Once written, release notes should be placed in `docs/release-notes.md`.
+
+
+## Commit and push update to GitHub
+
+After version number is incremented, single-include header is regenerated and release notes are updated, changes should be commited and pushed to GitHub.
+
+
+## Release on GitHub
+
+After pushing changes to GitHub, GitHub release *needs* to be created. Tag version and release title should be same as the new version, description should contain the release notes for the current release. Single header version of `catch.hpp` *needs* to be attached as a binary, as that is where the official download link links to. Preferably it should use linux line endings.
+
+
+## vcpkg update
+
+As a last step, optionally update Microsoft's package manager [vcpkg](https://github.com/Microsoft/vcpkg) with Catch's new version. `updateVcpkgPackage.py` can do a lot of neccessary work for you, but it assumes that you have your fork of vcpkg checked out in a directory next to the directory, where you have checked out Catch.
+
+It creates a branch and commits neccessary changes, that you then should review, synchronize and open a PR against.
diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md
index 2a14e86e..4e53c35c 100644
--- a/docs/test-cases-and-sections.md
+++ b/docs/test-cases-and-sections.md
@@ -28,7 +28,7 @@ The tag expression, ```"[widget]"``` selects A, B & D. ```"[gadget]"``` selects
For more detail on command line selection see [the command line docs](command-line.md#specifying-which-tests-to-run)
-Tag names are not case sensitive.
+Tag names are not case sensitive and can contain any ASCII characters. This means that tags `[tag with spaces]` and `[I said "good day"]` are both allowed tags and can be filtered on. Escapes are not supported however and `[\]]` is not a valid tag.
### Special Tags
diff --git a/docs/tutorial.md b/docs/tutorial.md
index 73924592..3a0f9468 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -68,7 +68,7 @@ with expansion:
0 == 1
```
-Note that we get the actual return value of Factorial(0) printed for us (0) - even though we used a natural expression with the == operator. That let's us immediately see what the problem is.
+Note that we get the actual return value of Factorial(0) printed for us (0) - even though we used a natural expression with the == operator. That lets us immediately see what the problem is.
Let's change the factorial function to: