scripted-diff: Adjust documentation per top-level target output location

-BEGIN VERIFY SCRIPT-

ren() { sed -i "s|\<$1\>|$2|g" $( git grep -l "$1" :\(exclude\)./src/secp256k1 ) ; }

ren build/src/bench   build/bin
ren build/src/test    build/bin
ren build/src/qt/test build/bin
ren build/src/qt      build/bin
ren build/src         build/bin
ren build_fuzz/src/test/fuzz build_fuzz/bin

-END VERIFY SCRIPT-
This commit is contained in:
Hennadii Stepanov
2025-02-18 14:04:44 +00:00
parent 026bb226e9
commit 568fcdddae
18 changed files with 100 additions and 100 deletions

View File

@@ -11,7 +11,7 @@ When following your systems build instructions, make sure to install the `Qt` de
To run:
```sh
./build/src/qt/bitcoin-qt
./build/bin/bitcoin-qt
```
## Files and Directories

View File

@@ -24,7 +24,7 @@ tests from subtrees.
Run `test_bitcoin --list_content` for the full list of tests.
To run the unit tests manually, launch `build/src/test/test_bitcoin`. To recompile
To run the unit tests manually, launch `build/bin/test_bitcoin`. To recompile
after a test file was modified, run `cmake --build build` and then run the test again. If you
modify a non-test file, use `cmake --build build --target test_bitcoin` to recompile only what's needed
to run the unit tests.
@@ -33,7 +33,7 @@ To add more unit tests, add `BOOST_AUTO_TEST_CASE` functions to the existing
.cpp files in the `test/` directory or add new .cpp files that
implement new `BOOST_AUTO_TEST_SUITE` sections.
To run the GUI unit tests manually, launch `build/src/qt/test/test_bitcoin-qt`
To run the GUI unit tests manually, launch `build/bin/test_bitcoin-qt`
To add more GUI unit tests, add them to the `src/qt/test/` directory and
the `src/qt/test/test_main.cpp` file.
@@ -50,19 +50,19 @@ test_bitcoin --help
For example, to run only the tests in the `getarg_tests` file, with full logging:
```bash
build/src/test/test_bitcoin --log_level=all --run_test=getarg_tests
build/bin/test_bitcoin --log_level=all --run_test=getarg_tests
```
or
```bash
build/src/test/test_bitcoin -l all -t getarg_tests
build/bin/test_bitcoin -l all -t getarg_tests
```
or to run only the doubledash test in `getarg_tests`
```bash
build/src/test/test_bitcoin --run_test=getarg_tests/doubledash
build/bin/test_bitcoin --run_test=getarg_tests/doubledash
```
The `--log_level=` (or `-l`) argument controls the verbosity of the test output.
@@ -71,7 +71,7 @@ The `test_bitcoin` runner also accepts some of the command line arguments accept
`bitcoind`. Use `--` to separate these sets of arguments:
```bash
build/src/test/test_bitcoin --log_level=all --run_test=getarg_tests -- -printtoconsole=1
build/bin/test_bitcoin --log_level=all --run_test=getarg_tests -- -printtoconsole=1
```
The `-printtoconsole=1` after the two dashes sends debug logging, which
@@ -98,7 +98,7 @@ what the test wrote to `debug.log` after it completes, for example.
so no leftover state is used.)
```bash
$ build/src/test/test_bitcoin --run_test=getarg_tests/doubledash -- -testdatadir=/somewhere/mydatadir
$ build/bin/test_bitcoin --run_test=getarg_tests/doubledash -- -testdatadir=/somewhere/mydatadir
Test directory (will not be deleted): "/somewhere/mydatadir/test_common bitcoin/getarg_tests/doubledash/datadir"
Running 1 test case...
@@ -138,13 +138,13 @@ For debugging you can launch the `test_bitcoin` executable with `gdb` or `lldb`
start debugging, just like you would with any other program:
```bash
gdb build/src/test/test_bitcoin
gdb build/bin/test_bitcoin
```
#### Segmentation faults
If you hit a segmentation fault during a test run, you can diagnose where the fault
is happening by running `gdb ./build/src/test/test_bitcoin` and then using the `bt` command
is happening by running `gdb ./build/bin/test_bitcoin` and then using the `bt` command
within gdb.
Another tool that can be used to resolve segmentation faults is
@@ -162,7 +162,7 @@ Running the tests and hitting a segmentation fault should now produce a file cal
You can then explore the core dump using
```bash
gdb build/src/test/test_bitcoin core
gdb build/bin/test_bitcoin core
(gdb) bt # produce a backtrace for where a segfault occurred
```