Add FAQ page to the documentation

This commit is contained in:
Martin Hořeňovský 2021-11-19 15:23:50 +01:00
parent 726fdd7f8e
commit acdb85c398
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
2 changed files with 28 additions and 2 deletions

View File

@ -25,10 +25,9 @@ Running:
* [Command line](command-line.md#top) * [Command line](command-line.md#top)
Odds and ends: Odds and ends:
* [Frequently Asked Questions (FAQ)](faq.md#top)
* [CMake integration](cmake-integration.md#top) * [CMake integration](cmake-integration.md#top)
* [CI and other miscellaneous pieces](ci-and-misc.md#top) * [CI and other miscellaneous pieces](ci-and-misc.md#top)
FAQ:
* [Known limitations](limitations.md#top) * [Known limitations](limitations.md#top)
Other: Other:

27
docs/faq.md Normal file
View File

@ -0,0 +1,27 @@
<a id="top"></a>
# Frequently Asked Questions (FAQ)
## How do I run global setup/teardown only if tests will be run?
Write a custom [event listener](event-listeners.md#top) and place the
global setup/teardown code into the `testRun*` events.
## How do I clean up global state between running different tests?
Write a custom [event listener](event-listeners.md#top) and place the
cleanup code into either `testCase*` or `testCasePartial*` events,
depending on how often the cleanup needs to happen.
## Why cannot I derive from the built-in reporters?
They are not made to be overriden, in that we do not attempt to maintain
a consistent internal state if a member function is overriden, and by
forbidding users from using them as a base class, we can refactor them
as needed later.
---
[Home](Readme.md#top)