luo980/cpptrace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update note about debug symbols being needed

Browse Source
This commit is contained in:
Jeremy 2024-03-15 17:39:23 -05:00
parent 6a8ff75fc1
commit 92be6c23f1
No known key found for this signature in database
GPG Key ID: 19AA8270105E8EB4
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -141,14 +141,18 @@ thrown, and providing an API for safe tracing from signal handlers.
# In-Depth Documentation # In-Depth Documentation
## Prerequisites
> [!IMPORTANT]
> Debug info (`-g`/`/Z7`/`/Zi`/`/DEBUG`/`-DBUILD_TYPE=Debug`/`-DBUILD_TYPE=RelWithDebInfo`) is required for complete
> trace information.
## `namespace cpptrace` ## `namespace cpptrace`
`cpptrace::generate_trace()` can be used to generate a stacktrace object at the current call site. Resolved frames can `cpptrace::generate_trace()` can be used to generate a stacktrace object at the current call site. Resolved frames can
be accessed from this object with `.frames` and also the trace can be printed with `.print()`. Cpptrace also provides a be accessed from this object with `.frames` and also the trace can be printed with `.print()`. Cpptrace also provides a
method to get lightweight raw traces, which are just vectors of program counters, which can be resolved at a later time. method to get lightweight raw traces, which are just vectors of program counters, which can be resolved at a later time.
**Note:** Debug info (`-g`/`/Z7`/`/Zi`/`/DEBUG`) is generally required for good trace information.
All functions are thread-safe unless otherwise noted. All functions are thread-safe unless otherwise noted.
### Stack Traces ### Stack Traces