xref: /netbsd-src/external/gpl3/gcc/dist/libbacktrace/README (revision 48fb7bfab72acd4281a53bbee5ccf3f809019e75)
1*48fb7bfaSmrgThe libbacktrace library
2*48fb7bfaSmrgInitially written by Ian Lance Taylor <iant@google.com>
3*48fb7bfaSmrg
4*48fb7bfaSmrgThe libbacktrace library may be linked into a program or library and
5*48fb7bfaSmrgused to produce symbolic backtraces.  Sample uses would be to print a
6*48fb7bfaSmrgdetailed backtrace when an error occurs or to gather detailed
7*48fb7bfaSmrgprofiling information.
8*48fb7bfaSmrg
9*48fb7bfaSmrgThe libbacktrace library is provided under a BSD license.  See the
10*48fb7bfaSmrgsource files for the exact license text.
11*48fb7bfaSmrg
12*48fb7bfaSmrgThe public functions are declared and documented in the header file
13*48fb7bfaSmrgbacktrace.h, which should be #include'd by a user of the library.
14*48fb7bfaSmrg
15*48fb7bfaSmrgBuilding libbacktrace will generate a file backtrace-supported.h,
16*48fb7bfaSmrgwhich a user of the library may use to determine whether backtraces
17*48fb7bfaSmrgwill work.  See the source file backtrace-supported.h.in for the
18*48fb7bfaSmrgmacros that it defines.
19*48fb7bfaSmrg
20*48fb7bfaSmrgAs of September 2012, libbacktrace only supports ELF executables with
21*48fb7bfaSmrgDWARF debugging information.  The library is written to make it
22*48fb7bfaSmrgstraightforward to add support for other object file and debugging
23*48fb7bfaSmrgformats.
24