2015-01-14 Sandra Loosemore <sandra@codesourcery.com>
[official-gcc.git] / libbacktrace / README
blobe8b225745c9c639e67ea4f6fa0f97041ba978276
1 The libbacktrace library
2 Initially written by Ian Lance Taylor <iant@google.com>
4 The libbacktrace library may be linked into a program or library and
5 used to produce symbolic backtraces.  Sample uses would be to print a
6 detailed backtrace when an error occurs or to gather detailed
7 profiling information.
9 The libbacktrace library is provided under a BSD license.  See the
10 source files for the exact license text.
12 The public functions are declared and documented in the header file
13 backtrace.h, which should be #include'd by a user of the library.
15 Building libbacktrace will generate a file backtrace-supported.h,
16 which a user of the library may use to determine whether backtraces
17 will work.  See the source file backtrace-supported.h.in for the
18 macros that it defines.
20 As of September 2012, libbacktrace only supports ELF executables with
21 DWARF debugging information.  The library is written to make it
22 straightforward to add support for other object file and debugging
23 formats.