summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrédéric Jouault <f.jouault@gmail.com>2021-05-08 20:43:18 +0200
committerAndreas Schneider <asn@cryptomilk.org>2023-02-16 15:29:43 +0100
commita47b3da765e07ef7d3ac853c57e67dd45ac0aff4 (patch)
tree7046cc8752c9ec217b3c62cf7c4d9463f6999580
parent61b1fb97fb9de87609102bcdafcc0018972199fe (diff)
downloadcmocka-a47b3da765e07ef7d3ac853c57e67dd45ac0aff4.zip
cmocka-a47b3da765e07ef7d3ac853c57e67dd45ac0aff4.tar.gz
cmocka-a47b3da765e07ef7d3ac853c57e67dd45ac0aff4.tar.bz2
include: Improved call ordering documentation
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
-rw-r--r--include/cmocka.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/cmocka.h b/include/cmocka.h
index 8dfad97..c894efd 100644
--- a/include/cmocka.h
+++ b/include/cmocka.h
@@ -1534,7 +1534,10 @@ void assert_not_in_set(LargestIntegralType value, LargestIntegralType values[],
* created (e.g. expect_function_call()) than consumed with function_called().
* There are provisions such as ignore_function_calls() which allow this
* restriction to be circumvented in tests where mock calls for the code under
- * test are not the focus of the test.
+ * test are not the focus of the test. function_called() must be called from
+ * the same thread as expect_function_call(), and that thread must have been
+ * initialized for use by cmocka (see also the [Threading section of the main
+ * documentation page](index.html#main-threads)).
*
* The following example illustrates how a unit test instructs cmocka
* to expect a function_called() from a particular mock,