stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doc: Added note regarding abort in hooks. Addresses partially #163

Browse source
This commit is contained in:
Snaipe 2016-09-17 12:30:23 +02:00
parent bf23bb82de
commit e9ef474878
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/hooks.rst
View file

@ -17,9 +17,17 @@ A report hook can be declared using the ``ReportHook`` macro:
The macro takes a Phase parameter that indicates the phase at which the function
shall be run. Valid phases are described below.
**Note**: there are no guarantees regarding the order of execution of report hooks
on the same phase. In other words, all report hooks of a specific phase could
be executed in any order.
.. note::
There are no guarantees regarding the order of execution of report hooks
on the same phase. In other words, all report hooks of a specific phase could
be executed in any order.
.. note::
Aborting the runner with any means (abort(), exit(), cr_assert(), ...) is
unsupported. If you need to abort the runner, you need to iterate all
subsequent tests and set their `disabled` field to 1.
Testing Phases
--------------