aboutsummaryrefslogtreecommitdiff
path: root/src/wallet/walletdb.h
diff options
context:
space:
mode:
authorRussell Yanofsky <russ@yanofsky.org>2017-12-08 13:48:54 -0500
committerRussell Yanofsky <russ@yanofsky.org>2018-04-07 11:48:27 -0500
commit398c6f0f9d5ec788997f5574cc0ca9a8a7995950 (patch)
treea31b879c323e647e310f8e7aeff4808ab588164f /src/wallet/walletdb.h
parentea23945dbc6ad239c5acac374d2b54aa12870838 (diff)
downloadbitcoin-398c6f0f9d5ec788997f5574cc0ca9a8a7995950.tar.xz
Update walletdb comment after renaming.
Text from https://github.com/bitcoin/bitcoin/pull/11851#issuecomment-350320608 by John Newbery <john@johnnewbery.com>.
Diffstat (limited to 'src/wallet/walletdb.h')
-rw-r--r--src/wallet/walletdb.h17
1 files changed, 7 insertions, 10 deletions
diff --git a/src/wallet/walletdb.h b/src/wallet/walletdb.h
index 23a19ad1c8..fc61228be1 100644
--- a/src/wallet/walletdb.h
+++ b/src/wallet/walletdb.h
@@ -20,16 +20,13 @@
/**
* Overview of wallet database classes:
*
- * - BerkeleyEnvironment is an environment in which the database exists (has no analog in dbwrapper.h)
- * - WalletDatabase represents a wallet database (similar to CDBWrapper in dbwrapper.h)
- * - BerkeleyBatch is a low-level database transaction (similar to CDBBatch in dbwrapper.h)
- * - WalletBatch is a modifier object for the wallet, and encapsulates a database
- * transaction as well as methods to act on the database (no analog in
- * dbwrapper.h)
+ * - WalletBatch is an abstract modifier object for the wallet database, and encapsulates a database
+ * batch update as well as methods to act on the database. It should be agnostic to the database implementation.
*
- * The latter two are named confusingly, in contrast to what the names BerkeleyBatch
- * and WalletBatch suggest they are transient transaction objects and don't
- * represent the database itself.
+ * The following classes are implementation specific:
+ * - BerkeleyEnvironment is an environment in which the database exists.
+ * - BerkeleyDatabase represents a wallet database.
+ * - BerkeleyBatch is a low-level database batch update.
*/
static const bool DEFAULT_FLUSHWALLET = true;
@@ -137,7 +134,7 @@ public:
};
/** Access to the wallet database.
- * This should really be named CWalletDBBatch, as it represents a single transaction at the
+ * This represents a single transaction at the
* database. It will be committed when the object goes out of scope.
* Optionally (on by default) it will flush to disk as well.
*/