Skip to content

Commit

Permalink
Merge pull request #492 from sunnyqueen/master
Browse files Browse the repository at this point in the history
changed Bit to Peer in textfiles
  • Loading branch information
peerchemist committed Oct 27, 2019
2 parents 2360099 + e984f1a commit d00e3cb
Show file tree
Hide file tree
Showing 26 changed files with 152 additions and 155 deletions.
4 changes: 2 additions & 2 deletions doc/Doxyfile.in
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Bitcoin Core"
PROJECT_NAME = "Peercoin"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand All @@ -51,7 +51,7 @@ PROJECT_BRIEF = "P2P Digital Currency"
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

PROJECT_LOGO = doc/bitcoin_logo_doxygen.png
PROJECT_LOGO = src/qt/res/icons/peercoin.png

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
Expand Down
7 changes: 4 additions & 3 deletions doc/README.md
Expand Up @@ -4,7 +4,7 @@ Setup
---------------------
Peercoin Core is the original Peercoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Peercoin transactions (which is currently more than 100 GBs); 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 Peercoin Core, visit [peercoin.net](https://peercoin.net/download).
To download Peercoin, visit [peercoin.net](https://peercoin.net/download).

Running
---------------------
Expand All @@ -27,8 +27,9 @@ Drag Peercoin-Core to your applications folder, and then run Peercoin-Core.

### Need Help?

* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
for help and more information. Peercoin is very similar to bitcoin, so you can use their wiki.
* See the documentation at the [Peercoin Wiki](https://docs.peercoin.net/)
for help and more information.
* Peercoin is very similar to bitcoin, so you can use their wiki [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page).
* Ask for help on [#general](https://peercoin.chat/) on peercoin.chat.

Building
Expand Down
4 changes: 2 additions & 2 deletions doc/README_windows.txt
Expand Up @@ -25,6 +25,6 @@ However, it downloads and stores the entire history of Peercoin 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.

See the bitcoin wiki at:
https://en.bitcoin.it/wiki/Main_Page
See the peercoin documentation at:
https://docs.peercoin.net/
for more help and information.
2 changes: 1 addition & 1 deletion doc/REST-interface.md
Expand Up @@ -100,4 +100,4 @@ Only supports JSON as output format.

Risks
-------------
Running a web browser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy.
Running a web browser on the same node with a REST enabled peercoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy.
2 changes: 1 addition & 1 deletion doc/assets-attribution.md
@@ -1 +1 @@
The list of assets used in the bitcoin source and their attribution can now be found in [contrib/debian/copyright](../contrib/debian/copyright).
The list of assets used in the peercoin source and their attribution can now be found in [contrib/debian/copyright](../contrib/debian/copyright).
4 changes: 2 additions & 2 deletions doc/benchmarking.md
@@ -1,12 +1,12 @@
Benchmarking
============

Bitcoin Core has an internal benchmarking framework, with benchmarks
Peercoin has an internal benchmarking framework, with benchmarks
for cryptographic algorithms such as SHA1, SHA256, SHA512 and RIPEMD160. As well as the rolling bloom filter.

Running
---------------------
After compiling bitcoin-core, the benchmarks can be run with:
After compiling peercoin, the benchmarks can be run with:

src/bench/bench_bitcoin

Expand Down
6 changes: 3 additions & 3 deletions doc/build-netbsd.md
Expand Up @@ -2,7 +2,7 @@ NetBSD build guide
======================
(updated for NetBSD 7.0)

This guide describes how to build bitcoind and command-line utilities on NetBSD.
This guide describes how to build peercoind and command-line utilities on NetBSD.

This guide does not contain instructions for building the GUI.

Expand All @@ -25,12 +25,12 @@ python27

Download the source code:
```
git clone https://github.com/bitcoin/bitcoin
git clone https://github.com/peercoin/peercoin
```

See [dependencies.md](dependencies.md) for a complete overview.

### Building Bitcoin Core
### Building Peercoin

**Important**: Use `gmake` (the non-GNU `make` will exit with an error).

Expand Down
6 changes: 3 additions & 3 deletions doc/build-openbsd.md
Expand Up @@ -2,7 +2,7 @@ OpenBSD build guide
======================
(updated for OpenBSD 6.2)

This guide describes how to build bitcoind and command-line utilities on OpenBSD.
This guide describes how to build peercoind and command-line utilities on OpenBSD.

OpenBSD is most commonly used as a server OS, so this guide does not contain instructions for building the GUI.

Expand All @@ -18,7 +18,7 @@ pkg_add automake # (select highest version, e.g. 1.15)
pkg_add python # (select highest version, e.g. 3.6)
pkg_add boost

git clone https://github.com/bitcoin/bitcoin.git
git clone https://github.com/peercoin/peercoin.git
```

See [dependencies.md](dependencies.md) for a complete overview.
Expand Down Expand Up @@ -49,7 +49,7 @@ from the root of the repository. Then set `BDB_PREFIX` for the next section:
export BDB_PREFIX="$PWD/db4"
```

### Building Bitcoin Core
### Building Peercoin

**Important**: use `gmake`, not `make`. The non-GNU `make` will exit with a horrible error.

Expand Down
6 changes: 3 additions & 3 deletions doc/build-unix.md
@@ -1,6 +1,6 @@
UNIX BUILD NOTES
====================
Some notes on how to build Peercoin Core in Unix.
Some notes on how to build Peercoin in Unix.

(for OpenBSD specific instructions, see [build-openbsd.md](build-openbsd.md))

Expand Down Expand Up @@ -55,7 +55,7 @@ Memory Requirements
--------------------

C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of
memory available when compiling Peercoin Core. On systems with less, gcc can be
memory available when compiling Peercoin. On systems with less, gcc can be
tuned to conserve memory with additional CXXFLAGS:


Expand All @@ -80,7 +80,7 @@ install necessary parts of boost:
sudo apt-get install libboost-all-dev

BerkeleyDB is required for the wallet functionality.
Historically Bitcoin was first deployed with now deprecated BerkeleyDB-4.8, which has resulted in the need to upkeep the compatibility with those ancient deployments to this day. BerkeleyDB-4.8 is not compatible with more modern BerkeleyDB-5.1 and BerkeleyDB-5.3. Peercoin has inherited this in the first versions and this is why Peercoin is still officially shipped out with BerkeleyDB-4.8.
Historically Peercoin was first deployed with now deprecated BerkeleyDB-4.8, which has resulted in the need to upkeep the compatibility with those ancient deployments to this day. BerkeleyDB-4.8 is not compatible with more modern BerkeleyDB-5.1 and BerkeleyDB-5.3. Peercoin has inherited this in the first versions and this is why Peercoin is still officially shipped out with BerkeleyDB-4.8.
However if you running a new wallet on a new installation there is absolutely no need to run old and deprecated BerkeleyDB-4.8. Just use the one avaliable in the repository of your distribution.

**For Ubuntu only:** db4.8 packages are available [here](https://launchpad.net/~bitcoin/+archive/bitcoin).
Expand Down
30 changes: 15 additions & 15 deletions doc/build-windows.md
@@ -1,12 +1,12 @@
WINDOWS BUILD NOTES
====================

Below are some notes on how to build Bitcoin Core for Windows.
Below are some notes on how to build Peercoin for Windows.

The options known to work for building Bitcoin Core on Windows are:
The options known to work for building Peercoin on Windows are:

* On Linux using the [Mingw-w64](https://mingw-w64.org/doku.php) cross compiler tool chain. Ubuntu Bionic 18.04 is required
and is the platform used to build the Bitcoin Core Windows release binaries.
and is the platform used to build the Peercoin Windows release binaries.
* On Windows using [Windows
Subsystem for Linux (WSL)](https://msdn.microsoft.com/commandline/wsl/about) and the Mingw-w64 cross compiler tool chain.

Expand Down Expand Up @@ -78,15 +78,15 @@ Ubuntu Bionic 18.04 <sup>[1](#footnote1)</sup>:

Once the tool chain is installed the build steps are common:

Note that for WSL the Bitcoin Core source path MUST be somewhere in the default mount file system, for
example /usr/src/bitcoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
Note that for WSL the Peercoin source path MUST be somewhere in the default mount file system, for
example /usr/src/peercoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
This means you cannot use a directory that located directly on the host Windows file system to perform the build.

The next three steps are an example of how to acquire the source in an appropriate way.

cd /usr/src
sudo git clone https://github.com/bitcoin/bitcoin.git
sudo chmod -R a+rw bitcoin
sudo git clone https://github.com/peercoin/peercoin.git
sudo chmod -R a+rw peercoin

Once the source code is ready the build steps are below.

Expand All @@ -108,15 +108,15 @@ For Ubuntu Bionic 18.04 and Windows Subsystem for Linux <sup>[1](#footnote1)</su

sudo update-alternatives --config i686-w64-mingw32-g++ # Set the default mingw32 g++ compiler option to posix.

Note that for WSL the Bitcoin Core source path MUST be somewhere in the default mount file system, for
example /usr/src/bitcoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
Note that for WSL the Peercoin source path MUST be somewhere in the default mount file system, for
example /usr/src/peercoin, AND not under /mnt/d/. If this is not the case the dependency autoconf scripts will fail.
This means you cannot use a directory that located directly on the host Windows file system to perform the build.

The next three steps are an example of how to acquire the source in an appropriate way.

cd /usr/src
sudo git clone https://github.com/bitcoin/bitcoin.git
sudo chmod -R a+rw bitcoin
sudo git clone https://github.com/peercoin/peercoin.git
sudo chmod -R a+rw peercoin

Then build using:

Expand All @@ -138,9 +138,9 @@ Installation
After building using the Windows subsystem it can be useful to copy the compiled
executables to a directory on the windows drive in the same directory structure
as they appear in the release `.zip` archive. This can be done in the following
way. This will install to `c:\workspace\bitcoin`, for example:
way. This will install to `c:\workspace\peercoin`, for example:

make install DESTDIR=/mnt/c/workspace/bitcoin
make install DESTDIR=/mnt/c/workspace/peercoin

Footnotes
---------
Expand All @@ -149,5 +149,5 @@ Footnotes
compiler options to allow a choice between either posix or win32 threads. The default option is win32 threads which is the more
efficient since it will result in binary code that links directly with the Windows kernel32.lib. Unfortunately, the headers
required to support win32 threads conflict with some of the classes in the C++11 standard library in particular std::mutex.
It's not possible to build the bitcoin code using the win32 version of the Mingw-w64 cross compilers (at least not without
modifying headers in the bitcoin source code).
It's not possible to build the peercoin code using the win32 version of the Mingw-w64 cross compilers (at least not without
modifying headers in the peercoin source code).
2 changes: 1 addition & 1 deletion doc/dependencies.md
@@ -1,7 +1,7 @@
Dependencies
============

These are the dependencies currently used by Bitcoin Core. You can find instructions for installing them in the `build-*.md` file for your platform.
These are the dependencies currently used by Peercoin. You can find instructions for installing them in the `build-*.md` file for your platform.

| Dependency | Version used | Minimum required | CVEs | Shared | [Bundled Qt library](https://doc.qt.io/qt-5/configure-options.html) |
| --- | --- | --- | --- | --- | --- |
Expand Down
24 changes: 12 additions & 12 deletions doc/developer-notes.md
Expand Up @@ -153,7 +153,7 @@ to see it.

**testnet and regtest modes**

Run with the -testnet option to run with "play bitcoins" on the test network, if you
Run with the -testnet option to run with "play peercoins" on the test network, if you
are testing multi-machine code that needs to operate across the internet.

If you are testing something that can run on one machine, run with the -regtest option.
Expand All @@ -162,7 +162,7 @@ that run in -regtest mode.

**DEBUG_LOCKORDER**

Bitcoin Core is a multithreaded application, and deadlocks or other multithreading bugs
Peercoin is a multithreaded application, and deadlocks or other multithreading bugs
can be very difficult to track down. Compiling with -DDEBUG_LOCKORDER (configure
CXXFLAGS="-DDEBUG_LOCKORDER -g") inserts run-time checks to keep track of which locks
are held, and adds warnings to the debug.log file if inconsistencies are detected.
Expand Down Expand Up @@ -252,7 +252,7 @@ Ignoring IDE/editor files
In closed-source environments in which everyone uses the same IDE it is common
to add temporary files it produces to the project-wide `.gitignore` file.

However, in open source software such as Bitcoin Core, where everyone uses
However, in open source software such as Peercoin, where everyone uses
their own editors/IDE/tools, it is less common. Only you know what files your
editor produces and this may change from version to version. The canonical way
to do this is thus to create your local gitignore. Add this to `~/.gitconfig`:
Expand Down Expand Up @@ -282,9 +282,9 @@ Development guidelines
============================

A few non-style-related recommendations for developers, as well as points to
pay attention to for reviewers of Bitcoin Core code.
pay attention to for reviewers of Peercoin code.

General Bitcoin Core
General Peercoin
----------------------

- New features should be exposed on RPC first, then can be made available in the GUI
Expand Down Expand Up @@ -400,7 +400,7 @@ Strings and formatting

- For `strprintf`, `LogPrint`, `LogPrintf` formatting characters don't need size specifiers

- *Rationale*: Bitcoin Core uses tinyformat, which is type safe. Leave them out to avoid confusion
- *Rationale*: Peercoin uses tinyformat, which is type safe. Leave them out to avoid confusion

Variable names
--------------
Expand Down Expand Up @@ -514,12 +514,12 @@ Subtrees

Several parts of the repository are subtrees of software maintained elsewhere.

Some of these are maintained by active developers of Bitcoin Core, in which case changes should probably go
Some of these are maintained by active developers of Peercoin, in which case changes should probably go
directly upstream without being PRed directly against the project. They will be merged back in the next
subtree merge.

Others are external projects without a tight relationship with our project. Changes to these should also
be sent upstream but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated
be sent upstream but bugfixes may also be prudent to PR against Peercoin so that they can be integrated
quickly. Cosmetic changes should be purely taken upstream.

There is a tool in contrib/devtools/git-subtree-check.sh to check a subtree directory for consistency with
Expand Down Expand Up @@ -582,7 +582,7 @@ Git and GitHub tips

[remote "upstream-pull"]
fetch = +refs/pull/*:refs/remotes/upstream-pull/*
url = git@github.com:bitcoin/bitcoin.git
url = git@github.com:peercoin/peercion.git

This will add an `upstream-pull` remote to your git repository, which can be fetched using `git fetch --all`
or `git fetch upstream-pull`. Afterwards, you can use `upstream-pull/NUMBER/head` in arguments to `git show`,
Expand Down Expand Up @@ -648,7 +648,7 @@ A few guidelines for introducing and reviewing new RPC interfaces:
- Try not to overload methods on argument type. E.g. don't make `getblock(true)` and `getblock("hash")`
do different things.

- *Rationale*: This is impossible to use with `bitcoin-cli`, and can be surprising to users.
- *Rationale*: This is impossible to use with `peeritcoin-cli`, and can be surprising to users.

- *Exception*: Some RPC calls can take both an `int` and `bool`, most notably when a bool was switched
to a multi-value, or due to other historical reasons. **Always** have false map to 0 and
Expand All @@ -667,7 +667,7 @@ A few guidelines for introducing and reviewing new RPC interfaces:

- Add every non-string RPC argument `(method, idx, name)` to the table `vRPCConvertParams` in `rpc/client.cpp`.

- *Rationale*: `bitcoin-cli` and the GUI debug console use this table to determine how to
- *Rationale*: `peercoin-cli` and the GUI debug console use this table to determine how to
convert a plaintext command line to JSON. If the types don't match, the method can be unusable
from there.

Expand All @@ -689,7 +689,7 @@ A few guidelines for introducing and reviewing new RPC interfaces:
RPCs whose behavior does *not* depend on the current chainstate may omit this
call.

- *Rationale*: In previous versions of Bitcoin Core, the wallet was always
- *Rationale*: In previous versions of Peercoin, the wallet was always
in-sync with the chainstate (by virtue of them all being updated in the
same cs_main lock). In order to maintain the behavior that wallet RPCs
return results as of at least the highest best-known block an RPC
Expand Down
16 changes: 8 additions & 8 deletions doc/dnsseed-policy.md
@@ -1,12 +1,12 @@
Expectations for DNS Seed operators
====================================

Bitcoin Core attempts to minimize the level of trust in DNS seeds,
Peercoin attempts to minimize the level of trust in DNS seeds,
but DNS seeds still pose a small amount of risk for the network.
As such, DNS seeds must be run by entities which have some minimum
level of trust within the Bitcoin community.
level of trust within the Peercoin community.

Other implementations of Bitcoin software may also use the same
Other implementations of Peercoin software may also use the same
seeds and may be more exposed. In light of this exposure, this
document establishes some basic expectations for operating dnsseeds.

Expand All @@ -16,7 +16,7 @@ and not sell or transfer control of the DNS seed. Any hosting services
contracted by the operator are equally expected to uphold these expectations.

1. The DNS seed results must consist exclusively of fairly selected and
functioning Bitcoin nodes from the public network to the best of the
functioning Peercoin nodes from the public network to the best of the
operator's understanding and capability.

2. For the avoidance of doubt, the results may be randomized but must not
Expand All @@ -26,7 +26,7 @@ urgent technical necessity and disclosed.
3. The results may not be served with a DNS TTL of less than one minute.

4. Any logging of DNS queries should be only that which is necessary
for the operation of the service or urgent health of the Bitcoin
for the operation of the service or urgent health of the Peercoin
network and must not be retained longer than necessary nor disclosed
to any third party.

Expand All @@ -42,13 +42,13 @@ details of their operating practices.
related to the DNS seed operation.

If these expectations cannot be satisfied the operator should
discontinue providing services and contact the active Bitcoin
Core development team as well as posting on
discontinue providing services and contact the active Peercoin
development team as well as posting on
[bitcoin-dev](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev).

Behavior outside of these expectations may be reasonable in some
situations but should be discussed in public in advance.

See also
----------
- [bitcoin-seeder](https://github.com/sipa/bitcoin-seeder) is a reference implementation of a DNS seed.
- [peercoin-seeder](https://github.com/peercoin/peercoin-seeder) is a reference implementation of a DNS seed.

0 comments on commit d00e3cb

Please sign in to comment.