source: general/prog/gdb.xml@ f863fd7d

11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since f863fd7d was f863fd7d, checked in by Bruce Dubbs <bdubbs@…>, 8 months ago

Document the number of fortran failures

  • Property mode set to 100644
File size: 9.9 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 "257cb0f67927f79acf636d8c01e19990">
10 <!ENTITY gdb-size "21 MB">
11 <!ENTITY gdb-buildsize "811 MB (add 777 MB for docs; add 536 MB for tests)">
12 <!ENTITY gdb-time "1.9 SBU (Using parallelism=4; add 23 SBU for tests; add 0.5 SBU for docs)">
13]>
14
15<!-- I skipped running the full tests for this 8.3.1 point version. Bruce -->
16
17<sect1 id="gdb" xreflabel="GDB-&gdb-version;">
18 <?dbhtml filename="gdb.html"?>
19
20 <sect1info>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>GDB-&gdb-version;</title>
25
26 <indexterm zone="gdb">
27 <primary sortas="a-GDB">GDB</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to GDB</title>
32
33 <para>
34 <application>GDB</application>, the GNU Project debugger, allows you
35 to see what is going on <quote>inside</quote> another program while it
36 executes -- or what another program was doing at the moment it crashed.
37 Note that <application>GDB</application> is most effective when tracing
38 programs and libraries that were built with debugging symbols and not
39 stripped.
40 </para>
41
42 &lfs110a_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&gdb-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&gdb-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &gdb-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &gdb-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &gdb-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &gdb-time;
74 </para>
75 </listitem>
76 </itemizedlist>
77
78 <bridgehead renderas="sect3">GDB Dependencies</bridgehead>
79
80 <bridgehead renderas="sect4">Recommended Runtime Dependency</bridgehead>
81 <para role="recommended">
82 <xref linkend="six"/> (Python 3 module, required at run-time to
83 use GDB scripts from various LFS/BLFS packages with Python 3
84 installed in LFS)
85 </para>
86
87 <bridgehead renderas="sect4">Optional</bridgehead>
88 <para role="optional">
89 <!-- <xref linkend="dejagnu"/> (required for tests), -->
90 <xref linkend="doxygen"/>,
91 <xref linkend="gcc"/> (ada, gfortran, and go are used for tests),
92 <xref linkend="guile"/>,
93 <xref linkend="python2"/>,
94 <xref linkend="rust"/> (used for some tests),
95 <xref linkend="valgrind"/>, and
96 <ulink url="https://sourceware.org/systemtap/">SystemTap</ulink>
97 (run-time, used for tests)
98 </para>
99
100 <para condition="html" role="usernotes">User Notes:
101 <ulink url="&blfs-wiki;/gdb"/>
102 </para>
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of GDB</title>
107
108 <para>
109 Install <application>GDB</application> by running the following
110 commands:
111 </para>
112
113<screen><userinput>mkdir build &amp;&amp;
114cd build &amp;&amp;
115
116../configure --prefix=/usr \
117 --with-system-readline \
118 --with-python=/usr/bin/python3 &amp;&amp;
119make</userinput></screen>
120
121 <para>
122 Optionally, to build the API documentation using
123 <xref linkend="doxygen"/>, run:
124 </para>
125
126<screen remap="doc"><userinput>make -C gdb/doc doxy</userinput></screen>
127
128 <para>
129 To test the results, issue:
130 </para>
131
132<screen remap="test"><userinput>pushd gdb/testsuite &amp;&amp;
133make site.exp &amp;&amp;
134echo "set gdb_test_timeout 120" &gt;&gt; site.exp &amp;&amp;
135runtest
136popd</userinput></screen>
137
138 <para>
139 See <emphasis>gdb/testsuite/README</emphasis> and <ulink
140 url="https://sourceware.org/gdb/wiki/TestingGDB">TestingGDB</ulink>.
141 There are many problems with the test suite:
142 </para>
143
144 <itemizedlist>
145 <listitem>
146 <para>
147 Clean directories are needed if re-running the tests. For that
148 reason, make a copy of the compiled source code
149 directory before the tests in case you need to run the tests again.
150 </para>
151 </listitem>
152
153 <listitem>
154 <para>
155 Results depend on installed compilers.
156 </para>
157 </listitem>
158<!-- I did not see this
159 <listitem>
160 <para>
161 There are a large number of timeouts (there is a variable
162 that can be set to increase time for timeout, but
163 changing it will result in a different number of tests being
164 run).
165 </para>
166 </listitem>
167or this
168 <listitem>
169 <para>
170 There are failures associated with system readline 6.x.
171 </para>
172 </listitem>
173-->
174 <listitem>
175 <para>
176 A few tests assume that the header file
177 <filename>&lt;sys/sdt.h&gt;</filename>, part of <ulink
178 url="https://sourceware.org/systemtap/">SystemTap</ulink>, is
179 present.
180 </para>
181 </listitem>
182<!-- I don't know if this is true or not. I tested on a Haswell.
183 <listitem>
184 <para>
185 If the test suite is run on a Skylake-based Intel CPU or newer,
186 many tests will fail due to the removal of the deprecated/problematic
187 libmpx library in GCC.
188 </para>
189 </listitem>
190-->
191 <listitem>
192 <para>
193<!-- for gdb-11.1, gcc-11.2 - pierre -->
194 A test run of the test suite had about 1700 unexpected failures
195 (out of over 80000 tests). Over 1370 of the failures were related
196 to FORTRAN tests.
197 </para>
198 </listitem>
199
200 <listitem>
201 <para>
202 On some systems, the gdb.tui test suite will fail if running over
203 SSH.
204 </para>
205 </listitem>
206
207 <listitem>
208 <para>
209 On some AMD-based systems, over 200 additional tests
210 may fail due to a difference in the threading implementation
211 on those CPUs.
212 </para>
213 </listitem>
214
215 </itemizedlist>
216
217 <para>
218 Now, as the <systemitem class="username">root</systemitem> user:
219 </para>
220
221<screen role="root"><userinput>make -C gdb install</userinput></screen>
222
223 <para>
224 If you have built the API documentation, it is now in gdb/doc/doxy.
225 You can install it (as the <systemitem class="username">root</systemitem>
226 user):
227 </para>
228
229<screen role="root"
230 remap="doc"><userinput>install -d /usr/share/doc/gdb-&gdb-version; &amp;&amp;
231rm -rf gdb/doc/doxy/xml &amp;&amp;
232cp -Rv gdb/doc/doxy /usr/share/doc/gdb-&gdb-version;</userinput></screen>
233
234 </sect2>
235
236 <sect2 role="commands">
237 <title>Command Explanations</title>
238
239 <para>
240 <parameter>--with-system-readline</parameter>: This switch forces
241 <application>GDB</application> to use the copy of
242 <application>Readline</application> installed in LFS.
243 </para>
244
245 <para>
246 <parameter>--with-python=/usr/bin/python3</parameter>: This switch
247 forces <application>GDB</application> to use Python 3.
248 Remove this switch if you have installed
249 <xref linkend="python2"/> and want to use it instead of Python 3.
250 </para>
251
252 </sect2>
253
254 <sect2 role="content">
255 <title>Contents</title>
256
257 <segmentedlist>
258 <segtitle>Installed Programs</segtitle>
259 <segtitle>Installed Library</segtitle>
260 <segtitle>Installed Directories</segtitle>
261
262 <seglistitem>
263 <seg>
264 gcore, gdb and gdbserver
265 </seg>
266 <seg>
267 <!--libinproctrace.so-->
268 None
269 </seg>
270 <seg>
271 /usr/{include,share}/gdb and /usr/share/doc/gdb-&gdb-version;
272 </seg>
273 </seglistitem>
274 </segmentedlist>
275
276 <variablelist>
277 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
278 <?dbfo list-presentation="list"?>
279 <?dbhtml list-presentation="table"?>
280
281 <varlistentry id="gcore">
282 <term><command>gcore</command></term>
283 <listitem>
284 <para>
285 generates a core dump of a running program
286 </para>
287 <indexterm zone="gdb gcore">
288 <primary sortas="b-gcore">gcore</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="gdb-prog">
294 <term><command>gdb</command></term>
295 <listitem>
296 <para>
297 is the GNU Debugger
298 </para>
299 <indexterm zone="gdb gdb-prog">
300 <primary sortas="b-gdb-prog">gdb-prog</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="gdbserver">
306 <term><command>gdbserver</command></term>
307 <listitem>
308 <para>
309 is a remote server for the GNU debugger (it allows programs
310 to be debugged from a different machine)
311 </para>
312 <indexterm zone="gdb gdbserver">
313 <primary sortas="b-gdbserver">gdbserver</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318<!-- Not present with 10.1
319 <varlistentry id="libinproctrace">
320 <term><filename class="libraryfile">libinproctrace.so</filename></term>
321 <listitem>
322 <para>
323 contains functions for the in-process tracing agent. The agent
324 allows for installing fast tracepoints, listing static tracepoint
325 markers, probing static tracepoints markers, and starting trace
326 monitoring.
327 </para>
328 <indexterm zone="gdb libinproctrace">
329 <primary sortas="c-libinproctrace">libinproctrace.so</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333 -->
334 </variablelist>
335
336 </sect2>
337
338</sect1>
Note: See TracBrowser for help on using the repository browser.