From acdb85c398077a4505fd425a06f7c99f15c7a6d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Fri, 19 Nov 2021 15:23:50 +0100 Subject: [PATCH] Add FAQ page to the documentation --- docs/Readme.md | 3 +-- docs/faq.md | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 docs/faq.md diff --git a/docs/Readme.md b/docs/Readme.md index 262edb5c..dc1eccb9 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -25,10 +25,9 @@ Running: * [Command line](command-line.md#top) Odds and ends: +* [Frequently Asked Questions (FAQ)](faq.md#top) * [CMake integration](cmake-integration.md#top) * [CI and other miscellaneous pieces](ci-and-misc.md#top) - -FAQ: * [Known limitations](limitations.md#top) Other: diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 00000000..a268802d --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,27 @@ + +# 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)