xref: /netbsd-src/external/gpl3/gcc.old/dist/libbacktrace/README (revision 36ac495d2b3ea2b9d96377b2143ebfedac224b92)
1*36ac495dSmrgThe libbacktrace library
2*36ac495dSmrgInitially written by Ian Lance Taylor <iant@google.com>
3*36ac495dSmrg
4*36ac495dSmrgThe libbacktrace library may be linked into a program or library and
5*36ac495dSmrgused to produce symbolic backtraces.  Sample uses would be to print a
6*36ac495dSmrgdetailed backtrace when an error occurs or to gather detailed
7*36ac495dSmrgprofiling information.
8*36ac495dSmrg
9*36ac495dSmrgThe libbacktrace library is provided under a BSD license.  See the
10*36ac495dSmrgsource files for the exact license text.
11*36ac495dSmrg
12*36ac495dSmrgThe public functions are declared and documented in the header file
13*36ac495dSmrgbacktrace.h, which should be #include'd by a user of the library.
14*36ac495dSmrg
15*36ac495dSmrgBuilding libbacktrace will generate a file backtrace-supported.h,
16*36ac495dSmrgwhich a user of the library may use to determine whether backtraces
17*36ac495dSmrgwill work.  See the source file backtrace-supported.h.in for the
18*36ac495dSmrgmacros that it defines.
19*36ac495dSmrg
20*36ac495dSmrgAs of September 2012, libbacktrace only supports ELF executables with
21*36ac495dSmrgDWARF debugging information.  The library is written to make it
22*36ac495dSmrgstraightforward to add support for other object file and debugging
23*36ac495dSmrgformats.
24