3rd-party/Unity
1
0
Fork 0
mirror of https://github.com/ThrowTheSwitch/Unity.git synced 2026-01-29 19:24:27 +01:00
Code Issues Releases Wiki Activity

Implement an -h/--help flag for Unity Fixtures and add documentation

Browse Source
This commit is contained in:
Lino Mastrodomenico
2019-12-09 00:25:28 +00:00
parent e3132cdddd
commit 5c5773720f
2 changed files with 48 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
extras/fixture/readme.md
View File

@@ -15,3 +15,15 @@ Fixtures, by default, uses the Memory addon as well. This is to make it simple f
follow along with James' book. Using them together is completely optional. You may choose to use
Fixtures without Memory handling by defining `UNITY_FIXTURE_NO_EXTRAS`. It will then stop automatically
pulling in extras and leave you to do it as desired.
# Usage information
By default the test executables produced by Unity Fixtures run all tests once, but the behavior can
be configured with command-line flags. Run the test executable with the `--help` flag for more
information.
It's possible to add a custom line at the end of the help message, typically to point to
project-specific or company-specific unit test documentation. Define `UNITY_CUSTOM_HELP_MSG` to
provide a custom message, e.g.:
#define UNITY_CUSTOM_HELP_MSG "If any test fails see https://example.com/troubleshooting"