Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation for breakpad symbol format #638

Open
willkg opened this issue Aug 28, 2023 · 4 comments
Open

documentation for breakpad symbol format #638

willkg opened this issue Aug 28, 2023 · 4 comments

Comments

@willkg
Copy link
Member

willkg commented Aug 28, 2023

This project should either document the breakpad symbol format and whatever additional things it's doing or link to documentation for that somewhere.

The breakpad docs have this:

https://chromium.googlesource.com/breakpad/breakpad/+/master/docs/symbol_files.md

However, that doesn't talk about the INFO lines that dump_syms adds. Are there other enhancements dump_syms does?

@willkg
Copy link
Member Author

willkg commented Sep 6, 2023

For sym files for Windows modules, it adds:

INFO CODE_ID [code_id] [code_file]

For sym files for non-Windows modules, it may add:

INFO CODE_ID [code_id]

but the code_id isn't meaningful.

dump_syms also adds a line about the generator which was added in #501 for dump_syms v2.1.0 (November 2022):

INFO GENERATOR [name] [version]

@willkg
Copy link
Member Author

willkg commented Jun 11, 2024

The Breakpad symbol_files.md doc also doesn't talk about inline function data. What other things does it not cover that dump_syms does?

@mstange
Copy link
Collaborator

mstange commented Jun 11, 2024

The URL points to the master branch, but that repo has switched to the main branch. Here's the up-to-data URL:

https://chromium.googlesource.com/breakpad/breakpad/+/main/docs/symbol_files.md

This one does talk about the inline data. But it does not have the INFO fields.

@gabrielesvelto
Copy link
Collaborator

We've added most INFO fields ourselves, so we'll have to document them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants