Add Tips and Tricks section to README
This commit is contained in:
parent
ab25bec2ea
commit
b983fff4a1
35
README.md
35
README.md
|
@ -99,3 +99,38 @@ Periodically the translations are pulled from Transifex and merged into the git
|
||||||
|
|
||||||
If the changes are Dogecoin specific, they can be submitted as pull request against this repository.
|
If the changes are Dogecoin specific, they can be submitted as pull request against this repository.
|
||||||
If it is a general translation, consider submitting it through upstream, as we will pull these changes later on.
|
If it is a general translation, consider submitting it through upstream, as we will pull these changes later on.
|
||||||
|
|
||||||
|
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 message 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 -regest 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 what locks
|
||||||
|
are held, and adds warning to the debug.log file if inconsistencies are detected.
|
||||||
|
|
Loading…
Reference in a new issue