OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [gnu-old/] [gdb-6.8/] [gdb/] [README] - Blame information for rev 827

Go to most recent revision | Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.