Add comment concern appropriate use of LDAP_MEMORY_DEBUG

(basically, it's for testing internals, don't enable it otherwise)

diff --git a/libraries/liblber/memory.c b/libraries/liblber/memory.c
index 334ee9acfe32f4e7ccc4c9c5db1848ae9ca78358..5f42c5d5c80608b4558e8cf1d5ec330e28502383 100644 (file)
--- a/libraries/liblber/memory.c
+++ b/libraries/liblber/memory.c
@@ -11,6 +11,17 @@
 #include "lber-int.h"
 
 #if LDAP_MEMORY_DEBUG
+/*
+ * LDAP_MEMORY_DEBUG should only be enabled for the purposes of
+ * debugging memory management within OpenLDAP libraries and slapd.
+ * It should only be enabled by an experienced developer as it
+ * causes the inclusion of numerous assert()'s, many of which may
+ * be triggered by a prefectly valid program.
+ *
+ * The code behind this macro is subject to change as needed to
+ * support this testing.
+ */
+
 struct ber_mem_hdr {
        union bmu_align_u {
                ber_len_t       bmu_len_t;
@@ -34,6 +45,7 @@ static const struct ber_mem_hdr ber_int_mem_hdr = { BER_MEM_JUNK };
                assert( (p) != BER_MEM_BADADDR );       \
                assert( (p) != (void *) &ber_int_mem_hdr );     \
        } while(0)
+
 #else
 #define BER_MEM_VALID(p)       /* no-op */
 #endif