Comments and todo additions
diff --git a/src/python/oftest/controller.py b/src/python/oftest/controller.py
index 7f4196b..2b47d2a 100644
--- a/src/python/oftest/controller.py
+++ b/src/python/oftest/controller.py
@@ -426,6 +426,7 @@
return (None, None)
# Careful of race condition releasing sync before message cv
+ # Also, this style is ripe for a lockup.
self.expect_msg_cv.acquire()
self.sync.release()
self.expect_msg = True
diff --git a/src/python/oftest/oft_config.py b/src/python/oftest/oft_config.py
index 50077fe..ee3dfdc 100644
--- a/src/python/oftest/oft_config.py
+++ b/src/python/oftest/oft_config.py
@@ -154,6 +154,7 @@
@todo Allow file logging options, etc
@todo Add timestamps
+ @todo Consider using the native Python logging module
"""
if level >= cur_level:
@@ -169,7 +170,12 @@
@param string String to print if error
If condition is not true, it is considered a test framework
- failure and exit is called
+ failure and exit is called.
+
+ This assert is meant to represent a violation in the
+ assumptions of how the test framework is supposed to work
+ (for example, an inconsistent packet queue state) rather than
+ a test failure.
"""
if not condition:
debug_log("OFT", debug_level_default, DEBUG_CRITICAL,