Rename myself

[bertos.git] / bertos / cfg / test.h

diff --git a/bertos/cfg/test.h b/bertos/cfg/test.h
index b73ae5459b6a01d4da2dcc3d875c44228ea918b7..5540d105f062276f8f47a6633425ca22244f4ea1 100644 (file)
--- a/bertos/cfg/test.h
+++ b/bertos/cfg/test.h
@@ -41,12 +41,17 @@
 #define CFG_TEST_H
 
 /**
- * Silent an assert in test suite.
- * This is use when we do a test suite and we want test 
- * the error condition, so we now that an assert condition is false
- * but is not a really error. To ignore this error we mark it
- * with this macro, where str is a messge string of the assert
+ * Silent an assert in a test.
+ * This is useful when we run a test and we want to test
+ * an error condition. We know that an assert will fail but
+ * this is not really an error. To ignore that we mark it
+ * with this macro, where str is the message string of the assert
  * that we want to drop.
+ * To use this macro copy the assert log message, and paste as argument
+ * of this macro. In assert message log is report also the number line
+ * of the code that have generate the assert in this way you can trap
+ * only the select assert message.
+ *
  */
 #define SILENT_ASSERT(str) \
                kputs("SILENT_ASSERT:$"str"$\n")