espressif/Unity
1
0
Fork 0
mirror of https://github.com/ThrowTheSwitch/Unity.git synced 2025-10-19 13:23:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
John Lindgren
2017-09-13 18:24:07 -04:00
parent 2593c31bb7
commit 1381a1a4cb
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/UnityHelperScriptsGuide.md
View File

@ -124,7 +124,7 @@ demonstrates using a Ruby hash.
##### `:includes` ##### `:includes`
This option specifies an array of file names to be ?#include?'d at the top of This option specifies an array of file names to be `#include`'d at the top of
your runner C file. You might use it to reference custom types or anything else your runner C file. You might use it to reference custom types or anything else
universally needed in your generated runners. universally needed in your generated runners.
@ -133,11 +133,23 @@ universally needed in your generated runners.
Define this option with C code to be executed _before any_ test cases are run. Define this option with C code to be executed _before any_ test cases are run.
Alternatively, if your C compiler supports weak symbols, you can leave this
option unset and instead provide a `void suiteSetUp(void)` function in your test
suite. The linker will look for this symbol and fall back to a Unity-provided
stub if it is not found.
##### `:suite_teardown` ##### `:suite_teardown`
Define this option with C code to be executed ?after all?test cases have Define this option with C code to be executed _after all_ test cases have
finished. finished. An integer variable `num_failures` is available for diagnostics.
The code should end with a `return` statement; the value returned will become
the exit code of `main`. You can normally just return `num_failures`.
Alternatively, if your C compiler supports weak symbols, you can leave this
option unset and instead provide a `int suiteTearDown(int num_failures)`
function in your test suite. The linker will look for this symbol and fall
back to a Unity-provided stub if it is not found.
##### `:enforce_strict_ordering` ##### `:enforce_strict_ordering`