Skip to content

Commit c0eb25a

Browse files
committed
add additional debug info documentation
1 parent b421487 commit c0eb25a

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

docs/guide/types/debuginfo.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,17 @@ For PDBs, Binary Ninja will automatically try to source from specified local fol
1212

1313
DWARF supports information compiled in to ELF binaries, information from external ELF files (`.dwo`, `.debug`, etc), information compiled in to Mach-O's, and information from external `.dSYM` files as well. Support for DWARF information in PEs is [planned](https://github.com/Vector35/binaryninja-api/issues/1555).
1414

15-
## Applying debug info
15+
## Applying Debug Info
1616

17-
## Not applying debug info
17+
Debug Info is automatically applied by default if applicable.
1818

19-
You can control if debug information is imported for a file by changing the setting "Import Debug Information" (`analysis.debugInfo.internal`). You can import debug information at any point later by using the menu action `Analysis` -> `Import Debug Info`.
19+
![Import Debug Info >](../../img/import-debug-info.png "Import Debug Info"){ width="300" }
20+
21+
However, for some file formats, you may wish to specify an external source of Debug Info using the `Import Debug Info from External File` menu option under `Analysis`.
22+
23+
## Blocking Debug Info
24+
25+
You can control if debug information is imported for a file by changing the setting "Import Debug Information" ([`analysis.debugInfo.internal`](https://docs.binary.ninja/guide/settings.html#analysis.debugInfo.internal)). You can import debug information at any point later by using the menu action `Analysis` -> `Import Debug Info`.
2026

2127
### PDB Notes
2228

@@ -41,7 +47,3 @@ Our [DWARF Export plugin](https://github.com/Vector35/binaryninja-api/tree/dev/r
4147
`.dSYM` packages are often provided as application bundles. Binary Ninja currently does not support extracting the actual `.dSYM` file out of the package for parsing, so you may need to provide a full path for Binary Ninja to correctly parse.
4248

4349
For example, you could have the file `hello.macho` that you would like to import debug info for. Thankfully, you also have `hello.dSYM`. So you open `hello.macho` with options, find the "External Debug Info File" and provide the `hello.dSYM` file. When the file opens, you notice that no information was imported and the log reads "No available/valid parsers for file." This is because `hello.dSYM` is a bundle. The actual path you needed to provide for the "External Debug Info File" setting would look something like `hello.dSYM/Contents/Resources/DWARF/hello`.
44-
45-
### Importing from External Files
46-
47-
If Binary Ninja chooses the wrong PDB to import debug information from, or you have an external DWARF file you with to import the debug information from, you'll need to explicitly set the "External Debug Info File" setting field (`analysis.debugInfo.external`), or use the menu action `Analysis` -> `Import Debug Info from External File`.

docs/img/import-debug-info.png

83.1 KB
Loading

0 commit comments

Comments
 (0)