Skip to content

Commit fa4c6fa

Browse files
author
MarcoFalke
committed
doc: Add documentation for new test/lib
1 parent faec282 commit fa4c6fa

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

src/test/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ configure some other framework (we want as few impediments to creating
77
unit tests as possible).
88

99
The build system is set up to compile an executable called `test_bitcoin`
10-
that runs all of the unit tests. The main source file is called
11-
`setup_common.cpp`.
10+
that runs all of the unit tests. The main source file for the test library is found in
11+
`util/setup_common.cpp`.
1212

1313
### Compiling/running unit tests
1414

src/test/util/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Test library
2+
3+
This contains files for the test library, which is used by the test binaries (unit tests, benchmarks, fuzzers, gui
4+
tests).
5+
6+
Generally, the files in this folder should be well-separated modules. New code should be added to existing modules or
7+
(when in doubt) a new module should be created.
8+
9+
The utilities in here are compiled into a library, which does not hold any state. However, the main file `setup_common`
10+
defines the common test setup for all test binaries. The test binaries will handle the global state when they
11+
instantiate the `BasicTestingSetup` (or one of its derived classes).

0 commit comments

Comments
 (0)