summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.Coding10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.Coding b/README.Coding
index 8416290861..956a733a4c 100644
--- a/README.Coding
+++ b/README.Coding
@@ -367,3 +367,13 @@ Bad Example:
ret = some_function_my_name(get_some_name());
...
+Control-Flow changing macros
+----------------------------
+
+Macros like NT_STATUS_NOT_OK_RETURN that change control flow
+(return/goto/etc) from within the macro are considered bad, because
+they look like function calls that never change control flow. Please
+do not use them in new code.
+
+The only exception is the test code that depends repeated use of calls
+like CHECK_STATUS, CHECK_VAL and others.