idmap_autorid: add a comment explaining idmap_autorid_saveconfig()

[mat/samba.git] / source3 / include / idmap_autorid_tdb.h

diff --git a/source3/include/idmap_autorid_tdb.h b/source3/include/idmap_autorid_tdb.h
index 8f7219e27b67ce0104b8fe64b4ca620bfee334ab..4e9b464f6a9b6f41624b9daf9759771be509449d 100644 (file)
--- a/source3/include/idmap_autorid_tdb.h
+++ b/source3/include/idmap_autorid_tdb.h
@@ -104,6 +104,13 @@ NTSTATUS idmap_autorid_loadconfig(struct db_context *db,
                                  TALLOC_CTX *ctx,
                                  struct autorid_global_config **result);
 
+/**
+ * Save the global autorid configuration into the autorid database.
+ * The stored configuration consists of:
+ * - the low value of the idmap range
+ * - the rangesize
+ * - the maximum number of ranges
+ */
 NTSTATUS idmap_autorid_saveconfig(struct db_context *db,
                                  struct autorid_global_config *cfg);