mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-04-29 14:59:39 -04:00
doc: add info for debugging with relative paths
This commit is contained in:
parent
a8b515c317
commit
0bc666b053
1 changed files with 30 additions and 0 deletions
|
@ -12,6 +12,7 @@ Developer Notes
|
||||||
- [Generating Documentation](#generating-documentation)
|
- [Generating Documentation](#generating-documentation)
|
||||||
- [Development tips and tricks](#development-tips-and-tricks)
|
- [Development tips and tricks](#development-tips-and-tricks)
|
||||||
- [Compiling for debugging](#compiling-for-debugging)
|
- [Compiling for debugging](#compiling-for-debugging)
|
||||||
|
- [Show sources in debugging](#show-sources-in-debugging)
|
||||||
- [Compiling for gprof profiling](#compiling-for-gprof-profiling)
|
- [Compiling for gprof profiling](#compiling-for-gprof-profiling)
|
||||||
- [`debug.log`](#debuglog)
|
- [`debug.log`](#debuglog)
|
||||||
- [Signet, testnet, and regtest modes](#signet-testnet-and-regtest-modes)
|
- [Signet, testnet, and regtest modes](#signet-testnet-and-regtest-modes)
|
||||||
|
@ -249,6 +250,35 @@ Development tips and tricks
|
||||||
Run configure with `--enable-debug` to add additional compiler flags that
|
Run configure with `--enable-debug` to add additional compiler flags that
|
||||||
produce better debugging builds.
|
produce better debugging builds.
|
||||||
|
|
||||||
|
### Show sources in debugging
|
||||||
|
|
||||||
|
If you have ccache enabled, absolute paths are stripped from debug information
|
||||||
|
with the -fdebug-prefix-map and -fmacro-prefix-map options (if supported by the
|
||||||
|
compiler). This might break source file detection in case you move binaries
|
||||||
|
after compilation, debug from the directory other than the project root or use
|
||||||
|
an IDE that only supports absolute paths for debugging.
|
||||||
|
|
||||||
|
There are a few possible fixes:
|
||||||
|
|
||||||
|
1. Configure source file mapping.
|
||||||
|
|
||||||
|
For `gdb` create or append to `.gdbinit` file:
|
||||||
|
```
|
||||||
|
set substitute-path ./src /path/to/project/root/src
|
||||||
|
```
|
||||||
|
|
||||||
|
For `lldb` create or append to `.lldbinit` file:
|
||||||
|
```
|
||||||
|
settings set target.source-map ./src /path/to/project/root/src
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Add a symlink to the `./src` directory:
|
||||||
|
```
|
||||||
|
ln -s /path/to/project/root/src src
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Use `debugedit` to modify debug information in the binary.
|
||||||
|
|
||||||
### Compiling for gprof profiling
|
### Compiling for gprof profiling
|
||||||
|
|
||||||
Run configure with the `--enable-gprof` option, then make.
|
Run configure with the `--enable-gprof` option, then make.
|
||||||
|
|
Loading…
Add table
Reference in a new issue