Skip to content
Snippets Groups Projects
Commit f535f9d7 authored by Ian Lance Taylor's avatar Ian Lance Taylor
Browse files

libbacktrace: update README 

	PR libbacktrace/105721
	* README: Update.
parent 65aebf19
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 20 additions and 12 deletions
libbacktrace/README
+ 20
− 12
View file @ f535f9d7
The libbacktrace library The libbacktrace library
Initially written by Ian Lance Taylor <iant@google.com> Initially written by Ian Lance Taylor <iant@golang.org>
The libbacktrace library may be linked into a program or library and The libbacktrace library may be linked into a program or library and
used to produce symbolic backtraces. Sample uses would be to print a used to produce symbolic backtraces.
detailed backtrace when an error occurs or to gather detailed Sample uses would be to print a detailed backtrace when an error
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. See the The libbacktrace library is provided under a BSD license.
source files for the exact license text. See the source files for the exact license text.
The public functions are declared and documented in the header file The public functions are declared and documented in the header file
backtrace.h, which should be #include'd by a user of the library. backtrace.h, which should be #include'd by a user of the library.
Building libbacktrace will generate a file backtrace-supported.h, Building libbacktrace will generate a file backtrace-supported.h,
which a user of the library may use to determine whether backtraces which a user of the library may use to determine whether backtraces
will work. See the source file backtrace-supported.h.in for the will work.
macros that it defines. See the source file backtrace-supported.h.in for the macros that it
defines.
As of September 2012, libbacktrace only supports ELF executables with As of October 2020, libbacktrace supports ELF, PE/COFF, Mach-O, and
DWARF debugging information. The library is written to make it XCOFF executables with DWARF debugging information.
straightforward to add support for other object file and debugging In other words, it supports GNU/Linux, *BSD, macOS, Windows, and AIX.
formats. The library is written to make it straightforward to add support for
other object file and debugging formats.
The library relies on the C++ unwind API defined at
https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html
This API is provided by GCC and clang.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment