source: general/prog/gdb.xml@ 8e266c6

perl-modules
Last change on this file since 8e266c6 was 8e266c6, checked in by Pierre Labastie <pieere@…>, 3 years ago

Merge r20475 to r20480 from trunk

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/perl-modules@20481 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 8.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gdb-download-http "&gnu-http;/gdb/gdb-&gdb-version;.tar.xz">
8 <!ENTITY gdb-download-ftp "&gnu-ftp;/gdb/gdb-&gdb-version;.tar.xz">
9 <!ENTITY gdb-md5sum "b5a49dbff00d9a87fbe114d14b3101c0">
10 <!ENTITY gdb-size "19 MB">
11 <!ENTITY gdb-buildsize "600 MB (add 59 MB for tests, add 728 MB for docs)">
12 <!ENTITY gdb-time "1.8 SBU (Using parallelism=4; add 65 SBU for tests, add 0.6 SBU for docs)">
13]>
14
15<sect1 id="gdb" xreflabel="GDB-&gdb-version;">
16 <?dbhtml filename="gdb.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>GDB-&gdb-version;</title>
24
25 <indexterm zone="gdb">
26 <primary sortas="a-GDB">GDB</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to GDB</title>
31
32 <para>
33 <application>GDB</application>, the GNU Project debugger, allows you
34 to see what is going on <quote>inside</quote> another program while it
35 executes -- or what another program was doing at the moment it crashed.
36 Note that <application>GDB</application> is most effective when tracing
37 programs and libraries that were built with debugging symbols and not
38 stripped.
39 </para>
40
41 &lfs83_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&gdb-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&gdb-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &gdb-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &gdb-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &gdb-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &gdb-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">GDB Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Optional</bridgehead>
80 <para role="optional">
81 <xref linkend="dejagnu"/> (required for tests),
82 <xref linkend="doxygen"/>,
83 <xref linkend="gcc"/> (ada and gfortran are used for tests),
84 <xref linkend="guile"/>,
85 <xref linkend="python2"/>,
86 <xref linkend="rust"/> (used for some tests),
87 <xref linkend="valgrind"/>, and
88 <ulink url="https://sourceware.org/systemtap/">SystemTap</ulink>
89 (run-time, used for tests)
90 </para>
91
92 <para condition="html" role="usernotes">User Notes:
93 <ulink url="&blfs-wiki;/gdb"/>
94 </para>
95 </sect2>
96
97 <sect2 role="installation">
98 <title>Installation of GDB</title>
99
100 <para>
101 Install <application>GDB</application> by running the following
102 commands:
103 </para>
104
105<screen><userinput>./configure --prefix=/usr --with-system-readline &amp;&amp;
106make</userinput></screen>
107
108 <para>
109 Optionally, to build the API documentation using
110 <xref linkend="doxygen"/>, run:
111 </para>
112
113<screen><userinput>make -C gdb/doc doxy</userinput></screen>
114
115 <para>
116 To test the results, issue:
117 </para>
118
119<screen><userinput>pushd gdb/testsuite &amp;&amp;
120make site.exp &amp;&amp;
121echo "set gdb_test_timeout 120" &gt;&gt; site.exp &amp;&amp;
122runtest TRANSCRIPT=y
123popd</userinput></screen>
124
125 <para>
126 See <emphasis>gdb/testsuite/README</emphasis> and <ulink
127 url="https://sourceware.org/gdb/wiki/TestingGDB">TestingGDB</ulink>.
128 There are many problems with the test suite:
129 </para>
130
131 <itemizedlist>
132 <listitem>
133 <para>
134 Clean directories are needed if re-running the tests. For that
135 reason, it is recommended to make a copy of the compiled source code
136 directory before the tests in case you need to run the tests again.
137 </para>
138 </listitem>
139
140 <listitem>
141 <para>
142 Results depend on installed compilers.
143 </para>
144 </listitem>
145
146<!-- They worked fine for me. [renodr] 7.11.1 -->
147
148<!--
149 <listitem>
150 <para>
151 If run remotely over an ssh connection, the tests will hang
152 and require a hard (power cycle) reset of the system.
153 </para>
154 </listitem>
155-->
156
157 <listitem>
158 <para>
159 There are a large number of timeouts (there is a variable
160 that can be set to increase time for timeout, but
161 changing it will result in a different number of tests being
162 run).
163 </para>
164 </listitem>
165
166 <listitem>
167 <para>
168 There are failures associated with system readline 6.x.
169 </para>
170 </listitem>
171
172 <listitem>
173 <para>
174 A few tests assume that the header file
175 <filename>&lt;sys/sdt.h&gt;</filename>, part of <ulink
176 url="https://sourceware.org/systemtap/">SystemTap</ulink>, is
177 present.
178 </para>
179 </listitem>
180
181 <listitem>
182 <para>
183 Approximately 1-3% of the tests fail (out of over 53000 tests).
184 </para>
185 </listitem>
186
187 </itemizedlist>
188
189 <para>
190 Now, as the <systemitem class="username">root</systemitem> user:
191 </para>
192
193<screen role="root"><userinput>make -C gdb install</userinput></screen>
194
195 <para>
196 If you have built the API documentation, it is now in gdb/doc/doxy.
197 You can install it (as the <systemitem class="username">root</systemitem>
198 user):
199 </para>
200
201<screen role="root"><userinput>install -d /usr/share/doc/gdb-&gdb-version; &amp;&amp;
202rm -rf gdb/doc/doxy/xml &amp;&amp;
203cp -Rv gdb/doc/doxy /usr/share/doc/gdb-&gdb-version;</userinput></screen>
204
205 </sect2>
206
207 <sect2 role="commands">
208 <title>Command Explanations</title>
209
210 <para>
211 <parameter>--with-system-readline</parameter>: This switch forces
212 <application>GDB</application> to use the copy of
213 <application>Readline</application> installed in LFS.
214 </para>
215
216 </sect2>
217
218 <sect2 role="content">
219 <title>Contents</title>
220
221 <segmentedlist>
222 <segtitle>Installed Programs</segtitle>
223 <segtitle>Installed Library</segtitle>
224 <segtitle>Installed Directories</segtitle>
225
226 <seglistitem>
227 <seg>
228 gcore, gdb and gdbserver
229 </seg>
230 <seg>
231 libinproctrace.so
232 </seg>
233 <seg>
234 /usr/{include,share}/gdb and /usr/share/doc/gdb-&gdb-version;
235 </seg>
236 </seglistitem>
237 </segmentedlist>
238
239 <variablelist>
240 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
241 <?dbfo list-presentation="list"?>
242 <?dbhtml list-presentation="table"?>
243
244 <varlistentry id="gcore">
245 <term><command>gcore</command></term>
246 <listitem>
247 <para>
248 generates a core dump of a running program.
249 </para>
250 <indexterm zone="gdb gcore">
251 <primary sortas="b-gcore">gcore</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="gdb-prog">
257 <term><command>gdb</command></term>
258 <listitem>
259 <para>
260 is the GNU Debugger.
261 </para>
262 <indexterm zone="gdb gdb-prog">
263 <primary sortas="b-gdb-prog">gdb-prog</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="gdbserver">
269 <term><command>gdbserver</command></term>
270 <listitem>
271 <para>
272 is a remote server for the GNU debugger (it allows programs
273 to be debugged from a different machine).
274 </para>
275 <indexterm zone="gdb gdbserver">
276 <primary sortas="b-gdbserver">gdbserver</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="libinproctrace">
282 <term><filename class="libraryfile">libinproctrace.so</filename></term>
283 <listitem>
284 <para>
285 contains functions for the in-process tracing agent. The agent
286 allows for installing fast tracepoints, listing static tracepoint
287 markers, probing static tracepoints markers, and starting trace
288 monitoring.
289 </para>
290 <indexterm zone="gdb libinproctrace">
291 <primary sortas="c-libinproctrace">libinproctrace.so</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 </variablelist>
297
298 </sect2>
299
300</sect1>
Note: See TracBrowser for help on using the repository browser.