Skip to content

Commit f928050

Browse files
committed
Merge #8879: [doc] Rework docs
eeeebdd [doc] Rework docs (MarcoFalke)
2 parents d7615af + eeeebdd commit f928050

File tree

7 files changed

+24
-55
lines changed

7 files changed

+24
-55
lines changed

doc/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ Bitcoin Core 0.13.99
33

44
Setup
55
---------------------
6-
[Bitcoin Core](http://bitcoin.org/en/download) 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.
6+
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.
7+
8+
To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/releases/).
79

810
Running
911
---------------------
@@ -46,13 +48,13 @@ Development
4648
The Bitcoin repo's [root README](/README.md) contains relevant information on the development process and automated testing.
4749

4850
- [Developer Notes](developer-notes.md)
49-
- [Multiwallet Qt Development](multiwallet-qt.md)
5051
- [Release Notes](release-notes.md)
5152
- [Release Process](release-process.md)
5253
- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
5354
- [Translation Process](translation_process.md)
5455
- [Translation Strings Policy](translation_strings_policy.md)
5556
- [Unit Tests](unit-tests.md)
57+
- [Travis CI](travis-ci.md)
5658
- [Unauthenticated REST Interface](REST-interface.md)
5759
- [Shared Libraries](shared-libraries.md)
5860
- [BIPS](bips.md)
@@ -67,11 +69,13 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th
6769
### Miscellaneous
6870
- [Assets Attribution](assets-attribution.md)
6971
- [Files](files.md)
72+
- [Reduce Traffic](reduce-traffic.md)
7073
- [Tor Support](tor.md)
7174
- [Init Scripts (systemd/upstart/openrc)](init.md)
75+
- [ZMQ](zmq.md)
7276

7377
License
7478
---------------------
75-
Distributed under the [MIT software license](http://www.opensource.org/licenses/mit-license.php).
79+
Distributed under the [MIT software license](/COPYING).
7680
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
7781
cryptographic software written by Eric Young ([[email protected]](mailto:[email protected])), and UPnP software written by Thomas Bernard.

doc/multiwallet-qt.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

doc/release-notes/release-notes-0.13.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ git merge commit are mentioned.
643643
- #8041 `5b736dd` Fix bip9-softforks blockstore issue (MarcoFalke)
644644
- #7994 `1f01443` Add op csv tests to script_tests.json (Christewart)
645645
- #8038 `e2bf830` Various minor fixes (MarcoFalke)
646-
- #8072 `1b87e5b` Travis: 'make check' in parallel and verbose (MarcoFalke)
646+
- #8072 `1b87e5b` Travis: 'make check' in parallel and verbose (theuni)
647647
- #8056 `8844ef1` Remove hardcoded "4 nodes" from test_framework (MarcoFalke)
648648
- #8047 `37f9a1f` Test_framework: Set wait-timeout for bitcoind procs (MarcoFalke)
649649
- #8095 `6700cc9` Test framework: only cleanup on successful test runs (sdaftuar)

doc/release-process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Before every minor and major release:
1616
Before every major release:
1717

1818
* Update hardcoded [seeds](/contrib/seeds/README.md), see [this pull request](https://github.com/bitcoin/bitcoin/pull/7415) for an example.
19+
* Update [`BLOCK_CHAIN_SIZE`](/src/qt/intro.cpp) to the current size plus some overhead.
1920

2021
### First time / New builders
2122

doc/travis-ci.txt renamed to doc/travis-ci.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1+
Travis CI
2+
=========
3+
14
Support for using travis-ci has been added in order to automate pull-testing.
2-
See https://travis-ci.org/ for more info
5+
See [travis-ci.org](https://travis-ci.org/) for more info
36

47
This procedure is different than the pull-tester that came before it in a few
58
ways.
69

710
There is nothing to administer. This is a major feature as it means
811
that builds have no local state. Because there is no ability to login to the
912
builders to install packages (tools, dependencies, etc), the entire build
10-
procedure must instead be controlled by a declarative script (.travis.yml).
13+
procedure must instead be controlled by a declarative script `.travis.yml`.
1114
This script declares each build configuration, creates virtual machines as
1215
necessary, builds, then discards the virtual machines.
1316

@@ -16,7 +19,7 @@ than a single pass/fail. This helps to catch build failures and logic errors
1619
that present on platforms other than the ones the author has tested. This
1720
matrix is defined in the build script and can be changed at any time.
1821

19-
All builders use the dependency-generator in the depends dir, rather than
22+
All builders use the dependency-generator in the [depends dir](/depends), rather than
2023
using apt-get to install build dependencies. This guarantees that the tester
2124
is using the same versions as Gitian, so the build results are nearly identical
2225
to what would be found in a final release. However, this also means that builds

src/qt/bitcoingui.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ const std::string BitcoinGUI::DEFAULT_UIPLATFORM =
7474
#endif
7575
;
7676

77+
/** Display name for default wallet name. Uses tilde to avoid name
78+
* collisions in the future with additional wallets */
7779
const QString BitcoinGUI::DEFAULT_WALLET = "~Default";
7880

7981
BitcoinGUI::BitcoinGUI(const PlatformStyle *_platformStyle, const NetworkStyle *networkStyle, QWidget *parent) :

src/qt/walletframe.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ QT_BEGIN_NAMESPACE
1919
class QStackedWidget;
2020
QT_END_NAMESPACE
2121

22+
/**
23+
* A container for embedding all wallet-related
24+
* controls into BitcoinGUI. The purpose of this class is to allow future
25+
* refinements of the wallet controls with minimal need for further
26+
* modifications to BitcoinGUI, thus greatly simplifying merges while
27+
* reducing the risk of breaking top-level stuff.
28+
*/
2229
class WalletFrame : public QFrame
2330
{
2431
Q_OBJECT

0 commit comments

Comments
 (0)