idmap_autorid: add a comment explaining idmap_autorid_db_init()

Signed-off-by: Michael Adam <obnox@samba.org>

diff --git a/source3/include/idmap_autorid.h b/source3/include/idmap_autorid.h
index bf96d765d1579b5c508cba5c1ef353f1d3fd800e..16096573df4e0a2589e0ceeb510d1689d3e3cfbd 100644 (file)
--- a/source3/include/idmap_autorid.h
+++ b/source3/include/idmap_autorid.h
@@ -87,6 +87,12 @@ NTSTATUS idmap_autorid_setrange(struct db_context *db,
  */
 NTSTATUS idmap_autorid_init_hwm(struct db_context *db, const char *hwm);
 
+/**
+ * Initialize an idmap_autorid database.
+ * After this function has successfully completed, the following are true:
+ * - the database exists
+ * - the requred HWM keys exist (range, alloc-uid, alloc-gid)
+ */
 NTSTATUS idmap_autorid_db_init(const char *path,
                               TALLOC_CTX *mem_ctx,
                               struct db_context **db);