Commit | Line | Data |
---|---|---|
2037aebb AC |
1 | README for gdb-5.2.1 release |
2 | Updated 19 July, 2002 by Andrew Cagney | |
c906108c SS |
3 | |
4 | This is GDB, the GNU source-level debugger. | |
c906108c | 5 | |
129188f6 | 6 | A summary of new features is in the file `gdb/NEWS'. |
c906108c | 7 | |
1bfdc549 AC |
8 | Check the GDB home page at http://www.gnu.org/software/gdb/ for up to |
9 | date release information, mailing list links and archives, etc. | |
129188f6 AC |
10 | |
11 | The file `gdb/PROBLEMS' contains information on problems identified | |
12 | late in the release cycle. GDB's bug tracking data base at | |
13 | http://www.gnu.org/software/gdb/bugs/ contains a more complete list of | |
14 | bugs. | |
6b325864 | 15 | |
c906108c SS |
16 | |
17 | Unpacking and Installation -- quick overview | |
18 | ========================== | |
19 | ||
aba7b4b6 | 20 | In this release, the GDB debugger sources, the generic GNU include |
c906108c SS |
21 | files, the BFD ("binary file description") library, the readline |
22 | library, and other libraries all have directories of their own | |
2037aebb | 23 | underneath the gdb-5.2.1 directory. The idea is that a variety of GNU |
c906108c SS |
24 | tools can share a common copy of these things. Be aware of variation |
25 | over time--for example don't try to build gdb with a copy of bfd from | |
34f47bc4 AC |
26 | a release other than the gdb release (such as a binutils release), |
27 | especially if the releases are more than a few weeks apart. | |
c906108c SS |
28 | Configuration scripts and makefiles exist to cruise up and down this |
29 | directory tree and automatically build all the pieces in the right | |
30 | order. | |
31 | ||
2037aebb AC |
32 | When you unpack the gdb-5.2.1.tar.gz file, you'll find a directory |
33 | called `gdb-5.2.1', which contains: | |
c906108c | 34 | |
34f47bc4 AC |
35 | COPYING config.sub intl missing opcodes |
36 | COPYING.LIB configure libiberty mkinstalldirs readline | |
37 | Makefile.in configure.in libtool.m4 mmalloc sim | |
38 | README djunpack.bat ltcf-c.sh move-if-change symlink-tree | |
39 | bfd etc ltcf-cxx.sh mpw-README texinfo | |
40 | config gdb ltcf-gcj.sh mpw-build.in utils | |
41 | config-ml.in gettext.m4 ltconfig mpw-config.in ylwrap | |
42 | config.guess include ltmain.sh mpw-configure | |
43 | config.if install-sh md5.sum mpw-install | |
c906108c | 44 | |
bec71058 | 45 | You can build GDB right in the source directory: |
c906108c | 46 | |
2037aebb | 47 | cd gdb-5.2.1 |
34f47bc4 AC |
48 | ./configure |
49 | make | |
50 | cp gdb/gdb /usr/local/bin/gdb (or wherever you want) | |
c906108c | 51 | |
bec71058 FN |
52 | However, we recommend that an empty directory be used instead. |
53 | This way you do not clutter your source tree with binary files | |
54 | and will be able to create different builds with different | |
55 | configuration options. | |
56 | ||
57 | You can build GDB in any empty build directory: | |
58 | ||
34f47bc4 AC |
59 | mkdir build |
60 | cd build | |
2037aebb | 61 | <full path to your sources>/gdb-5.2.1/configure |
34f47bc4 AC |
62 | make |
63 | cp gdb/gdb /usr/local/bin/gdb (or wherever you want) | |
bec71058 | 64 | |
c63ce875 | 65 | (Building GDB with DJGPP tools for MS-DOS/MS-Windows is slightly |
2037aebb | 66 | different; see the file gdb-5.2.1/gdb/config/djgpp/README for details.) |
c63ce875 | 67 | |
aba7b4b6 AC |
68 | This will configure and build all the libraries as well as GDB. If |
69 | `configure' can't determine your system type, specify one as its | |
70 | argument, e.g., `./configure sun4' or `./configure decstation'. | |
c906108c | 71 | |
aba7b4b6 AC |
72 | If you get compiler errors during this stage, see the `Reporting |
73 | Bugs' section below; there are a few known problems. | |
c906108c | 74 | |
34f47bc4 AC |
75 | GDB requires an ISO C (ANSI C) compiler. If you do not have an ISO |
76 | C compiler for your system, you may be able to download and install | |
77 | the GNU CC compiler. It is available via anonymous FTP from the | |
78 | directory `ftp://ftp.gnu.org/pub/gnu/gcc'. | |
c906108c | 79 | |
aba7b4b6 AC |
80 | GDB can be used as a cross-debugger, running on a machine of one |
81 | type while debugging a program running on a machine of another type. | |
82 | See below. | |
c906108c SS |
83 | |
84 | ||
85 | More Documentation | |
86 | ****************** | |
87 | ||
88 | All the documentation for GDB comes as part of the machine-readable | |
aba7b4b6 AC |
89 | distribution. The documentation is written in Texinfo format, which |
90 | is a documentation system that uses a single source file to produce | |
91 | both on-line information and a printed manual. You can use one of the | |
92 | Info formatting commands to create the on-line version of the | |
93 | documentation and TeX (or `texi2roff') to typeset the printed version. | |
94 | ||
95 | GDB includes an already formatted copy of the on-line Info version | |
96 | of this manual in the `gdb/doc' subdirectory. The main Info file is | |
2037aebb | 97 | `gdb-5.2.1/gdb/doc/gdb.info', and it refers to subordinate files |
aba7b4b6 AC |
98 | matching `gdb.info*' in the same directory. If necessary, you can |
99 | print out these files, or read them with any editor; but they are | |
100 | easier to read using the `info' subsystem in GNU Emacs or the | |
101 | standalone `info' program, available as part of the GNU Texinfo | |
102 | distribution. | |
c906108c SS |
103 | |
104 | If you want to format these Info files yourself, you need one of the | |
105 | Info formatting programs, such as `texinfo-format-buffer' or | |
106 | `makeinfo'. | |
107 | ||
108 | If you have `makeinfo' installed, and are in the top level GDB | |
2037aebb | 109 | source directory (`gdb-5.2.1', in the case of version 5.2.1), you can make |
c906108c SS |
110 | the Info file by typing: |
111 | ||
34f47bc4 AC |
112 | cd gdb/doc |
113 | make info | |
c906108c SS |
114 | |
115 | If you want to typeset and print copies of this manual, you need | |
116 | TeX, a program to print its DVI output files, and `texinfo.tex', the | |
117 | Texinfo definitions file. This file is included in the GDB | |
2037aebb | 118 | distribution, in the directory `gdb-5.2.1/texinfo'. |
c906108c SS |
119 | |
120 | TeX is a typesetting program; it does not print files directly, but | |
121 | produces output files called DVI files. To print a typeset document, | |
122 | you need a program to print DVI files. If your system has TeX | |
123 | installed, chances are it has such a program. The precise command to | |
124 | use depends on your system; `lpr -d' is common; another (for PostScript | |
125 | devices) is `dvips'. The DVI print command may require a file name | |
126 | without any extension or a `.dvi' extension. | |
127 | ||
128 | TeX also requires a macro definitions file called `texinfo.tex'. | |
129 | This file tells TeX how to typeset a document written in Texinfo | |
130 | format. On its own, TeX cannot read, much less typeset a Texinfo file. | |
131 | `texinfo.tex' is distributed with GDB and is located in the | |
2037aebb | 132 | `gdb-5.2.1/texinfo' directory. |
c906108c SS |
133 | |
134 | If you have TeX and a DVI printer program installed, you can typeset | |
135 | and print this manual. First switch to the the `gdb' subdirectory of | |
2037aebb | 136 | the main source directory (for example, to `gdb-5.2.1/gdb') and then type: |
c906108c | 137 | |
34f47bc4 | 138 | make doc/gdb.dvi |
966beb0f EZ |
139 | |
140 | If you prefer to have the manual in PDF format, type this from the | |
141 | `gdb/doc' subdirectory of the main source directory: | |
142 | ||
34f47bc4 | 143 | make gdb.pdf |
966beb0f EZ |
144 | |
145 | For this to work, you will need the PDFTeX package to be installed. | |
c906108c SS |
146 | |
147 | ||
148 | Installing GDB | |
149 | ************** | |
150 | ||
151 | GDB comes with a `configure' script that automates the process of | |
152 | preparing GDB for installation; you can then use `make' to build the | |
153 | `gdb' program. | |
154 | ||
155 | The GDB distribution includes all the source code you need for GDB in | |
156 | a single directory, whose name is usually composed by appending the | |
157 | version number to `gdb'. | |
158 | ||
2037aebb | 159 | For example, the GDB version 5.2.1 distribution is in the `gdb-5.2.1' |
c906108c SS |
160 | directory. That directory contains: |
161 | ||
2037aebb | 162 | `gdb-5.2.1/{COPYING,COPYING.LIB}' |
c906108c SS |
163 | Standard GNU license files. Please read them. |
164 | ||
2037aebb | 165 | `gdb-5.2.1/bfd' |
c906108c SS |
166 | source for the Binary File Descriptor library |
167 | ||
2037aebb | 168 | `gdb-5.2.1/config*' |
c906108c SS |
169 | script for configuring GDB, along with other support files |
170 | ||
2037aebb | 171 | `gdb-5.2.1/gdb' |
c906108c SS |
172 | the source specific to GDB itself |
173 | ||
2037aebb | 174 | `gdb-5.2.1/include' |
c906108c SS |
175 | GNU include files |
176 | ||
2037aebb | 177 | `gdb-5.2.1/libiberty' |
c906108c SS |
178 | source for the `-liberty' free software library |
179 | ||
2037aebb | 180 | `gdb-5.2.1/mmalloc' |
c906108c SS |
181 | source for the GNU memory-mapped malloc package |
182 | ||
2037aebb | 183 | `gdb-5.2.1/opcodes' |
c906108c SS |
184 | source for the library of opcode tables and disassemblers |
185 | ||
2037aebb | 186 | `gdb-5.2.1/readline' |
c906108c | 187 | source for the GNU command-line interface |
7a292a7a SS |
188 | NOTE: The readline library is compiled for use by GDB, but will |
189 | not be installed on your system when "make install" is issued. | |
c906108c | 190 | |
2037aebb | 191 | `gdb-5.2.1/sim' |
c906108c SS |
192 | source for some simulators (ARM, D10V, SPARC, M32R, MIPS, PPC, V850, etc) |
193 | ||
2037aebb | 194 | `gdb-5.2.1/intl' |
c906108c SS |
195 | source for the GNU gettext library, for internationalization. |
196 | This is slightly modified from the standalone gettext | |
197 | distribution you can get from GNU. | |
198 | ||
2037aebb | 199 | `gdb-5.2.1/texinfo' |
c906108c SS |
200 | The `texinfo.tex' file, which you need in order to make a printed |
201 | manual using TeX. | |
202 | ||
2037aebb | 203 | `gdb-5.2.1/etc' |
c906108c SS |
204 | Coding standards, useful files for editing GDB, and other |
205 | miscellanea. | |
206 | ||
2037aebb | 207 | `gdb-5.2.1/utils' |
c906108c SS |
208 | A grab bag of random utilities. |
209 | ||
c63ce875 EZ |
210 | Note: the following instructions are for building GDB on Unix or |
211 | Unix-like systems. Instructions for building with DJGPP for | |
212 | MS-DOS/MS-Windows are in the file gdb/config/djgpp/README. | |
c906108c SS |
213 | |
214 | The simplest way to configure and build GDB is to run `configure' | |
215 | from the `gdb-VERSION-NUMBER' source directory, which in this example | |
2037aebb | 216 | is the `gdb-5.2.1' directory. |
c906108c SS |
217 | |
218 | First switch to the `gdb-VERSION-NUMBER' source directory if you are | |
219 | not already in it; then run `configure'. | |
220 | ||
221 | For example: | |
222 | ||
2037aebb | 223 | cd gdb-5.2.1 |
34f47bc4 AC |
224 | ./configure |
225 | make | |
c906108c SS |
226 | |
227 | Running `configure' followed by `make' builds the `bfd', | |
228 | `readline', `mmalloc', and `libiberty' libraries, then `gdb' itself. | |
229 | The configured source files, and the binaries, are left in the | |
230 | corresponding source directories. | |
231 | ||
232 | `configure' is a Bourne-shell (`/bin/sh') script; if your system | |
233 | does not recognize this automatically when you run a different shell, | |
234 | you may need to run `sh' on it explicitly: | |
235 | ||
34f47bc4 | 236 | sh configure |
c906108c SS |
237 | |
238 | If you run `configure' from a directory that contains source | |
2037aebb AC |
239 | directories for multiple libraries or programs, such as the `gdb-5.2.1' |
240 | source directory for version 5.2.1, `configure' creates configuration | |
c906108c SS |
241 | files for every directory level underneath (unless you tell it not to, |
242 | with the `--norecursion' option). | |
243 | ||
244 | You can run the `configure' script from any of the subordinate | |
245 | directories in the GDB distribution, if you only want to configure that | |
246 | subdirectory; but be sure to specify a path to it. | |
247 | ||
2037aebb | 248 | For example, with version 5.2.1, type the following to configure only |
c906108c SS |
249 | the `bfd' subdirectory: |
250 | ||
2037aebb | 251 | cd gdb-5.2.1/bfd |
34f47bc4 | 252 | ../configure |
c906108c SS |
253 | |
254 | You can install `gdb' anywhere; it has no hardwired paths. However, | |
255 | you should make sure that the shell on your path (named by the `SHELL' | |
256 | environment variable) is publicly readable. Remember that GDB uses the | |
257 | shell to start your program--some systems refuse to let GDB debug child | |
258 | processes whose programs are not readable. | |
259 | ||
260 | ||
261 | Compiling GDB in another directory | |
262 | ================================== | |
263 | ||
264 | If you want to run GDB versions for several host or target machines, | |
265 | you need a different `gdb' compiled for each combination of host and | |
266 | target. `configure' is designed to make this easy by allowing you to | |
267 | generate each configuration in a separate subdirectory, rather than in | |
268 | the source directory. If your `make' program handles the `VPATH' | |
269 | feature correctly (GNU `make' and SunOS 'make' are two that should), | |
270 | running `make' in each of these directories builds the `gdb' program | |
271 | specified there. | |
272 | ||
273 | To build `gdb' in a separate directory, run `configure' with the | |
274 | `--srcdir' option to specify where to find the source. (You also need | |
275 | to specify a path to find `configure' itself from your working | |
276 | directory. If the path to `configure' would be the same as the | |
277 | argument to `--srcdir', you can leave out the `--srcdir' option; it | |
278 | will be assumed.) | |
279 | ||
2037aebb | 280 | For example, with version 5.2.1, you can build GDB in a separate |
c906108c SS |
281 | directory for a Sun 4 like this: |
282 | ||
2037aebb | 283 | cd gdb-5.2.1 |
c906108c SS |
284 | mkdir ../gdb-sun4 |
285 | cd ../gdb-sun4 | |
2037aebb | 286 | ../gdb-5.2.1/configure |
c906108c SS |
287 | make |
288 | ||
289 | When `configure' builds a configuration using a remote source | |
290 | directory, it creates a tree for the binaries with the same structure | |
291 | (and using the same names) as the tree under the source directory. In | |
292 | the example, you'd find the Sun 4 library `libiberty.a' in the | |
293 | directory `gdb-sun4/libiberty', and GDB itself in `gdb-sun4/gdb'. | |
294 | ||
295 | One popular reason to build several GDB configurations in separate | |
296 | directories is to configure GDB for cross-compiling (where GDB runs on | |
297 | one machine--the host--while debugging programs that run on another | |
298 | machine--the target). You specify a cross-debugging target by giving | |
299 | the `--target=TARGET' option to `configure'. | |
300 | ||
301 | When you run `make' to build a program or library, you must run it | |
302 | in a configured directory--whatever directory you were in when you | |
303 | called `configure' (or one of its subdirectories). | |
304 | ||
305 | The `Makefile' that `configure' generates in each source directory | |
306 | also runs recursively. If you type `make' in a source directory such | |
2037aebb AC |
307 | as `gdb-5.2.1' (or in a separate configured directory configured with |
308 | `--srcdir=PATH/gdb-5.2.1'), you will build all the required libraries, | |
c906108c SS |
309 | and then build GDB. |
310 | ||
311 | When you have multiple hosts or targets configured in separate | |
312 | directories, you can run `make' on them in parallel (for example, if | |
313 | they are NFS-mounted on each of the hosts); they will not interfere | |
314 | with each other. | |
315 | ||
316 | ||
317 | Specifying names for hosts and targets | |
318 | ====================================== | |
319 | ||
320 | The specifications used for hosts and targets in the `configure' | |
321 | script are based on a three-part naming scheme, but some short | |
322 | predefined aliases are also supported. The full naming scheme encodes | |
323 | three pieces of information in the following pattern: | |
324 | ||
325 | ARCHITECTURE-VENDOR-OS | |
326 | ||
327 | For example, you can use the alias `sun4' as a HOST argument or in a | |
328 | `--target=TARGET' option. The equivalent full name is | |
329 | `sparc-sun-sunos4'. | |
330 | ||
331 | The `configure' script accompanying GDB does not provide any query | |
332 | facility to list all supported host and target names or aliases. | |
333 | `configure' calls the Bourne shell script `config.sub' to map | |
334 | abbreviations to full names; you can read the script, if you wish, or | |
335 | you can use it to test your guesses on abbreviations--for example: | |
336 | ||
337 | % sh config.sub sun4 | |
338 | sparc-sun-sunos4.1.1 | |
339 | % sh config.sub sun3 | |
340 | m68k-sun-sunos4.1.1 | |
341 | % sh config.sub decstation | |
342 | mips-dec-ultrix4.2 | |
343 | % sh config.sub hp300bsd | |
344 | m68k-hp-bsd | |
345 | % sh config.sub i386v | |
346 | i386-pc-sysv | |
347 | % sh config.sub i786v | |
348 | Invalid configuration `i786v': machine `i786v' not recognized | |
349 | ||
350 | `config.sub' is also distributed in the GDB source directory | |
2037aebb | 351 | (`gdb-5.2.1', for version 5.2.1). |
c906108c SS |
352 | |
353 | ||
354 | `configure' options | |
355 | =================== | |
356 | ||
357 | Here is a summary of the `configure' options and arguments that are | |
358 | most often useful for building GDB. `configure' also has several other | |
359 | options not listed here. *note : (configure.info)What Configure Does, | |
360 | for a full explanation of `configure'. | |
361 | ||
362 | configure [--help] | |
363 | [--prefix=DIR] | |
364 | [--srcdir=PATH] | |
365 | [--norecursion] [--rm] | |
366 | [--enable-build-warnings] | |
367 | [--target=TARGET] | |
368 | [--host=HOST] | |
369 | [HOST] | |
370 | ||
371 | You may introduce options with a single `-' rather than `--' if you | |
372 | prefer; but you may abbreviate option names if you use `--'. | |
373 | ||
374 | `--help' | |
375 | Display a quick summary of how to invoke `configure'. | |
376 | ||
377 | `-prefix=DIR' | |
378 | Configure the source to install programs and files under directory | |
379 | `DIR'. | |
380 | ||
381 | `--srcdir=PATH' | |
382 | *Warning: using this option requires GNU `make', or another `make' | |
383 | that compatibly implements the `VPATH' feature.* | |
384 | Use this option to make configurations in directories separate | |
385 | from the GDB source directories. Among other things, you can use | |
386 | this to build (or maintain) several configurations simultaneously, | |
387 | in separate directories. `configure' writes configuration | |
388 | specific files in the current directory, but arranges for them to | |
389 | use the source in the directory PATH. `configure' will create | |
390 | directories under the working directory in parallel to the source | |
391 | directories below PATH. | |
392 | ||
393 | `--norecursion' | |
394 | Configure only the directory level where `configure' is executed; | |
395 | do not propagate configuration to subdirectories. | |
396 | ||
397 | `--rm' | |
398 | Remove the configuration that the other arguments specify. | |
399 | ||
400 | `--enable-build-warnings' | |
401 | When building the GDB sources, ask the compiler to warn about any | |
402 | code which looks even vaguely suspicious. You should only using | |
403 | this feature if you're compiling with GNU CC. It passes the | |
404 | following flags: | |
aba7b4b6 AC |
405 | -Wimplicit |
406 | -Wreturn-type | |
407 | -Wcomment | |
408 | -Wtrigraphs | |
409 | -Wformat | |
410 | -Wparentheses | |
c906108c | 411 | -Wpointer-arith |
c906108c SS |
412 | |
413 | `--target=TARGET' | |
414 | Configure GDB for cross-debugging programs running on the specified | |
415 | TARGET. Without this option, GDB is configured to debug programs | |
416 | that run on the same machine (HOST) as GDB itself. | |
417 | ||
418 | There is no convenient way to generate a list of all available | |
419 | targets. | |
420 | ||
421 | `--host=HOST' | |
422 | Configure GDB to run on the specified HOST. | |
423 | ||
424 | There is no convenient way to generate a list of all available | |
425 | hosts. | |
426 | ||
427 | `HOST ...' | |
428 | Same as `--host=HOST'. If you omit this, GDB will guess; it's | |
429 | quite accurate. | |
430 | ||
431 | `configure' accepts other options, for compatibility with configuring | |
432 | other GNU tools recursively; but these are the only options that affect | |
433 | GDB or its supporting libraries. | |
434 | ||
435 | ||
c906108c SS |
436 | Remote debugging |
437 | ================= | |
438 | ||
aba7b4b6 AC |
439 | The files m68k-stub.c, i386-stub.c, and sparc-stub.c are examples |
440 | of remote stubs to be used with remote.c. They are designed to run | |
441 | standalone on an m68k, i386, or SPARC cpu and communicate properly | |
442 | with the remote.c stub over a serial line. | |
c906108c | 443 | |
aba7b4b6 | 444 | The directory gdb/gdbserver/ contains `gdbserver', a program that |
c906108c | 445 | allows remote debugging for Unix applications. gdbserver is only |
aba7b4b6 AC |
446 | supported for some native configurations, including Sun 3, Sun 4, and |
447 | Linux. | |
c906108c | 448 | |
aba7b4b6 | 449 | There are a number of remote interfaces for talking to existing ROM |
c906108c SS |
450 | monitors and other hardware: |
451 | ||
452 | remote-adapt.c AMD 29000 "Adapt" | |
453 | remote-array.c Array Tech RAID controller | |
c906108c SS |
454 | remote-e7000.c Hitachi E7000 ICE |
455 | remote-eb.c AMD 29000 "EBMON" | |
456 | remote-es.c Ericsson 1800 monitor | |
457 | remote-est.c EST emulator | |
458 | remote-hms.c Hitachi Micro Systems H8/300 monitor | |
459 | remote-mips.c MIPS remote debugging protocol | |
460 | remote-mm.c AMD 29000 "minimon" | |
461 | remote-nindy.c Intel 960 "Nindy" | |
462 | remote-nrom.c NetROM ROM emulator | |
463 | remote-os9k.c PC running OS/9000 | |
464 | remote-rdi.c ARM with Angel monitor | |
465 | remote-rdp.c ARM with Demon monitor | |
466 | remote-sds.c PowerPC SDS monitor | |
467 | remote-sim.c Generalized simulator protocol | |
468 | remote-st.c Tandem ST-2000 monitor | |
469 | remote-udi.c AMD 29000 using the AMD "Universal Debug Interface" | |
470 | remote-vx.c VxWorks realtime kernel | |
471 | ||
aba7b4b6 AC |
472 | Remote-vx.c and the vx-share subdirectory contain a remote |
473 | interface for the VxWorks realtime kernel, which communicates over TCP | |
474 | using the Sun RPC library. This would be a useful starting point for | |
475 | other remote- via-ethernet back ends. | |
c906108c | 476 | |
aba7b4b6 AC |
477 | Remote-udi.c and the 29k-share subdirectory contain a remote |
478 | interface for AMD 29000 programs, which uses the AMD "Universal Debug | |
479 | Interface". This allows GDB to talk to software simulators, | |
480 | emulators, and/or bare hardware boards, via network or serial | |
481 | interfaces. Note that GDB only provides an interface that speaks UDI, | |
482 | not a complete solution. You will need something on the other end | |
483 | that also speaks UDI. | |
c906108c SS |
484 | |
485 | ||
129188f6 AC |
486 | Reporting Bugs in GDB |
487 | ===================== | |
488 | ||
489 | There are several ways of reporting bugs in GDB. The prefered | |
490 | method is to use the World Wide Web: | |
491 | ||
492 | http://www.gnu.org/software/gdb/bugs/ | |
493 | ||
494 | As an alternative, the bug report can be submitted, via e-mail, to the | |
495 | address "bug-gdb@gnu.org". | |
c906108c | 496 | |
129188f6 | 497 | When submitting a bug, please include the GDB version number (e.g., |
2037aebb | 498 | gdb-5.2.1), and how you configured it (e.g., "sun4" or "mach386 host, |
129188f6 | 499 | i586-intel-synopsys target"). Since GDB now supports so many |
aba7b4b6 AC |
500 | different configurations, it is important that you be precise about |
501 | this. If at all possible, you should include the actual banner that | |
502 | GDB prints when it starts up, or failing that, the actual configure | |
503 | command that you used when configuring GDB. | |
c906108c | 504 | |
129188f6 AC |
505 | For more information on how/whether to report bugs, see the |
506 | Reporting Bugs chapter of the GDB manual (gdb/doc/gdb.texinfo). | |
c906108c | 507 | |
aba7b4b6 AC |
508 | |
509 | Graphical interface to GDB -- X Windows, MS Windows | |
510 | ========================== | |
c906108c | 511 | |
aba7b4b6 AC |
512 | Several graphical interfaces to GDB are available. You should |
513 | check: | |
c906108c | 514 | |
47b95330 | 515 | http://www.gnu.org/software/gdb/gui/ |
c906108c | 516 | |
aba7b4b6 | 517 | for an up-to-date list. |
c906108c | 518 | |
aba7b4b6 | 519 | Emacs users will very likely enjoy the Grand Unified Debugger mode; |
f032fb6e | 520 | try typing `M-x gdb RET'. |
c906108c SS |
521 | |
522 | ||
523 | Writing Code for GDB | |
524 | ===================== | |
525 | ||
aba7b4b6 | 526 | There is a lot of information about writing code for GDB in the |
c906108c SS |
527 | internals manual, distributed with GDB in gdb/doc/gdbint.texinfo. You |
528 | can read it by hand, print it by using TeX and texinfo, or process it | |
529 | into an `info' file for use with Emacs' info mode or the standalone | |
530 | `info' program. | |
531 | ||
aba7b4b6 | 532 | If you are pondering writing anything but a short patch, especially |
c906108c SS |
533 | take note of the information about copyrights in the node Submitting |
534 | Patches. It can take quite a while to get all the paperwork done, so | |
535 | we encourage you to start that process as soon as you decide you are | |
536 | planning to work on something, or at least well ahead of when you | |
537 | think you will be ready to submit the patches. | |
538 | ||
539 | ||
540 | GDB Testsuite | |
541 | ============= | |
542 | ||
aba7b4b6 AC |
543 | Included with the GDB distribution is a DejaGNU based testsuite |
544 | that can either be used to test your newly built GDB, or for | |
545 | regression testing a GDB with local modifications. | |
546 | ||
547 | Running the testsuite requires the prior installation of DejaGNU, | |
548 | which is generally available via ftp. The directory | |
47b95330 AC |
549 | ftp://sources.redhat.com/pub/dejagnu/ will contain a recent snapshot. |
550 | Once DejaGNU is installed, you can run the tests in one of the | |
551 | following ways: | |
c906108c | 552 | |
2037aebb | 553 | (1) cd gdb-5.2.1 |
aba7b4b6 AC |
554 | make check-gdb |
555 | ||
556 | or | |
c906108c | 557 | |
2037aebb | 558 | (2) cd gdb-5.2.1/gdb |
c906108c SS |
559 | make check |
560 | ||
561 | or | |
562 | ||
2037aebb | 563 | (3) cd gdb-5.2.1/gdb/testsuite |
c906108c SS |
564 | make site.exp (builds the site specific file) |
565 | runtest -tool gdb GDB=../gdb (or GDB=<somepath> as appropriate) | |
566 | ||
aba7b4b6 AC |
567 | The last method gives you slightly more control in case of problems |
568 | with building one or more test executables or if you are using the | |
569 | testsuite `standalone', without it being part of the GDB source tree. | |
c906108c SS |
570 | |
571 | See the DejaGNU documentation for further details. | |
572 | ||
573 | \f | |
574 | (this is for editing this file with GNU emacs) | |
575 | Local Variables: | |
576 | mode: text | |
577 | End: |