From 731b7a75c2bba4d4ba5a213ca5235ac334a998b0 Mon Sep 17 00:00:00 2001 From: Ross Nicoll Date: Sat, 20 Jan 2018 18:35:31 +0000 Subject: [PATCH] Update documentation to match 1.10 (#1436) --- README.md | 159 ++++++++++++++++++++---------- doc/Doxyfile | 4 +- doc/README.md | 31 +++--- doc/README_windows.txt | 14 +-- doc/REST-interface.md | 2 +- doc/assets-attribution.md | 68 ++++++++++++- doc/benchmarking.md | 6 +- doc/build-openbsd.md | 10 +- doc/build-osx.md | 34 +++---- doc/build-unix.md | 43 ++++---- doc/developer-notes.md | 12 +-- doc/dnsseed-policy.md | 16 +-- doc/files.md | 6 +- doc/fuzzing.md | 12 +-- doc/gitian-building.md | 54 +++++----- doc/init.md | 82 +++++++-------- doc/release-process.md | 148 ++++++++++++--------------- doc/shared-libraries.md | 42 ++++---- doc/tor.md | 36 +++---- doc/translation_strings_policy.md | 2 +- doc/travis-ci.md | 2 +- doc/zmq.md | 20 ++-- 22 files changed, 449 insertions(+), 354 deletions(-) diff --git a/README.md b/README.md index 38a90dde4..0264d1d45 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,35 @@ -Bitcoin Core integration/staging tree -===================================== +# Dogecoin Core [DOGE, Ð] +========================== -[![Build Status](https://travis-ci.org/bitcoin/bitcoin.svg?branch=master)](https://travis-ci.org/bitcoin/bitcoin) +![Dogecoin](http://static.tumblr.com/ppdj5y9/Ae9mxmxtp/300coin.png) -https://bitcoincore.org +[![Build Status](https://travis-ci.org/dogecoin/dogecoin.svg?branch=1.14-dev)](https://travis-ci.org/dogecoin/dogecoin) [![tip for next commit](https://tip4commit.com/projects/702.svg)](https://tip4commit.com/github/dogecoin/dogecoin) -What is Bitcoin? ----------------- +## What is Dogecoin? – Such coin +Dogecoin is a cryptocurrency like Bitcoin, although it does not use SHA256 as its proof of work (POW). Taking development cues from Tenebrix and Litecoin, Dogecoin currently employs a simplified variant of scrypt. -Bitcoin is an experimental digital currency that enables instant payments to -anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate -with no central authority: managing transactions and issuing money are carried -out collectively by the network. Bitcoin Core is the name of open source -software which enables the use of this currency. +http://dogecoin.com/ -For more information, as well as an immediately useable, binary version of -the Bitcoin Core software, see https://bitcoin.org/en/download, or read the -[original whitepaper](https://bitcoincore.org/bitcoin.pdf). - -License -------- - -Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more +## License – Much license +Dogecoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see https://opensource.org/licenses/MIT. -Development Process -------------------- +## Development and contributions – omg developers +Development is ongoing, and the development team, as well as other volunteers, can freely work in their own trees and submit pull requests when features or bug fixes are ready. -The `master` branch is regularly built and tested, but is not guaranteed to be -completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created -regularly to indicate new official, stable release versions of Bitcoin Core. +#### Version strategy +Version numbers are following ```major.minor.patch``` semantics. -The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md). +#### Branches +There are 3 types of branches in this repository: -The developer [mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev) -should be used to discuss complicated or controversial changes before working -on a patch set. +- **master:** Stable, contains the latest version of the latest *major.minor* release. +- **maintenance:** Stable, contains the latest version of previous releases, which are still under active maintenance. Format: ```-maint``` +- **development:** Unstable, contains new code for planned releases. Format: ```-dev``` -Developer IRC can be found on Freenode at #bitcoin-core-dev. +*Master and maintenance branches are exclusively mutable by release. Planned releases will always have a development branch and pull requests should be submitted against those. Maintenance branches are there for* ***bug fixes only,*** *please submit new features against the development branch with the highest version.* -Testing -------- - -Testing and code review is the bottleneck for development; we get more pull -requests than we can review and test on short notice. Please be patient and help out by testing -other people's pull requests, and remember this is a security-critical project where any mistake might cost people -lots of money. - -### Automated Testing +#### Contributions Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to submit new unit tests for old code. Unit tests can be compiled and run @@ -58,25 +40,100 @@ There are also [regression and integration tests](/qa) of the RPC interface, wri in Python, that are run automatically on the build server. These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py` -The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, and that unit/sanity tests are run automatically. - -### Manual Quality Assurance (QA) Testing - Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward. -Translations ------------- +## Very Much Frequently Asked Questions -Changes to translations as well as new translations can be submitted to -[Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/). +### How much doge can exist? – So many puppies! +Early 2015 (approximately a year and a half after release) there will be approximately 100,000,000,000 coins. +Each subsequent block will grant 10,000 coins to encourage miners to continue to secure the network and make up for lost wallets on hard drives/phones/lost encryption passwords/etc. -Translations are periodically pulled from Transifex and merged into the git repository. See the -[translation process](doc/translation_process.md) for details on how this works. +### How to get doge? – To the moon! +Dogecoin uses a simplified variant of the scrypt key derivation function as its proof of work with a target time of one minute per block and difficulty readjustment after every block. The block rewards are fixed and halve every 100,000 blocks. Starting with the 600,000th block, a permanent reward of 10,000 Dogecoin per block will be paid. -**Important**: We do not accept translation changes as GitHub pull requests because the next -pull from Transifex would automatically overwrite them again. +Originally, a different payout scheme was envisioned with block rewards being determined by taking the maximum reward as per the block schedule and applying the result of a Mersenne Twister pseudo-random number generator to arrive at a number between 0 and the maximum reward. This was changed, starting with block 145,000, to prevent large pools from gaming the system and mining only high reward blocks. At the same time, the difficulty retargeting was also changed from four hours to once per block (every minute), implementing an algorithm courtesy of the DigiByte Coin development team, to lessen the impact of sudden increases and decreases of network hashing rate. -Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators). +The current block reward schedule: + +1–99,999: 0–1,000,000 Dogecoin + +100,000–144,999: 0–500,000 Dogecoin + +145,000–199,999: 250,000 Dogecoin + +200,000–299,999: 125,000 Dogecoin + +300,000–399,999: 62,500 Dogecoin + +400,000–499,999: 31,250 Dogecoin + +500,000–599,999: 15,625 Dogecoin + +600,000+: 10,000 Dogecoin + +The original block reward schedule, with one-minute block targets and four-hour difficulty readjustment: + +1–99,999: 0–1,000,000 Dogecoin + +100,000–199,999: 0–500,000 Dogecoin + +200,000–299,999: 0–250,000 Dogecoin + +300,000–399,999: 0–125,000 Dogecoin + +400,000–499,999: 0–62,500 Dogecoin + +500,000–599,999: 0–31,250 Dogecoin + +600,000+: 10,000 Dogecoin + +### Wow plz make dogecoind/dogecoin-cli/dogecoin-qt + + The following are developer notes on how to build Dogecoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc. + + - [OSX Build Notes](doc/build-osx.md) + - [Unix Build Notes](doc/build-unix.md) + - [Windows Build Notes](doc/build-msw.md) + +### Such ports +RPC 22555 +P2P 22556 + +![](http://dogesay.com/wow//////such/coin) + +## Development tips and tricks + +**compiling for debugging** + +Run configure with the --enable-debug option, then make. Or run configure with +CXXFLAGS="-g -ggdb -O0" or whatever debug flags you need. + +**debug.log** + +If the code is behaving strangely, take a look in the debug.log file in the data directory; +error and debugging messages are written there. + +The -debug=... command-line option controls debugging; running with just -debug will turn +on all categories (and give you a very large debug.log file). + +The Qt code routes qDebug() output to debug.log under category "qt": run with -debug=qt +to see it. + +**testnet and regtest modes** + +Run with the -testnet option to run with "play dogecoins" 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. +In regression test mode, blocks can be created on-demand; see qa/rpc-tests/ for tests +that run in -regtest mode. + +**DEBUG_LOCKORDER** + +Dogecoin Core 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. diff --git a/doc/Doxyfile b/doc/Doxyfile index a76918df7..171381c5e 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -32,13 +32,13 @@ 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 = "Dogecoin Core" # 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 # control system is used. -PROJECT_NUMBER = 0.14.2 +PROJECT_NUMBER = 1.14.2 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/README.md b/doc/README.md index 81ded9e10..17325b72b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,41 +1,39 @@ -Bitcoin Core 0.14.2 +Dogecoin Core 0.14.2 ===================== Setup --------------------- -Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Bitcoin transactions (which is currently several 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 Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/releases/). +[Dogecoin Core](http://dogecoin.com/) is the reference Dogecoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Bitcoin transactions (which is currently several 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. Running --------------------- -The following are some helpful notes on how to run Bitcoin on your native platform. +The following are some helpful notes on how to run Dogecoin on your native platform. ### Unix Unpack the files into a directory and run: -- `bin/bitcoin-qt` (GUI) or -- `bin/bitcoind` (headless) +- `bin/dogecoin-qt` (GUI) or +- `bin/dogecoind` (headless) ### Windows -Unpack the files into a directory, and then run bitcoin-qt.exe. +Unpack the files into a directory, and then run dogecoin-qt.exe. ### OS X -Drag Bitcoin-Core to your applications folder, and then run Bitcoin-Core. +Drag Dogecoin-Core to your applications folder, and then run Dogecoin-Core. ### Need Help? * See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page) for help and more information. -* Ask for help on [#bitcoin](http://webchat.freenode.net?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=bitcoin). -* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0). +* Ask for help on [#dogecoin](http://webchat.freenode.net?channels=dogecoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=dogecoin). +* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Dogecoin thread](https://bitcointalk.org/index.php?topic=361813.0). Building --------------------- -The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc. +The following are developer notes on how to build Dogecoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc. - [OS X Build Notes](build-osx.md) - [Unix Build Notes](build-unix.md) @@ -45,12 +43,11 @@ The following are developer notes on how to build Bitcoin on your native platfor Development --------------------- -The Bitcoin repo's [root README](/README.md) contains relevant information on the development process and automated testing. +The Dogecoin repo's [root README](/README.md) contains relevant information on the development process and automated testing. - [Developer Notes](developer-notes.md) - [Release Notes](release-notes.md) - [Release Process](release-process.md) -- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/) - [Translation Process](translation_process.md) - [Translation Strings Policy](translation_strings_policy.md) - [Travis CI](travis-ci.md) @@ -61,9 +58,8 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th - [Benchmarking](benchmarking.md) ### Resources -* Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0). -* Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-core-dev). -* Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-dev). +* Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Dogecoin thread](https://bitcointalk.org/index.php?topic=361813.0). +* Discuss on [#dogecoin-dev](http://webchat.freenode.net/?channels=dogecoin-dev) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=dogecoin-dev). ### Miscellaneous - [Assets Attribution](assets-attribution.md) @@ -77,5 +73,6 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th License --------------------- Distributed under the [MIT software license](/COPYING). +This product includes software developed by the Bitcoin developers for use in [Dogecoin Core](https://www.bitcoin.org/). This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard. diff --git a/doc/README_windows.txt b/doc/README_windows.txt index ec365178a..180ecb5f2 100644 --- a/doc/README_windows.txt +++ b/doc/README_windows.txt @@ -1,9 +1,9 @@ -Bitcoin Core 0.14.2 +Dogecoin Core 0.14.2 ===================== Intro ----- -Bitcoin is a free open source peer-to-peer electronic cash system that is +Dogecoin is a free open source peer-to-peer electronic cash system that is completely decentralized, without the need for a central server or trusted parties. Users hold the crypto keys to their own money and transact directly with each other, with the help of a P2P network to check for double-spending. @@ -11,13 +11,13 @@ with each other, with the help of a P2P network to check for double-spending. Setup ----- -Unpack the files into a directory and run bitcoin-qt.exe. +Unpack the files into a directory and run dogecoin-qt.exe. -Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. -However, it downloads and stores the entire history of Bitcoin transactions; +Dogecoin Core is the original Dogecoin client and it builds the backbone of the network. +However, it downloads and stores the entire history of Dogecoin 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 Dogecoin wiki at: + https://www.reddit.com/r/dogecoin/wiki/dogecoincoreguide for more help and information. diff --git a/doc/REST-interface.md b/doc/REST-interface.md index 7fbb17403..c3570b390 100644 --- a/doc/REST-interface.md +++ b/doc/REST-interface.md @@ -95,4 +95,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 `