From: Art Cancro <ajc@citadel.org>
Date: Wed, 9 Aug 2023 15:52:45 +0000 (-0400)
Subject: document private/public functions in berkeley_db.c
X-Git-Tag: v989~87
X-Git-Url: https://code.citadel.org/?a=commitdiff_plain;h=7d7ccb348c74126618344a3ed39ca526b1e513c9;p=citadel.git

document private/public functions in berkeley_db.c
---

diff --git a/citadel/server/backends/berkeley_db/berkeley_db.c b/citadel/server/backends/berkeley_db/berkeley_db.c
index b16c0e57d..67bcb0236 100644
--- a/citadel/server/backends/berkeley_db/berkeley_db.c
+++ b/citadel/server/backends/berkeley_db/berkeley_db.c
@@ -59,7 +59,7 @@ void bdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg) {
 }
 
 
-// wrapper for txn_abort() that logs/aborts on error
+// Wrapper for txn_abort() that logs/aborts on error.  Not part of the backend API.
 static void bdb_txabort(DB_TXN *tid) {
 	int ret;
 
@@ -72,7 +72,7 @@ static void bdb_txabort(DB_TXN *tid) {
 }
 
 
-// wrapper for txn_commit() that logs/aborts on error
+// Wrapper for txn_commit() that logs/aborts on error.  Not part of the backend API.
 static void bdb_txcommit(DB_TXN *tid) {
 	int ret;
 
@@ -85,7 +85,7 @@ static void bdb_txcommit(DB_TXN *tid) {
 }
 
 
-// wrapper for txn_begin() that logs/aborts on error
+// Wrapper for txn_begin() that logs/aborts on error.  Not part of the backend API.
 static void bdb_txbegin(DB_TXN **tid) {
 	int ret;
 
@@ -98,13 +98,14 @@ static void bdb_txbegin(DB_TXN **tid) {
 }
 
 
-// panic callback
+// Panic callback for Berkeley DB.  Not part of the backend API.
 static void bdb_dbpanic(DB_ENV *env, int errval) {
 	syslog(LOG_ERR, "bdb: PANIC: %s", db_strerror(errval));
 	bdb_abort();
 }
 
 
+// Close a cursor -- not part of the backend API.
 static void bdb_cclose(DBC *cursor) {
 	int ret;
 
@@ -115,6 +116,8 @@ static void bdb_cclose(DBC *cursor) {
 }
 
 
+// Convenience function to abort if a cursor is still open when we didn't expect it to be.
+// This is not part of the backend API.
 static void bdb_bailIfCursor(DBC **cursors, const char *msg) {
 	int i;