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

Another small readme update

Browse Source
This commit is contained in:
Jeremy Rifkin 2024-10-06 14:35:54 -05:00
parent daa2c53042
commit 0d2cb217bf
No known key found for this signature in database
GPG Key ID: 19AA8270105E8EB4
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -33,10 +33,10 @@ Cpptrace also has a C API, docs [here](docs/c-api.md).
- [How it works](#how-it-works) - [How it works](#how-it-works)
- [Performance](#performance) - [Performance](#performance)
- [Traced Exception Objects](#traced-exception-objects) - [Traced Exception Objects](#traced-exception-objects)
- [Wrapping std::exceptions](#wrapping-stdexceptions) - [Wrapping std::exceptions](#wrapping-stdexceptions)
- [Exception handling with cpptrace](#exception-handling-with-cpptrace) - [Exception handling with cpptrace](#exception-handling-with-cpptrace)
- [Signal-Safe Tracing](#signal-safe-tracing) - [Signal-Safe Tracing](#signal-safe-tracing)
- [Utility Types](#utility-types) - [Utility Types](#utility-types)
- [Supported Debug Formats](#supported-debug-formats) - [Supported Debug Formats](#supported-debug-formats)
- [How to Include The Library](#how-to-include-the-library) - [How to Include The Library](#how-to-include-the-library)
- [CMake FetchContent](#cmake-fetchcontent) - [CMake FetchContent](#cmake-fetchcontent)
@ -612,7 +612,7 @@ namespace cpptrace {
} }
``` ```
# Wrapping std::exceptions ### Wrapping std::exceptions
> [!NOTE] > [!NOTE]
> This section is largely obsolete now that cpptrace provides a better mechanism for collecting > This section is largely obsolete now that cpptrace provides a better mechanism for collecting
@ -633,7 +633,7 @@ CPPTRACE_WRAP_BLOCK(
std::cout<<CPPTRACE_WRAP(foo.at(12))<<std::endl; std::cout<<CPPTRACE_WRAP(foo.at(12))<<std::endl;
``` ```
# Exception handling with cpptrace ### Exception handling with cpptrace
> [!NOTE] > [!NOTE]
> This section pertains to cpptrace traced exception objects and not the mechanism for collecting > This section pertains to cpptrace traced exception objects and not the mechanism for collecting
@ -664,7 +664,7 @@ To register this custom handler:
cpptrace::register_terminate_handler(); cpptrace::register_terminate_handler();
``` ```
# Signal-Safe Tracing ## Signal-Safe Tracing
Signal-safe stack tracing is very useful for debugging application crashes, e.g. SIGSEGVs or Signal-safe stack tracing is very useful for debugging application crashes, e.g. SIGSEGVs or
SIGTRAPs, but it's very difficult to do correctly and most implementations I see online do this SIGTRAPs, but it's very difficult to do correctly and most implementations I see online do this
@ -711,7 +711,7 @@ namespace cpptrace {
Because signal-safe tracing is an involved process, I have written up a comprehensive overview of Because signal-safe tracing is an involved process, I have written up a comprehensive overview of
what is involved at [signal-safe-tracing.md](docs/signal-safe-tracing.md). what is involved at [signal-safe-tracing.md](docs/signal-safe-tracing.md).
# Utility Types ## Utility Types
A couple utility types are used to provide the library with a good interface. A couple utility types are used to provide the library with a good interface.