libbacktrace: update README

This commit is contained in:
Ian Lance Taylor
2020-10-26 13:45:23 -07:00
parent 73eb1803b1
commit f24e9f401f

View File

@@ -10,6 +10,8 @@ The libbacktrace library may be linked into a program or library and
used to produce symbolic backtraces. used to produce symbolic backtraces.
Sample uses would be to print a detailed backtrace when an error Sample uses would be to print a detailed backtrace when an error
occurs or to gather detailed profiling information. occurs or to gather detailed profiling information.
In general the functions provided by this library are async-signal-safe,
meaning that they may be safely called from a signal handler.
The libbacktrace library is provided under a BSD license. The libbacktrace library is provided under a BSD license.
See the source files for the exact license text. See the source files for the exact license text.
@@ -23,11 +25,12 @@ will work.
See the source file backtrace-supported.h.in for the macros that it See the source file backtrace-supported.h.in for the macros that it
defines. defines.
As of January 2018, libbacktrace only supports ELF, PE/COFF, and XCOFF As of October 2020, libbacktrace supports ELF, PE/COFF, Mach-O, and
executables with DWARF debugging information. XCOFF executables with DWARF debugging information.
In other words, it supports GNU/Linux, *BSD, macOS, Windows, and AIX.
The library is written to make it straightforward to add support for The library is written to make it straightforward to add support for
other object file and debugging formats. other object file and debugging formats.
The library relies on the C++ unwind API defined at The library relies on the C++ unwind API defined at
https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html
This API is provided by GCC. This API is provided by GCC and clang.