doc: Remove outdated -fdebug-prefix-map section in dev notes
What the developer wrote
Authored by MarcoFalke
doc: Remove outdated -fdebug-prefix-map section in dev notes
The section claims to be for ccache builds, however those are already
fixed after commit 1cc58d3a0c653ac30df04d1010a3cf84c6bc307a.
If there are still any build or debug problems after that commit,
dedicated instructions can be added back, along with exact steps to
reproduce and test.
What changed, and why it matters
This commit simply deletes an outdated documentation section from the developer notes. It removes instructions about debugging source paths when using ccache, because a previous code change already fixed the underlying issue. There is no code change, no security fix, and no vulnerability introduced or addressed.
No security action needed. This is a routine documentation cleanup. Reviewers may optionally verify that the referenced prior commit (1cc58d3a0c653ac30df04d1010a3cf84c6bc307a) indeed resolved the ccache debug-prefix issue, but that is outside the scope of this change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit removes a 31-line subsection titled ‘Show sources in debugging’ from doc/developer-notes.md. The removed text described how ccache builds stripped absolute source paths via -fdebug-prefix-map/-fmacro-prefix-map and offered workarounds for gdb/lldb/IDEs. The commit message states this is no longer needed because commit 1cc58d3a0c653ac30df04d1010a3cf84c6bc307a already addressed ccache builds. The diff contains only documentation deletions.
Changed components
doc/developer-notes.mdInspect captured patch +0 / −31
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index b8a16ec0..97ffc0cd 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -305,37 +305,6 @@ If you need to build exclusively for debugging, set the `-DCMAKE_BUILD_TYPE`
to `Debug` (i.e. `-DCMAKE_BUILD_TYPE=Debug`). You can always check the cmake
build options of an existing build with `ccmake build`.
-### 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 (e.g. it won't stop at breakpoints).
-
-There are a few possible fixes:
-
-1. Configure source file mapping.
-
-For `gdb` create or append to [`.gdbinit` file](https://sourceware.org/gdb/current/onlinedocs/gdb#gdbinit-man):
-```
-set substitute-path ./src /path/to/project/root/src
-```
-
-For `lldb` create or append to [`.lldbinit` file](https://lldb.llvm.org/man/lldb.html#configuration-files):
-```
-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.
-
-4. If your IDE has an option for this, change your breakpoints to use the file name only.
-
### debug.log
If the code is behaving strangely, take a look in the `debug.log` file in the data directory;
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.