dbwrap: add a comment explaining the supported lock orders

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Stefan Metzmacher <metze@samba.org>

diff --git a/lib/dbwrap/dbwrap.h b/lib/dbwrap/dbwrap.h
index 81c4974afb6f7a048161285b73ce61ef6ec80df3..d289243f7a64a2f213be6800ab0fa607d36be200 100644 (file)
--- a/lib/dbwrap/dbwrap.h
+++ b/lib/dbwrap/dbwrap.h
@@ -27,6 +27,10 @@ struct db_context;
 
 enum dbwrap_lock_order {
        DBWRAP_LOCK_ORDER_NONE = 0, /* Don't check lock orders for this db. */
+       /*
+        * We only allow orders 1, 2, 3:
+        * These are the orders that CTDB currently supports.
+        */
        DBWRAP_LOCK_ORDER_1 = 1,
        DBWRAP_LOCK_ORDER_2 = 2,
        DBWRAP_LOCK_ORDER_3 = 3