Merge pull request #2575 from rbricheno/cyrusdb-sync-docs

Update documentation of cyrusdb_sync function
cyrusimap · Nov 2, 2018 · 31a82f8 · 31a82f8
2 parents 10c4a76 + 5224ddb
commit 31a82f8
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/doc/internal/cyrusdb-api.html b/doc/internal/cyrusdb-api.html
@@ -127,8 +127,9 @@ <h3>cyrusdb_done(void)</h3>
 
 <h3>cyrusdb_sync(const char *backend)</h3>
 
-<p>Perform a checkpoint of the database environment.  Used by berkeley
-backend.  Is called by <tt>ctl_cyrusdb -c</tt> on a regular basis</p>
+<p>Perform a checkpoint of the database environment. Our current database
+backends do not require this, and implement it as a no-op. Is called by
+<tt>ctl_cyrusdb -c</tt> on a regular basis</p>
 
 <!-- XXX update this bit to document the cyrusdb_archiver api
 <h3>archive(const char **fnames, const char *dirname)</h3>