annotate libbacktrace/README @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 04ced10e8804
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 The libbacktrace library
kono
parents:
diff changeset
2 Initially written by Ian Lance Taylor <iant@google.com>
kono
parents:
diff changeset
3
kono
parents:
diff changeset
4 The libbacktrace library may be linked into a program or library and
kono
parents:
diff changeset
5 used to produce symbolic backtraces. Sample uses would be to print a
kono
parents:
diff changeset
6 detailed backtrace when an error occurs or to gather detailed
kono
parents:
diff changeset
7 profiling information.
kono
parents:
diff changeset
8
kono
parents:
diff changeset
9 The libbacktrace library is provided under a BSD license. See the
kono
parents:
diff changeset
10 source files for the exact license text.
kono
parents:
diff changeset
11
kono
parents:
diff changeset
12 The public functions are declared and documented in the header file
kono
parents:
diff changeset
13 backtrace.h, which should be #include'd by a user of the library.
kono
parents:
diff changeset
14
kono
parents:
diff changeset
15 Building libbacktrace will generate a file backtrace-supported.h,
kono
parents:
diff changeset
16 which a user of the library may use to determine whether backtraces
kono
parents:
diff changeset
17 will work. See the source file backtrace-supported.h.in for the
kono
parents:
diff changeset
18 macros that it defines.
kono
parents:
diff changeset
19
kono
parents:
diff changeset
20 As of September 2012, libbacktrace only supports ELF executables with
kono
parents:
diff changeset
21 DWARF debugging information. The library is written to make it
kono
parents:
diff changeset
22 straightforward to add support for other object file and debugging
kono
parents:
diff changeset
23 formats.