Merge pull request #751 from skliper/fix577-nested_add

Fix #577, Document nested tests not supported
nasa · Jan 21, 2021 · 86b13a2 · 86b13a2
2 parents 709b582 + 62eb12d
commit 86b13a2
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ut_assert/inc/uttest.h b/ut_assert/inc/uttest.h
@@ -43,6 +43,11 @@
  *
  * Called by the user to register a new test case with the library.
  *
+ * Note: Nested addition of tests is not supported.  Calling
+ *       UtTest_Add from within a test function added using UtTest_Add
+ *       will not cause the nested test to execute, and will be
+ *       silently ignored.
+ *
  * \param Test     Main test function to call.
  * \param Setup    Setup function, called before the test function
  * \param Teardown Cleanup function, called after the test function