idmap_autorid: add a comment explaining idmap_autorid_saveconfig()

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

diff --git a/source3/include/idmap_autorid.h b/source3/include/idmap_autorid.h
index 9c319c0e2b709876322870e7ef694c0123773bf8..d0e1cef4a51d994d6558b30842d522f1263ea068 100644 (file)
--- a/source3/include/idmap_autorid.h
+++ b/source3/include/idmap_autorid.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);