Update walletdb comment after renaming.

Text from https://github.com/bitcoin/bitcoin/pull/11851#issuecomment-350320608
by John Newbery <john@johnnewbery.com>.
This commit is contained in:
Russell Yanofsky 2017-12-08 13:48:54 -05:00
parent ea23945dbc
commit 398c6f0f9d

View File

@ -20,16 +20,13 @@
/** /**
* Overview of wallet database classes: * Overview of wallet database classes:
* *
* - BerkeleyEnvironment is an environment in which the database exists (has no analog in dbwrapper.h) * - WalletBatch is an abstract modifier object for the wallet database, and encapsulates a database
* - WalletDatabase represents a wallet database (similar to CDBWrapper in dbwrapper.h) * batch update as well as methods to act on the database. It should be agnostic to the database implementation.
* - 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)
* *
* The latter two are named confusingly, in contrast to what the names BerkeleyBatch * The following classes are implementation specific:
* and WalletBatch suggest they are transient transaction objects and don't * - BerkeleyEnvironment is an environment in which the database exists.
* represent the database itself. * - BerkeleyDatabase represents a wallet database.
* - BerkeleyBatch is a low-level database batch update.
*/ */
static const bool DEFAULT_FLUSHWALLET = true; static const bool DEFAULT_FLUSHWALLET = true;
@ -137,7 +134,7 @@ public:
}; };
/** Access to the wallet database. /** 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. * database. It will be committed when the object goes out of scope.
* Optionally (on by default) it will flush to disk as well. * Optionally (on by default) it will flush to disk as well.
*/ */