libcli: Add warning about flow control changing macros in ntstatus.h

Change-Id: I49fec82e55b6bc59d5c0f157df90005f7d891c66
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Andreas Schneider <asn@samba.org>

diff --git a/libcli/util/ntstatus.h b/libcli/util/ntstatus.h
index 22be74a2f1f9c9ba6a8cf065516c18b938da806d..5407da0b73d4fa8ac8c67f0c37006bdc93a8011c 100644 (file)
--- a/libcli/util/ntstatus.h
+++ b/libcli/util/ntstatus.h
@@ -674,6 +674,14 @@ NTSTATUS nt_status_string_to_code(const char *nt_status_str);
 #define NT_STATUS_IS_ERR(x) (unlikely((NT_STATUS_V(x) & 0xc0000000) == 0xc0000000))
 #define NT_STATUS_EQUAL(x,y) (NT_STATUS_V(x) == NT_STATUS_V(y))
 
+/*
+ * These macros (with the embedded return) are considered poor coding
+ * style per README.Coding
+ *
+ * Please do not use them in new code, and do not rely on them in
+ * projects external to Samba as they will go away at some point.
+ */
+
 #define NT_STATUS_HAVE_NO_MEMORY(x) do { \
        if (unlikely(!(x))) {           \
                return NT_STATUS_NO_MEMORY;\