aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2015-11-23 21:11:53 +0100
committerMarcoFalke <falke.marco@gmail.com>2015-11-30 16:33:15 +0100
commitfad3035e8d84dd3cbd166b9722127da373d34554 (patch)
tree573e99e733a3543381dfcaaa9fe4daa0ab6428c2 /doc
parenta7751824ce8a7e1cc5511794516fe674bc3eaa3c (diff)
[doc] Minor markdown fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md24
-rw-r--r--doc/unit-tests.md10
2 files changed, 17 insertions, 17 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 01eea931ad..358792251b 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -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
@@ -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`
@@ -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
@@ -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)
@@ -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
diff --git a/doc/unit-tests.md b/doc/unit-tests.md
index 72613054b9..afaece829c 100644
--- a/doc/unit-tests.md
+++ b/doc/unit-tests.md
@@ -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.