Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Large collection of typos, grammar fixes, and proper capitalization #2247

Merged
merged 6 commits into from
Aug 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
- mining, rpc: Implement staking efficiency measure and improve SelectCoinsForStaking and CreateCoinStake #1992 (@jamescowens)
- accrual, rpc: Implement auditsnapshotaccruals #2001 (@jamescowens)
- docs: add doxygen support #2000 (@div72)
- beacon: Specialized beacon storage in leveldb #2009 (@jamescowens)
- beacon: Specialized beacon storage in LevelDB #2009 (@jamescowens)
- rpc: Add a call to dump contracts in binary form #2011 (@div72)
- rpc: Add boolean option to report active beacons only in beaconreport #2013 (@jamescowens)
- consensus: Set Hilda mainnet hardfork height to 2197000 #2022 (@jamescowens)
Expand Down Expand Up @@ -564,7 +564,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
- Add freedesktop.org desktop file and icon set #1438 (@a123b).

### Changed
- Disable Qt for windows Travis builds #1276 (@TheCharlatan).
- Disable Qt for Windows Travis builds #1276 (@TheCharlatan).
- Replace use of AppCache PROJECT section with strongly-typed structures #1415
(@cyrossignol).
- Change dumpwallet to use appropriate data directory #1416 (@jamescowens).
Expand Down Expand Up @@ -719,7 +719,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
- investor cpid's appearing as zeros in block index (@tomasbrod)
- ensure that daemon functionality is correct when built together with gui wallet (@jamescowens)
- improve logging, remove empty lines (@jamescowens) (@Foggyx420) (@tomasbrod) (@denravonska)
- windows socket warnings (@thecharlatan)
- Windows socket warnings (@thecharlatan)

### Removed
- unused components of neural network (@Foggyx420)
Expand Down Expand Up @@ -988,7 +988,7 @@ Internal test version used to sort out the forks.
### Removed
- Remove RPC commands:
- DAO #486 (@denravonska).
- volatilecode, testnet0917, testboinckey, chainrsa, testcpidv2, testcpid, windows
- volatilecode, testnet0917, testboinckey, chainrsa, testcpidv2, testcpid, Windows
error report disabling, list betatest, fDebug4/fDebug5 flags (@Foggyx420).
- Set magnitude boost to be removed at 2017-Sep-07 00:00:00 UTC

Expand Down
8 changes: 4 additions & 4 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -961,10 +961,10 @@ fi

fi

PKG_CHECK_MODULES([SSL], [libssl],, [AC_MSG_ERROR(openssl not found.)])
PKG_CHECK_MODULES([CRYPTO], [libcrypto],,[AC_MSG_ERROR(libcrypto not found.)])
PKG_CHECK_MODULES([LIBZIP], [libzip],,[AC_MSG_ERROR(libzip not found.)])
PKG_CHECK_MODULES([CURL], [libcurl],,[AC_MSG_ERROR(libcurl not found.)])
PKG_CHECK_MODULES([SSL], [libssl],, [AC_MSG_ERROR(openssl not found.)])
PKG_CHECK_MODULES([CRYPTO], [libcrypto],,[AC_MSG_ERROR(libcrypto not found.)])
PKG_CHECK_MODULES([LIBZIP], [libzip],,[AC_MSG_ERROR(libzip not found.)])
PKG_CHECK_MODULES([CURL], [libcurl],,[AC_MSG_ERROR(libcurl not found.)])

if test x$use_qr != xno; then
BITCOIN_QT_CHECK([PKG_CHECK_MODULES([QR], [libqrencode], [have_qrencode=yes], [have_qrencode=no])])
Expand Down
2 changes: 1 addition & 1 deletion contrib/gitian-build.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env bash
# Copyright (c) 2016 The gridcoin Core developers
# Copyright (c) 2016 The Gridcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.

Expand Down
4 changes: 2 additions & 2 deletions contrib/rpcstresstest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ rpc_stress_test.sh is a bash script that runs rpc commands against the Gridcoin

The usage is rpc_stress_test.sh <gridcoindaemon> <command_file> <rpc_test_output_log> <debug_log> <iterations> <sleep_time> <maximum_parallelism> <random>

<gridcoindaemon> : The name of the gridcoin daemon executable. This will typically be gridcoindaemon.
<gridcoindaemon> : The name of the Gridcoin daemon executable. This will typically be gridcoindaemon.
<command_file> : The name of the file that contains the commands that will be executed as part of the test. You may use # in front of a command to "comment it out" which allows you to conveniently turn off a command. Note that the script uses eval to execute the command, so some script variables can be used in the commands.
<rpc_test_output_log> : The name of the file that will contain the command outputs.
<debug.log> : The name of the gridcoin debug log (usually debug.log), to integrate the rpc timings into the main log to provide an integrated picture.
<debug.log> : The name of the Gridcoin debug log (usually debug.log), to integrate the rpc timings into the main log to provide an integrated picture.
<iterations> : The number of commands desired to be run during the test.
<sleep_time> : The amount of seconds (in decimal form) to wait from one command invocation to the next.
<maximum_parallelism> : The maximum number of commands that will be allowed to be in flight at any one time. This is to prevent a runaway situation with a pileup of many commands in case some of them become unresponsive, which could happen in a stress testing scenario.
Expand Down
4 changes: 2 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Gridcoin
Setup
---------------------
Gridcoin is a free open source project derived from Bitcoin, with
the goal of providing a long-term energy-efficient crypto-currency, rewarding BOINC work.
the goal of providing a long-term energy-efficient cryptocurrency, rewarding BOINC work.
Built on the foundation of Bitcoin, PPCoin and NovaCoin, innovations such as proof-of-stake
help further advance the field of crypto-currency. The Gridcoin Client downloads and, by default, stores the entire history of Gridcoin transactions; depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
help further advance the field of cryptocurrency. The Gridcoin Client downloads and, by default, stores the entire history of Gridcoin transactions; depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Gridcoin, visit [gridcoin.us](https://gridcoin.us).

Expand Down
2 changes: 1 addition & 1 deletion doc/build-unix.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Some notes on how to build Gridcoin in Unix.

Note
---------------------
Always use absolute paths to configure and compile gridcoin and the dependencies,
Always use absolute paths to configure and compile Gridcoin and the dependencies,
for example, when specifying the path of the dependency:

../dist/configure --enable-cxx --disable-shared --with-pic --prefix=$BDB_PREFIX
Expand Down
2 changes: 1 addition & 1 deletion doc/readme-qt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Build configuration options
UPNnP port forwarding
---------------------

To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable gridcoin experience), pass the following argument to qmake:
To use UPnP for port forwarding behind a NAT router (recommended, as more connections overall allow for a faster and more stable Gridcoin experience), pass the following argument to qmake:

::

Expand Down
4 changes: 2 additions & 2 deletions doc/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Build output expected:

1. source tarball (`gridcoin-${VERSION}.tar.gz`)
2. linux 32-bit and 64-bit dist tarballs (`gridcoin-${VERSION}-linux[32|64].tar.gz`)
3. windows 32-bit and 64-bit unsigned installers and dist zips (`gridcoin-${VERSION}-win[32|64]-setup-unsigned.exe`, `gridcoin-${VERSION}-win[32|64].zip`)
3. Windows 32-bit and 64-bit unsigned installers and dist zips (`gridcoin-${VERSION}-win[32|64]-setup-unsigned.exe`, `gridcoin-${VERSION}-win[32|64].zip`)
4. OS X unsigned installer and dist tarball (`gridcoin-${VERSION}-osx-unsigned.dmg`, `gridcoin-${VERSION}-osx64.tar.gz`)
5. Gitian signatures (in `gitian.sigs/${VERSION}-<linux|{win,osx}-unsigned>/(your Gitian key)/`)

Expand Down Expand Up @@ -155,7 +155,7 @@ Codesigner only: Sign the osx binary:
Enter the keychain password and authorize the signature
Move signature-osx.tar.gz back to the gitian host

Codesigner only: Sign the windows binaries:
Codesigner only: Sign the Windows binaries:

tar xf gridcoin-win-unsigned.tar.gz
./detached-sig-create.sh -key /path/to/codesign.key
Expand Down
2 changes: 1 addition & 1 deletion src/addrman.h
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ class CAddrInfo : public CAddress
//
// To that end:
// * Addresses are organized into buckets.
// * Address that have not yet been tried go into 256 "new" buckets.
// * Addresses that have not yet been tried go into 256 "new" buckets.
// * Based on the address range (/16 for IPv4) of source of the information, 32 buckets are selected at random
// * The actual bucket is chosen from one of these, based on the range the address itself is located.
// * One single address can occur in up to 4 different buckets, to increase selection chances for addresses that
Expand Down
50 changes: 25 additions & 25 deletions src/gridcoin/beacon.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ bool BeaconRegistry::ContainsActive(const Cpid& cpid) const

//!
//! \brief This resets the in-memory maps of the registry. It does NOT
//! clear the leveldb storage.
//! clear the LevelDB storage.
//!
void BeaconRegistry::Reset()
{
Expand Down Expand Up @@ -391,7 +391,7 @@ bool BeaconRegistry::TryRenewal(Beacon_ptr& current_beacon_ptr, int& height, con

void BeaconRegistry::Add(const ContractContext& ctx)
{
// Poor man's mock. This is to prevent the tests from polluting the leveldb database
// Poor man's mock. This is to prevent the tests from polluting the LevelDB database
int height = -1;

if (ctx.m_pindex)
Expand Down Expand Up @@ -485,7 +485,7 @@ void BeaconRegistry::Add(const ContractContext& ctx)

void BeaconRegistry::Delete(const ContractContext& ctx)
{
// Poor man's mock. This is to prevent the tests from polluting the leveldb database
// Poor man's mock. This is to prevent the tests from polluting the LevelDB database
int height = -1;

if (ctx.m_pindex)
Expand Down Expand Up @@ -646,7 +646,7 @@ void BeaconRegistry::Revert(const ContractContext& ctx)
m_beacons.erase(iter);

// Get an iterator from the beacon db (either in the historical table, or
// will be loaded from leveldb and put in the historical table.
// will be loaded from LevelDB and put in the historical table.
auto resurrect_iter = m_beacon_db.find(resurrect_hash);

if (resurrect_iter != m_beacon_db.end())
Expand Down Expand Up @@ -945,7 +945,7 @@ void BeaconRegistry::Deactivate(const uint256 superblock_hash)
// Erase the entry from the active beacons map. This also increments the iterator.
iter = m_beacons.erase(iter);

// Erase the entry from the db. This removes the record from the underlying historical map and also leveldb.
// Erase the entry from the db. This removes the record from the underlying historical map and also LevelDB.
// We do not need to retain this record because it is a reversion. The hash to use is the activation_hash,
// because that was matched above.
m_beacon_db.erase(activation_hash);
Expand Down Expand Up @@ -1028,7 +1028,7 @@ int BeaconRegistry::BeaconDB::Initialize(PendingBeaconMap& m_pending, BeaconMap&
uint32_t version = 0;
bool needs_IsContract_correction = false;

// First load the beacon db version from leveldb and check it against the constant in the class.
// First load the beacon db version from LevelDB and check it against the constant in the class.
{
CTxDB txdb("r");

Expand All @@ -1041,8 +1041,8 @@ int BeaconRegistry::BeaconDB::Initialize(PendingBeaconMap& m_pending, BeaconMap&

if (version != CURRENT_VERSION)
{
LogPrint(LogFlags::BEACON, "WARNING: %s: Version level of the beacon db stored in leveldb, %u, does not "
"match that required in this code level, version %u. Clearing the leveldb beacon "
LogPrint(LogFlags::BEACON, "WARNING: %s: Version level of the beacon db stored in LevelDB, %u, does not "
"match that required in this code level, version %u. Clearing the LevelDB beacon "
"storage and setting version level to match this code level.",
__func__,
version,
Expand All @@ -1060,31 +1060,31 @@ int BeaconRegistry::BeaconDB::Initialize(PendingBeaconMap& m_pending, BeaconMap&

clear_leveldb();

// After clearing the leveldb state, set the needs IsContract correction to the proper state. If the version that
// After clearing the LevelDB state, set the needs IsContract correction to the proper state. If the version that
// was on disk was 1, then this will be set to true.
SetNeedsIsContractCorrection(needs_IsContract_correction);

LogPrint(LogFlags::BEACON, "INFO: %s: Leveldb beacon area cleared. Version level set to %u.",
LogPrint(LogFlags::BEACON, "INFO: %s: LevelDB beacon area cleared. Version level set to %u.",
__func__,
CURRENT_VERSION);
}


// If LoadDBHeight not successful or height is zero then leveldb has not been initialized before.
// LoadDBHeight will also set the private member variable m_height_stored from leveldb for this first call.
// If LoadDBHeight not successful or height is zero then LevelDB has not been initialized before.
// LoadDBHeight will also set the private member variable m_height_stored from LevelDB for this first call.
if (!LoadDBHeight(height) || !height)
{
return height;
}
else // Leveldb already initialized from a prior run.
else // LevelDB already initialized from a prior run.
{
// Set m_database_init to true. This will cause LoadDBHeight hereinafter to simply report
// the value of m_height_stored rather than loading the stored height from leveldb.
// the value of m_height_stored rather than loading the stored height from LevelDB.
m_database_init = true;

// We are in a restart where at least some of a rescan was completed during a prior run. It is possible
// that the rescan may have not been completed before a shutdown was issued. In that case the
// needs_IsContract_correction flag will be set to true in leveldb, so restore that state for this run
// needs_IsContract_correction flag will be set to true in LevelDB, so restore that state for this run
// to ensure the correction finishes. When ReplayContracts finishes the corrections, it will mark the flag
// false.
CTxDB txdb("r");
Expand All @@ -1103,7 +1103,7 @@ int BeaconRegistry::BeaconDB::Initialize(PendingBeaconMap& m_pending, BeaconMap&
height);


// Now load the beacons from leveldb.
// Now load the beacons from LevelDB.

std::string key_type = "beacon";

Expand All @@ -1126,7 +1126,7 @@ int BeaconRegistry::BeaconDB::Initialize(PendingBeaconMap& m_pending, BeaconMap&
if (height > 0)
{
// For the height be greater than zero from the height K-V, but the read into the map to fail
// means the storage in leveldb must be messed up in the beacon area and not be in concordance with
// means the storage in LevelDB must be messed up in the beacon area and not be in concordance with
// the beacon_db K-V's. Therefore clear the whole thing.
clear();
}
Expand Down Expand Up @@ -1343,7 +1343,7 @@ bool BeaconRegistry::BeaconDB::clear_leveldb()

status &= txdb.EraseGenericSerializablesByKeyType(key_type, start_key_hint_beacon_db);

// We want to write back into leveldb the revision level of the db in the running code.
// We want to write back into LevelDB the revision level of the db in the running code.
std::pair<std::string, std::string> key = std::make_pair(key_type, "version");
status &= txdb.WriteGenericSerializable(key, CURRENT_VERSION);

Expand Down Expand Up @@ -1407,7 +1407,7 @@ bool BeaconRegistry::BeaconDB::SetNeedsIsContractCorrection(bool flag)
// Update the in-memory flag.
m_needs_IsContract_correction = flag;

// Update leveldb
// Update LevelDB
CTxDB txdb("rw");

std::pair<std::string, std::string> key = std::make_pair("beacon_db", "needs_IsContract_correction");
Expand All @@ -1420,7 +1420,7 @@ bool BeaconRegistry::BeaconDB::StoreDBHeight(const int& height_stored)
// Update the in-memory bookmark variable.
m_height_stored = height_stored;

// Update leveldb.
// Update LevelDB.
CTxDB txdb("rw");

std::pair<std::string, std::string> key = std::make_pair("beacon_db", "height_stored");
Expand All @@ -1434,7 +1434,7 @@ bool BeaconRegistry::BeaconDB::LoadDBHeight(int& height_stored)

// If the database has already been initialized (which includes loading the height to what the
// beacon storage was updated), then just report the valud of m_height_stored, otherwise
// pull the value from leveldb.
// pull the value from LevelDB.
if (m_database_init)
{
height_stored = m_height_stored;
Expand Down Expand Up @@ -1506,7 +1506,7 @@ bool BeaconRegistry::BeaconDB::erase(const uint256& hash)

// Note that this function uses the shared pointer use_count() to determine whether an element in
// m_historical is referenced by either the m_beacons or m_pending map and if not, erases it, leaving the backing
// state in leveldb untouched. Note that the use of use_count() in multithreaded environments must be carefully
// state in LevelDB untouched. Note that the use of use_count() in multithreaded environments must be carefully
// considered because it is only approximate. In this case it is exact. Access to the entire BeaconRegistry class
// and everything in it is protected by the cs_main lock and is therefore single threaded. This method of passivating
// is MUCH faster than searching through m_beacons and m_pending for each element, because they are not keyed by hash.
Expand Down Expand Up @@ -1555,12 +1555,12 @@ BeaconRegistry::HistoricalBeaconMap::iterator BeaconRegistry::BeaconDB::find(con
// See if beacon from that ctx_hash is already in the historical map. If so, get iterator.
auto iter = m_historical.find(hash);

// If it isn't, attempt to load the beacon from leveldb into the map.
// If it isn't, attempt to load the beacon from LevelDB into the map.
if (iter == m_historical.end())
{
StorageBeacon beacon;

// If the load from leveldb is successful, insert into the historical map and return the iterator.
// If the load from LevelDB is successful, insert into the historical map and return the iterator.
if (Load(hash, beacon))
{
iter = m_historical.insert(std::make_pair(hash, std::make_shared<Beacon>(static_cast<Beacon>(beacon)))).first;
Expand All @@ -1570,7 +1570,7 @@ BeaconRegistry::HistoricalBeaconMap::iterator BeaconRegistry::BeaconDB::find(con
}
}

// Note that if there is no entry in m_historical, and also there is no K-V in leveldb, then an
// Note that if there is no entry in m_historical, and also there is no K-V in LevelDB, then an
// iterator at end() will be returned.
return iter;
}
Expand Down
Loading