aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/ct_hooks_chapter.xml
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2012-08-29 15:12:51 +0200
committerLukas Larsson <[email protected]>2012-08-30 15:37:31 +0200
commitc0ef28d5eecffc56b72a281a6d73f5ad1504bf0a (patch)
treefa8140061d4932a55a96ec5166f07c11930689d2 /lib/common_test/doc/src/ct_hooks_chapter.xml
parent92ecb763b778617af7211c6c062c1b41489bf49c (diff)
downloadotp-c0ef28d5eecffc56b72a281a6d73f5ad1504bf0a.tar.gz
otp-c0ef28d5eecffc56b72a281a6d73f5ad1504bf0a.tar.bz2
otp-c0ef28d5eecffc56b72a281a6d73f5ad1504bf0a.zip
Document that CTHs can get fail/skip as Config
OTP-10077
Diffstat (limited to 'lib/common_test/doc/src/ct_hooks_chapter.xml')
-rw-r--r--lib/common_test/doc/src/ct_hooks_chapter.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml
index c938851e0e..86237f5fc1 100644
--- a/lib/common_test/doc/src/ct_hooks_chapter.xml
+++ b/lib/common_test/doc/src/ct_hooks_chapter.xml
@@ -252,6 +252,13 @@
{ok, Handle} -&gt;
{[{db_handle, Handle} | Config], CTHState#state{ handle = Handle }}
end.</code>
+ <note>If using multiple CTHs, the first part of the return tuple will be
+ used as input for the next CTH. So in the case above the next CTH might
+ get <c>{fail,Reason}</c> as the second parameter. If you have many CTHs
+ which interact, it might be a good idea to not let each CTH return
+ <c>fail</c> or <c>skip</c>. Instead return that an action should be taken
+ through the <c>Config</c> list and implement a CTH which at the end takes
+ the correct action. </note>
</section>