Merge branch 'vendor/LIBARCHIVE'
[dragonfly.git] / contrib / binutils-2.17 / bfd / doc / core.texi
1 @section Core files
2
3
4 @subsection Core file functions
5
6
7 @strong{Description}@*
8 These are functions pertaining to core files.
9
10 @findex bfd_core_file_failing_command
11 @subsubsection @code{bfd_core_file_failing_command}
12 @strong{Synopsis}
13 @example
14 const char *bfd_core_file_failing_command (bfd *abfd);
15 @end example
16 @strong{Description}@*
17 Return a read-only string explaining which program was running
18 when it failed and produced the core file @var{abfd}.
19
20 @findex bfd_core_file_failing_signal
21 @subsubsection @code{bfd_core_file_failing_signal}
22 @strong{Synopsis}
23 @example
24 int bfd_core_file_failing_signal (bfd *abfd);
25 @end example
26 @strong{Description}@*
27 Returns the signal number which caused the core dump which
28 generated the file the BFD @var{abfd} is attached to.
29
30 @findex core_file_matches_executable_p
31 @subsubsection @code{core_file_matches_executable_p}
32 @strong{Synopsis}
33 @example
34 bfd_boolean core_file_matches_executable_p
35    (bfd *core_bfd, bfd *exec_bfd);
36 @end example
37 @strong{Description}@*
38 Return @code{TRUE} if the core file attached to @var{core_bfd}
39 was generated by a run of the executable file attached to
40 @var{exec_bfd}, @code{FALSE} otherwise.
41
42 @findex generic_core_file_matches_executable_p
43 @subsubsection @code{generic_core_file_matches_executable_p}
44 @strong{Synopsis}
45 @example
46 bfd_boolean generic_core_file_matches_executable_p
47    (bfd *core_bfd, bfd *exec_bfd);
48 @end example
49 @strong{Description}@*
50 Return TRUE if the core file attached to @var{core_bfd}
51 was generated by a run of the executable file attached
52 to @var{exec_bfd}.  The match is based on executable
53 basenames only.
54
55 Note: When not able to determine the core file failing
56 command or the executable name, we still return TRUE even
57 though we're not sure that core file and executable match.
58 This is to avoid generating a false warning in situations
59 where we really don't know whether they match or not.
60