Skip to content

Commit e16ee1c

Browse files
author
MarcoFalke
committed
[qa] Extend README.md
1 parent cc97574 commit e16ee1c

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,10 @@ lots of money.
4949
### Automated Testing
5050

5151
Developers are strongly encouraged to write unit tests for new code, and to
52-
submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`
52+
submit new unit tests for old code. Unit tests can be compiled and run
53+
(assuming they weren't disabled in configure) with: `make check`
5354

54-
There are also regression and integration tests of the RPC interface, written
55+
There are also [regression and integration tests](/qa) of the RPC interface, written
5556
in Python, that are run automatically on the build server.
5657
These tests can be run with: `qa/pull-tester/rpc-tests.py`
5758

qa/README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
Notes
2-
=====
1+
The [pull-tester](/qa/pull-tester/) folder contains a script to call
2+
multiple tests from the [rpc-tests](/qa/rpc-tests/) folder.
3+
4+
Every pull request to the bitcoin repository is built and run through
5+
the regression test suite. You can also run all or only individual
6+
tests locally.
7+
8+
Running tests
9+
=============
310

411
You can run any single test by calling `qa/pull-tester/rpc-tests.py <testname>`.
512

@@ -23,7 +30,8 @@ Possible options:
2330
Write tested RPC commands into this directory
2431
```
2532

26-
If you set the environment variable `PYTHON_DEBUG=1` you will get some debug output (example: `PYTHON_DEBUG=1 qa/pull-tester/rpc-tests.py wallet`).
33+
If you set the environment variable `PYTHON_DEBUG=1` you will get some debug
34+
output (example: `PYTHON_DEBUG=1 qa/pull-tester/rpc-tests.py wallet`).
2735

2836
A 200-block -regtest blockchain and wallets for four nodes
2937
is created the first time a regression test is run and
@@ -42,5 +50,8 @@ rm -rf cache
4250
killall bitcoind
4351
```
4452

53+
Writing tests
54+
=============
55+
You are encouraged to write tests for new or existing features.
4556
Further information about the test framework and individual rpc
46-
tests is found in [qa/rpc-tests/README.md](/qa/rpc-tests/README.md).
57+
tests is found in [qa/rpc-tests](/qa/rpc-tests).

0 commit comments

Comments
 (0)