Skip to content

Commit

Permalink
Merge pull request bitcoin#7136
Browse files Browse the repository at this point in the history
fa19a58 HelpMessage: Don't hide -mintxfee behind showDebug (MarcoFalke)
faffc17 rpcwallet: Clarify what settxfee does (MarcoFalke)
9999cb0 Fix url in .travis.yml (MarcoFalke)
fa22a10 contrib: Del. gitian downloader config and update gitian README (MarcoFalke)
fad3035 [doc] Minor markdown fixes (MarcoFalke)
  • Loading branch information
laanwj committed Dec 1, 2015
2 parents 327291a + fa19a58 commit 8f761e8
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 119 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# - A travis bug causes caches to trample eachother when using the same
# compiler key (which we don't use anyway). This is worked around for now by
# replacing the "compilers" with a build name prefixed by the no-op ":"
# command. See: https://github.com/travis-ci/casher/issues/6
# command. See: https://github.com/travis-ci/travis-ci/issues/4393

os: linux
language: cpp
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ lots of money.

### Automated Testing

Developers are strongly encouraged to write unit tests for new code, and to
Developers are strongly encouraged to write [unit tests](/doc/unit-tests.md) for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled in configure) with: `make check`

Expand Down
13 changes: 6 additions & 7 deletions contrib/gitian-descriptors/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
### Gavin's notes on getting gitian builds up and running using KVM:###
### Gavin's notes on getting gitian builds up and running using KVM

These instructions distilled from:
[ https://help.ubuntu.com/community/KVM/Installation]( https://help.ubuntu.com/community/KVM/Installation)
... see there for complete details.
These instructions distilled from
[https://help.ubuntu.com/community/KVM/Installation](https://help.ubuntu.com/community/KVM/Installation).

You need the right hardware: you need a 64-bit-capable CPU with hardware virtualization support (Intel VT-x or AMD-V). Not all modern CPUs support hardware virtualization.

Expand Down Expand Up @@ -33,14 +32,14 @@ Once you've got the right hardware and software:
# Get inputs (see doc/release-process.md for exact inputs needed and where to get them)
...

# For further build instructions see doc/release-notes.md
# For further build instructions see doc/release-process.md
...

---------------------

`gitian-builder` now also supports building using LXC. See
[ https://help.ubuntu.com/12.04/serverguide/lxc.html]( https://help.ubuntu.com/12.04/serverguide/lxc.html)
... for how to get LXC up and running under Ubuntu.
[help.ubuntu.com](https://help.ubuntu.com/14.04/serverguide/lxc.html)
for how to get LXC up and running under Ubuntu.

If your main machine is a 64-bit Mac or PC with a few gigabytes of memory
and at least 10 gigabytes of free disk space, you can `gitian-build` using
Expand Down
45 changes: 0 additions & 45 deletions contrib/gitian-downloader/linux-download-config

This file was deleted.

45 changes: 0 additions & 45 deletions contrib/gitian-downloader/win32-download-config

This file was deleted.

24 changes: 12 additions & 12 deletions doc/developer-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ General Bitcoin Core
- *Rationale*: RPC allows for better automatic testing. The test suite for
the GUI is very limited

- Make sure pulls pass Travis CI before merging
- Make sure pull requests pass Travis CI before merging

- *Rationale*: Makes sure that they pass thorough testing, and that the tester will keep passing
on the master branch. Otherwise all new pull requests will start failing the tests, resulting in
Expand All @@ -230,9 +230,9 @@ General Bitcoin Core
Wallet
-------

- Make sure that that no crashes happen with run-time option `-disablewallet`.
- Make sure that no crashes happen with run-time option `-disablewallet`.

- *Rationale*: In RPC code that conditionally use the wallet (such as
- *Rationale*: In RPC code that conditionally uses the wallet (such as
`validateaddress`) it is easy to forget that global pointer `pwalletMain`
can be NULL. See `qa/rpc-tests/disablewallet.py` for functional tests
exercising the API with `-disablewallet`
Expand All @@ -250,9 +250,9 @@ General C++
with assertions disabled, having side-effects in assertions is unexpected and
makes the code harder to understand

- If you use the .h, you must link the .cpp
- If you use the `.h`, you must link the `.cpp`

- *Rationale*: Include files are the interface for the implementation file. Including one but
- *Rationale*: Include files define the interface for the code in implementation files. Including one but
not linking the other is confusing. Please avoid that. Moving functions from
the `.h` to the `.cpp` should not result in build errors

Expand All @@ -264,11 +264,11 @@ General C++
C++ data structures
--------------------

- Never use the std::map [] syntax when reading from a map, but instead use .find()
- Never use the `std::map []` syntax when reading from a map, but instead use `.find()`

- *Rationale*: [] does an insert (of the default element) if the item doesn't
- *Rationale*: `[]` does an insert (of the default element) if the item doesn't
exist in the map yet. This has resulted in memory leaks in the past, as well as
race conditions (expecting read-read behavior). Using [] is fine for *writing* to a map
race conditions (expecting read-read behavior). Using `[]` is fine for *writing* to a map

- Do not compare an iterator from one data structure with an iterator of
another data structure (even if of the same type)
Expand Down Expand Up @@ -304,18 +304,18 @@ C++ data structures
Strings and formatting
------------------------

- Be careful of LogPrint versus LogPrintf. LogPrint takes a 'category' argument, LogPrintf does not.
- Be careful of `LogPrint` versus `LogPrintf`. `LogPrint` takes a `category` argument, `LogPrintf` does not.

- *Rationale*: Confusion of these can result in runtime exceptions due to
formatting mismatch, and it is easy to get wrong because of subtly similar naming

- Use std::string, avoid C string manipulation functions
- Use `std::string`, avoid C string manipulation functions

- *Rationale*: C++ string handling is marginally safer, less scope for
buffer overflows and surprises with \0 characters. Also some C string manipulations
buffer overflows and surprises with `\0` characters. Also some C string manipulations
tend to act differently depending on platform, or even the user locale

- Use ParseInt32, ParseInt64, ParseDouble from `utilstrencodings.h` for number parsing
- Use `ParseInt32`, `ParseInt64`, `ParseDouble` from `utilstrencodings.h` for number parsing

- *Rationale*: These functions do overflow checking, and avoid pesky locale issues

Expand Down
10 changes: 5 additions & 5 deletions doc/unit-tests.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Compiling/running unit tests
------------------------------------

Unit tests will be automatically compiled if dependencies were met in configure
Unit tests will be automatically compiled if dependencies were met in `./configure`
and tests weren't explicitly disabled.

After configuring, they can be run with 'make check'.
After configuring, they can be run with `make check`.

To run the bitcoind tests manually, launch src/test/test_bitcoin .
To run the bitcoind tests manually, launch `src/test/test_bitcoin`.

To add more bitcoind tests, add `BOOST_AUTO_TEST_CASE` functions to the existing
.cpp files in the test/ directory or add new .cpp files that
.cpp files in the `test/` directory or add new .cpp files that
implement new BOOST_AUTO_TEST_SUITE sections.

To run the bitcoin-qt tests manually, launch src/qt/test/test_bitcoin-qt
To run the bitcoin-qt tests manually, launch `src/qt/test/test_bitcoin-qt`

To add more bitcoin-qt tests, add them to the `src/qt/test/` directory and
the `src/qt/test/test_main.cpp` file.
3 changes: 1 addition & 2 deletions src/init.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,7 @@ std::string HelpMessage(HelpMessageMode mode)
strUsage += HelpMessageGroup(_("Wallet options:"));
strUsage += HelpMessageOpt("-disablewallet", _("Do not load the wallet and disable wallet RPC calls"));
strUsage += HelpMessageOpt("-keypool=<n>", strprintf(_("Set key pool size to <n> (default: %u)"), DEFAULT_KEYPOOL_SIZE));
if (showDebug)
strUsage += HelpMessageOpt("-mintxfee=<amt>", strprintf("Fees (in %s/kB) smaller than this are considered zero fee for transaction creation (default: %s)",
strUsage += HelpMessageOpt("-mintxfee=<amt>", strprintf(_("Fees (in %s/kB) smaller than this are considered zero fee for transaction creation (default: %s)"),
CURRENCY_UNIT, FormatMoney(DEFAULT_TRANSACTION_MINFEE)));
strUsage += HelpMessageOpt("-paytxfee=<amt>", strprintf(_("Fee (in %s/kB) to add to transactions you send (default: %s)"),
CURRENCY_UNIT, FormatMoney(payTxFee.GetFeePerK())));
Expand Down
2 changes: 1 addition & 1 deletion src/wallet/rpcwallet.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2178,7 +2178,7 @@ UniValue settxfee(const UniValue& params, bool fHelp)
if (fHelp || params.size() < 1 || params.size() > 1)
throw runtime_error(
"settxfee amount\n"
"\nSet the transaction fee per kB.\n"
"\nSet the transaction fee per kB. Overwrites the paytxfee parameter.\n"
"\nArguments:\n"
"1. amount (numeric, required) The transaction fee in " + CURRENCY_UNIT + "/kB rounded to the nearest 0.00000001\n"
"\nResult\n"
Expand Down

0 comments on commit 8f761e8

Please sign in to comment.