* stabs.texinfo: N_MAIN is sometimes used for C.
[deliverable/binutils-gdb.git] / gdb / README
index c9b149a974332737acd5218c51e90043876092c4..51587ed9537b7b9200fe642114522b484e9d320e 100644 (file)
@@ -1,8 +1,8 @@
-               README for gdb-4.4 release
-    John Gilmore & Stu Grossman        31 Jan 1992
+               README for gdb-4.7 release
+    Stu Grossman & John Gilmore        23 October 1992
 
 This is GDB, the GNU source-level debugger, presently running under un*x.
-A summary of new features is in the file `WHATS.NEW'.
+A summary of new features is in the file `NEWS'.
 
 
 Unpacking and Installation -- quick overview
@@ -10,22 +10,24 @@ Unpacking and Installation -- quick overview
 
 In this release, the GDB debugger sources, the generic GNU include
 files, the BFD ("binary file description") library, the readline library,
-and a miscellaneous library all have directories of their own underneath
-the gdb-4.4 directory.  The idea is that a variety of GNU tools can
+and other libraries all have directories of their own underneath
+the gdb-4.7 directory.  The idea is that a variety of GNU tools can
 share a common copy of these things.  Configuration scripts and
 makefiles exist to cruise up and down this directory tree and
 automatically build all the pieces in the right order.
 
-When you unpack the gdb-4.4.tar.Z file, you'll get a directory called
-`gdb-4.4', which contains:
+When you unpack the gdb-4.7.tar.Z file, you'll get a directory called
+`gdb-4.7', which contains:
 
-  DOC.configure  bfd/           configure*     glob/          readline/
-  Makefile.in    config/        configure.in   include/       texinfo/
-  README         config.sub*    gdb/           libiberty/
+  COPYING.LIB      config/          configure.texi   mmalloc/
+  Makefile.in      config.sub*      gdb/             move-if-change*
+  README           configure*       glob/            opcodes/
+  bfd/             configure.in     include/         readline/
+  cfg-paper.texi   configure.man    libiberty/       texinfo/
 
 To build GDB, you can just do:
 
-       cd gdb-4.4
+       cd gdb-4.7
        ./configure HOSTTYPE            (e.g. sun4, decstation)
        make
        cp gdb/gdb /usr/local/bin/gdb   (or wherever you want)
@@ -39,202 +41,224 @@ while debugging a program running on a machine of another type.  See below.
 
 
 More Documentation
-==================
+******************
 
-   The GDB 4.4 release includes an already-formatted reference card,
-ready for printing on a PostScript printer, as
-`gdb-4.4/gdb/refcard.ps'.  It uses the most common PostScript fonts:
-the Times family, Courier, and Symbol.  If you have a PostScript
-printer, you can print the reference card by just sending `refcard.ps'
-to the printer.
+   The GDB 4 release includes an already-formatted reference card, ready
+for printing with PostScript or GhostScript, in the `gdb' subdirectory
+of the main source directory--in `gdb-4.7/gdb/refcard.ps' of the
+version 4.7 release. If you can use PostScript or GhostScript with your
+printer, you can print the reference card immediately with `refcard.ps'.
 
-   The release also includes the online Info version of this manual
-already formatted: the main Info file is `gdb-4.4/gdb/gdb.info', and it
-refers to subordinate files matching `gdb.info*' in the same directory.
+   The release also includes the source for the reference card.  You
+can format it, using TeX, by typing:
 
-   If you want to make these Info files yourself from the GDB manual's
-source, you need the GNU `makeinfo' program.  Once you have it, you
-can type
-
-     cd gdb-4.4/gdb
-     make gdb.info
+     make refcard.dvi
 
-to make the Info file.
+   The GDB reference card is designed to print in landscape mode on US
+"letter" size paper; that is, on a sheet 11 inches wide by 8.5 inches
+high.  You will need to specify this form of printing as an option to
+your DVI output program.
 
-   If you want to format and print copies of the manual, you need
-several things:
+   All the documentation for GDB comes as part of the machine-readable
+distribution.  The documentation is written in Texinfo format, which is
+a documentation system that uses a single source file to produce both
+on-line information and a printed manual.  You can use one of the Info
+formatting commands to create the on-line version of the documentation
+and TeX (or `texi2roff') to typeset the printed version.
+
+   GDB includes an already formatted copy of the on-line Info version of
+this manual in the `gdb' subdirectory.  The main Info file is
+`gdb-VERSION-NUMBER/gdb/gdb.info', and it refers to subordinate files
+matching `gdb.info*' in the same directory.  If necessary, you can
+print out these files, or read them with any editor; but they are
+easier to read using the `info' subsystem in GNU Emacs or the
+standalone `info' program, available as part of the GNU Texinfo
+distribution.
+
+   If you want to format these Info files yourself, you need one of the
+Info formatting programs, such as `texinfo-format-buffer' or `makeinfo'.
+
+   If you have `makeinfo' installed, and are in the top level GDB
+source directory (`gdb-4.7', in the case of version 4.7), you can make
+the Info file by typing:
+
+     cd gdb
+     make gdb.info
 
-   * TeX, the public domain typesetting program written by Donald
-     Knuth, must be installed on your system and available through
-     your execution path.
+   If you want to typeset and print copies of this manual, you need
+TeX, a printing program such as `lpr', and `texinfo.tex', the Texinfo
+definitions file.
 
-   * `gdb-4.4/texinfo': TeX macros defining the GNU Documentation
-     Format.
+   TeX is typesetting program; it does not print files directly, but
+produces output files called DVI files.  To print a typeset document,
+you need a program to print DVI files.  If your system has TeX
+installed, chances are it has such a program.  The precise command to
+use depends on your system; `lpr -d' is common; another is `dvips'. 
+The DVI print command may require a file name without any extension or
+a `.dvi' extension.
 
-   * *A DVI output program.*  TeX does not actually make marks on
-     paper; it produces output files called DVI files.  If your system
-     has TeX installed, chances are it has a program for printing out
-     these files; one popular example is `dvips', which can print DVI
-     files on PostScript printers.
+   TeX also requires a macro definitions file called `texinfo.tex'. 
+This file tells TeX how to typeset a document written in Texinfo
+format.  On its own, TeX cannot read, much less typeset a Texinfo file.
+ `texinfo.tex' is distributed with GDB and is located in the
+`gdb-VERSION-NUMBER/texinfo' directory.
 
-Once you have these things, you can type
+   If you have TeX and a DVI printer program installed, you can typeset
+and print this manual.  First switch to the the `gdb' subdirectory of
+the main source directory (for example, to `gdb-4.7/gdb') and then type:
 
-     cd gdb-4.4/gdb
      make gdb.dvi
 
-to format the text of this manual, and print it with the usual output
-method for TeX DVI files at your site.
-
-   If you want to print the reference card, but do not have a
-PostScript printer, or you want to use Computer Modern fonts instead,
-you can still print it if you have TeX.  Format the reference card by
-typing
-
-     cd gdb-4.4/gdb
-     make refcard.dvi
-
-The GDB reference card is designed to print in landscape mode on US
-"letter" size paper; that is, on a sheet 11 inches wide by 8.5 inches
-high.  You will need to specify this form of printing as an option to
-your DVI output program.
-
 
 Installing GDB
-==============
+***************
 
    GDB comes with a `configure' script that automates the process of
 preparing GDB for installation; you can then use `make' to build the
-`gdb' program.
+program.
+
+   The GDB distribution includes all the source code you need for GDB in
+a single directory, whose name is usually composed by appending the
+version number to `gdb'.
 
-   The gdb distribution includes all the source code you need for gdb
-in a single directory `gdb-4.4'.  That directory in turn contains:
+   For example, the GDB version 4.7 distribution is in the `gdb-4.7'
+directory.  That directory contains:
 
-`gdb-4.4/configure (and supporting files)'
+`gdb-4.7/configure (and supporting files)'
      script for configuring GDB and all its supporting libraries.
 
-`gdb-4.4/gdb'
+`gdb-4.7/gdb'
      the source specific to GDB itself
 
-`gdb-4.4/bfd'
-     source for the Binary File Descriptor Library
+`gdb-4.7/bfd'
+     source for the Binary File Descriptor library
 
-`gdb-4.4/include'
+`gdb-4.7/include'
      GNU include files
 
-`gdb-4.4/libiberty'
+`gdb-4.7/libiberty'
      source for the `-liberty' free software library
 
-`gdb-4.4/readline'
+`gdb-4.7/opcodes'
+     source for the library of opcode tables and disassemblers
+
+`gdb-4.7/readline'
      source for the GNU command-line interface
 
-It is most convenient to run `configure' from the `gdb-4.4' directory.
- The simplest way to configure and build GDB is the following:
+`gdb-4.7/glob'
+     source for the GNU filename pattern-matching subroutine
+
+`gdb-4.7/mmalloc'
+     source for the GNU memory-mapped malloc package
+
+   The simplest way to configure and build GDB is to run `configure'
+from the `gdb-VERSION-NUMBER' source directory, which in this example
+is the `gdb-4.7' directory.
+
+   First switch to the `gdb-VERSION-NUMBER' source directory if you are
+not already in it; then run `configure'.  Pass the identifier for the
+platform on which GDB will run as an argument.
 
-     cd gdb-4.4
+   For example:
+
+     cd gdb-4.7
      ./configure HOST
      make
 
-where HOST is something like `sun4' or `decstation', that identifies
-the platform where GDB will run.  This builds the three libraries
-`bfd', `readline', and `libiberty', then `gdb' itself.  The configured
-source files, and the binaries, are left in the corresponding source
-directories.
+where HOST is an identifier such as `sun4' or `decstation', that
+identifies the platform where GDB will run.
+
+   Running `configure HOST' followed by `make' builds the `bfd',
+`readline', `mmalloc', and `libiberty' libraries, then `gdb' itself. 
+The configured source files, and the binaries, are left in the
+corresponding source directories.
 
    `configure' is a Bourne-shell (`/bin/sh') script; if your system
 does not recognize this automatically when you run a different shell,
-you may need to run `sh' on it explicitly: `sh configure HOST'.
+you may need to run `sh' on it explicitly:
 
-   You can *run* the `configure' script from any of the subordinate
-directories in the GDB distribution (if you only want to configure
-that subdirectory); but be sure to specify a path to it.  For example,
-to configure only the `bfd' subdirectory,
+     sh configure HOST
 
-     cd gdb-4.4/bfd
-     ../configure HOST
+   If you run `configure' from a directory that contains source
+directories for multiple libraries or programs, such as the `gdb-4.7'
+source directory for version 4.7, `configure' creates configuration
+files for every directory level underneath (unless you tell it not to,
+with the `--norecursion' option).
+
+   You can run the `configure' script from any of the subordinate
+directories in the GDB distribution, if you only want to configure that
+subdirectory; but be sure to specify a path to it.
 
-   You can install `gdb' anywhere; it has no hardwired paths.  Simply
-copy `gdb/gdb' to the desired directory.
+   For example, with version 4.7, type the following to configure only
+the `bfd' subdirectory:
 
-   However, you should make sure that the shell on your path (named by
-the `SHELL' environment variable) is publicly readable; some systems
-refuse to let GDB debug child processes whose programs are not
-readable, and GDB uses the shell to start your program.
+     cd gdb-4.7/bfd
+     ../configure HOST
+
+   You can install `gdb' anywhere; it has no hardwired paths. However,
+you should make sure that the shell on your path (named by the `SHELL'
+environment variable) is publicly readable.  Remember that GDB uses the
+shell to start your program--some systems refuse to let GDB debug child
+processes whose programs are not readable.
 
 
-Configuration Subdirectories
-============================
+Compiling GDB in Another Directory
+===================================
 
    If you want to run GDB versions for several host or target machines,
-you'll need a different gdb compiled for each combination of host and
+you'll need a different `gdb' compiled for each combination of host and
 target.  `configure' is designed to make this easy by allowing you to
-generate each configuration in a separate subdirectory.  If your
-`make' program handles the `VPATH' feature (GNU `make' does), running
-`make' in each of these directories then builds the gdb program
-specified there.
-
-   `configure' creates these subdirectories for you when you
-simultaneously specify several configurations; but it is a good habit
-even for a single configuration.  You can specify the use of
-subdirectories using the `+subdirs' option (abbreviated `+sub').  For
-example, you can build GDB this way on a Sun 4 as follows:
-
-     cd gdb-4.4
-     ./configure +sub sun4
-     cd H-sun4/T-sun4
+generate each configuration in a separate subdirectory, rather than in
+the source directory.  If your `make' program handles the `VPATH'
+feature (GNU `make' does), running `make' in each of these directories
+then builds the `gdb' program specified there.
+
+   To build `gdb' in a separate directory, run `configure' with the
+`--srcdir' option to specify where to find the source. (You'll also
+need to specify a path to find `configure' itself from your working
+directory.  If the path to `configure' would be the same as the
+argument to `--srcdir', you can leave out the `--srcdir' option; it
+will be assumed.)
+
+   For example, with version 4.7, you can build GDB in a separate
+directory for a Sun 4 like this:
+
+     cd gdb-4.7
+     mkdir ../gdb-sun4
+     cd ../gdb-sun4
+     ../gdb-4.7/configure sun4
      make
 
-   When `configure' uses subdirectories to build programs or
-libraries, it creates nested directories `H-HOST/T-TARGET'. 
-`configure' uses these two directory levels because GDB can be
-configured for cross-compiling: GDB can run on one machine (the host)
-while debugging programs that run on another machine (the target). 
-You specify cross-debugging targets by giving the `+target=TARGET'
-option to `configure'.  Specifying only hosts still gives you two
-levels of subdirectory for each host, with the same configuration
-suffix on both; that is, if you give any number of hosts but no
-targets, GDB will be configured for native debugging on each host.  On
-the other hand, whenever you specify both hosts and targets on the
-same command line, `configure' creates all combinations of the hosts
-and targets you list.
-
-   If you run `configure' from a directory (notably, `gdb-4.4') that
-contains source directories for multiple libraries or programs,
-`configure' creates the `H-HOST/T-TARGET' subdirectories in each
-library or program's source directory.  For example, typing:
-
-     cd gdb-4.4
-     configure sun4 +target=vxworks960
-
-creates the following directories:
-
-     gdb-4.4/H-sun4/T-vxworks960
-     gdb-4.4/bfd/H-sun4/T-vxworks960
-     gdb-4.4/gdb/H-sun4/T-vxworks960
-     gdb-4.4/libiberty/H-sun4/T-vxworks960
-     gdb-4.4/readline/H-sun4/T-vxworks960
+   When `configure' builds a configuration using a remote source
+directory, it creates a tree for the binaries with the same structure
+(and using the same names) as the tree under the source directory.  In
+the example, you'd find the Sun 4 library `libiberty.a' in the
+directory `gdb-sun4/libiberty', and GDB itself in `gdb-sun4/gdb'.
+
+   One popular reason to build several GDB configurations in separate
+directories is to configure GDB for cross-compiling (where GDB runs on
+one machine--the host--while debugging programs that run on another
+machine--the target).  You specify a cross-debugging target by giving
+the `--target=TARGET' option to `configure'.
 
    When you run `make' to build a program or library, you must run it
-in a configured directory.  If you made a single configuration,
-without subdirectories, run `make' in the source directory.  If you
-have `H-HOST/T-TARGET' subdirectories, run `make' in those
-subdirectories.
+in a configured directory--whatever directory you were in when you
+called `configure' (or one of its subdirectories).
 
    The `Makefile' generated by `configure' for each source directory
-runs recursively, so that typing `make' in `gdb-4.4' (or in a
-`gdb-4.4/H-HOST/T-TARGET' subdirectory) builds all the required
-libraries, then GDB.
-
-   When you have multiple hosts or targets configured, you can run
-`make' on them in parallel (for example, if they are NFS-mounted on
-each of the hosts); they will not interfere with each other.
+also runs recursively.  If you type `make' in a source directory such
+as `gdb-4.7' (or in a separate configured directory configured with
+`--srcdir=PATH/gdb-4.7'), you will build all the required libraries,
+then build GDB.
 
-   You can also use the `+objdir=ALTROOT' option to have the
-configured files placed in a parallel directory structure rather than
-alongside the source files; *note configure Options::..
+   When you have multiple hosts or targets configured in separate
+directories, you can run `make' on them in parallel (for example, if
+they are NFS-mounted on each of the hosts); they will not interfere
+with each other.
 
 
 Specifying Names for Hosts and Targets
-======================================
+=======================================
 
    The specifications used for hosts and targets in the `configure'
 script are based on a three-part naming scheme, but some short
@@ -243,164 +267,124 @@ three pieces of information in the following pattern:
 
      ARCHITECTURE-VENDOR-OS
 
-   For example, you can use the alias `sun4' as a HOST argument or in
-a `+target=TARGET' option, but the equivalent full name is
+   For example, you can use the alias `sun4' as a HOST argument or in a
+`--target=TARGET' option, but the equivalent full name is
 `sparc-sun-sunos4'.
 
-   The following table shows all the architectures, hosts, and OS
-prefixes that `configure' recognizes in GDB 4.4.  Entries in the "OS
-prefix" column ending in a `*' may be followed by a release number.
-
-
-     ARCHITECTURE  VENDOR                     OS prefix
-     ------------+--------------------------+---------------------------
-                 |                          |
-      580        | altos        hp          | aix*          msdos*
-      a29k       | amd          ibm         | amigados      newsos*
-      alliant    | amdahl       intel       | aout          nindy*
-      arm        | aout         isi         | bout          osf*
-      c1         | apollo       little      | bsd*          sco*
-      c2         | att          mips        | coff          sunos*
-      cray2      | bcs          motorola    | ctix*         svr4
-      h8300      | bout         ncr         | dgux*         sym*
-      i386       | bull         next        | dynix*        sysv*
-      i860       | cbm          nyu         | ebmon         ultrix*
-      i960       | coff         sco         | esix*         unicos*
-      m68000     | convergent   sequent     | hds           unos*
-      m68k       | convex       sgi         | hpux*         uts
-      m88k       | cray         sony        | irix*         v88r*
-      mips       | dec          sun         | isc*          vms*
-      ns32k      | encore       unicom      | kern          vxworks*
-      pyramid    | gould        utek        | mach*
-      romp       | hitachi      wrs         |
-      rs6000     |                          |
-      sparc      |                          |
-      tahoe      |                          |
-      tron       |                          |
-      vax        |                          |
-      xmp        |                          |
-      ymp        |                          |
-
-          *Warning:* `configure' can represent a very large number of
-     combinations of architecture, vendor, and OS.  There is by no
-     means support available for all possible combinations!
-
-   The `configure' script accompanying GDB 4.4 does not provide any
-query facility to list all supported host and target names or aliases.
- `configure' calls the Bourne shell script `config.sub' to map
+   The `configure' script accompanying GDB does not provide any query
+facility to list all supported host and target names or aliases. 
+`configure' calls the Bourne shell script `config.sub' to map
 abbreviations to full names; you can read the script, if you wish, or
 you can use it to test your guesses on abbreviations--for example:
 
      % sh config.sub sun4
-     sparc-sun-sunos4
+     sparc-sun-sunos411
      % sh config.sub sun3
-     m68k-sun-sunos4
+     m68k-sun-sunos411
      % sh config.sub decstation
-     mips-dec-ultrix
+     mips-dec-ultrix42
      % sh config.sub hp300bsd
      m68k-hp-bsd
      % sh config.sub i386v
-     i386-none-sysv
-     % sh config.sub i486v
-     *** Configuration "i486v" not recognized
+     i386-unknown-sysv
+     % sh config.sub i786v
+     Invalid configuration `i786v': machine `i786v' not recognized
 
-`config.sub' is also distributed in the directory `gdb-4.4'.
+`config.sub' is also distributed in the GDB source directory
+(`gdb-4.7', for version 4.7).
 
 
 `configure' Options
-===================
-
-   Here is a summary of all the `configure' options and arguments that
-you might use for building GDB:
-
-     configure [+destdir=DIR] [+subdirs]
-               [+objdir=ALTROOT] [+norecursion] [+rm]
-               [+target=TARGET...] HOST...
-
-You may introduce options with the character `-' rather than `+' if
-you prefer; but you may abbreviate option names if you use `+'.
-
-`+destdir=DIR'
-     DIR is an installation directory *path prefix*.  After you
-     configure with this option, `make install' will install GDB as
-     `DIR/bin/gdb', and the libraries in `DIR/lib'.  If you specify
-     `+destdir=/usr/local', for example, `make install' creates
-     `/usr/local/bin/gdb'.
-
-`+subdirs'
-     Write configuration specific files in subdirectories of the form
-
-          H-HOST/T-TARGET
-
-          (and configure the `Makefile' to generate object code in
-     subdirectories of this form as well).  Without this option, if you
-     specify only one configuration for GDB, `configure' will use the
-     same directory for source, configured files, and binaries.  This
-     option is used automatically if you specify more than one HOST or
-     more than one `+target=TARGET' option on the `configure' command
-     line.
-
-`+norecursion'
-     Configure only the directory where `configure' is executed; do not
-     propagate configuration to subdirectories.
-
-`+objdir=ALTROOT'
-     ALTROOT is an alternative directory used as the root for
-     configured files.  `configure' will create directories under
-     ALTROOT in parallel to the source directories.  If you use
-     `+objdir=ALTROOT' with `+subdirs', `configure' also builds the
-     `H-HOST/T-TARGET' subdirectories in the directory tree rooted in
-     ALTROOT.
-
-`+rm'
+====================
+
+   Here is a summary of the `configure' options and arguments that are
+most often useful for building GDB.  `configure' also has several other
+options not listed here.  *note : (configure.info)What Configure Does,
+for a full explanation of `configure'.
+
+     configure [--help]
+               [--prefix=DIR]
+               [--srcdir=PATH]
+               [--norecursion] [--rm]
+               [--target=TARGET] HOST
+
+You may introduce options with a single `-' rather than `--' if you
+prefer; but you may abbreviate option names if you use `--'.
+
+`--help'
+     Display a quick summary of how to invoke `configure'.
+
+`-prefix=DIR'
+     Configure the source to install programs and files under directory
+     `DIR'.
+
+`--srcdir=PATH'
+     *Warning: using this option requires GNU `make', or another `make'
+     that implements the `VPATH' feature.*
+     Use this option to make configurations in directories separate
+     from the GDB source directories.  Among other things, you can use
+     this to build (or maintain) several configurations simultaneously,
+     in separate directories.  `configure' writes configuration
+     specific files in the current directory, but arranges for them to
+     use the source in the directory PATH.  `configure' will create
+     directories under the working directory in parallel to the source
+     directories below PATH.
+
+`--norecursion'
+     Configure only the directory level where `configure' is executed;
+     do not propagate configuration to subdirectories.
+
+`--rm'
      Remove the configuration that the other arguments specify.
 
-`+target=TARGET ...'
-     Configure GDB for cross-debugging programs running on each
-     specified TARGET.  You may specify as many `+target' options as
-     you wish.  Without this option, GDB is configured to debug
-     programs that run on the same machine (HOST) as GDB itself.
+`--target=TARGET'
+     Configure GDB for cross-debugging programs running on the specified
+     TARGET.  Without this option, GDB is configured to debug programs
+     that run on the same machine (HOST) as GDB itself.
 
      There is no convenient way to generate a list of all available
      targets.
 
 `HOST ...'
-     Configure GDB to run on each specified HOST.  You may specify as
-     many host names as you wish.
+     Configure GDB to run on the specified HOST.
 
      There is no convenient way to generate a list of all available
      hosts.
 
 `configure' accepts other options, for compatibility with configuring
-other GNU tools recursively; but these are the only options that
-affect GDB or its supporting libraries.
+other GNU tools recursively; but these are the only options that affect
+GDB or its supporting libraries.
 
 
-               Languages other than C
 
-C++ support has been integrated into gdb.  Partial Modula-2 support is
-now in GDB.  GDB should work with FORTRAN programs.  (If you have
-problems, please send a bug report; you may have to refer to some
+Languages other than C
+=======================
+
+GDB provides some support for debugging C++ progams.  Partial Modula-2
+support is now in GDB.  GDB should work with FORTRAN programs.  (If you
+have problems, please send a bug report; you may have to refer to some
 FORTRAN variables with a trailing underscore).  I am not aware of
 anyone who is working on getting gdb to use the syntax of any other
 language.  Pascal programs which use sets, subranges, file variables,
 or nested functions will not currently work.
 
 
-               Kernel debugging
+Kernel debugging
+=================
 
 I have't done this myself so I can't really offer any advice.
 Remote debugging over serial lines works fine, but the kernel debugging
-code in here has not been tested in years.  Van Jacobson claims to have
-better kernel debugging.
+code in here has not been tested in years.  Van Jacobson has
+better kernel debugging, but the UC lawyers won't let FSF have it.
 
 
-               Remote debugging
+Remote debugging
+=================
 
-The files m68k-stub.c and i386-stub.c contain two examples of remote
-stubs to be used with remote.c.  They are designeded to run standalone
-on a 68k or 386 cpu and communicate properly with the remote.c stub
-over a serial line.
+The files m68k-stub.c, i386-stub.c, and sparc-stub.c are examples of
+remote stubs to be used with remote.c.  They are designed to run
+standalone on a 68k, 386, or SPARC cpu and communicate properly with
+the remote.c stub over a serial line.
 
 The file rem-multi.shar contains a general stub that can probably
 run on various different flavors of unix to allow debugging over a
@@ -409,6 +393,7 @@ serial line from one machine to another.
 Some working remote interfaces for talking to existing ROM monitors
 are:
        remote-eb.c      AMD 29000 "EBMON"
+       remote-hms.c     Hitachi Micro Systems H8/300 monitor
        remote-nindy.c   Intel 960 "Nindy"
        remote-adapt.c   AMD 29000 "Adapt"
        remote-mm.c      AMD 29000 "minimon"
@@ -419,11 +404,12 @@ RPC library.  This would be a useful starting point for other remote-
 via-ethernet back ends.
 
 
-               Reporting Bugs
+Reporting Bugs
+===============
 
 The correct address for reporting bugs found in gdb is
 "bug-gdb@prep.ai.mit.edu".  Please email all bugs to that address.
-Please include the GDB version number (e.g. gdb-4.4), and how
+Please include the GDB version number (e.g. gdb-4.7), and how
 you configured it (e.g. "sun4" or "mach386 host, i586-intel-synopsys
 target").
 
@@ -445,14 +431,15 @@ the compiler actually outputs or the debugger actually understands.
 
 If you port gdb to a new machine, please send the required changes to
 bug-gdb@prep.ai.mit.edu.  There's lots of information about doing your
-own port in the file gdb-4.4/gdb/doc/gdbint.texinfo, which you can
+own port in the file gdb-4.7/gdb/doc/gdbint.texinfo, which you can
 print out, or read with `info' (see the Makefile.in there).  If your
 changes are more than a few lines, obtain and send in a copyright
 assignment from gnu@prep.ai.mit.edu, as described in the section
-`Writing Code for GDB'.
+`Writing Code for GDB' below.
 
 
-               X Windows versus GDB
+X Windows versus GDB
+=====================
 
 xgdb is obsolete.  We are not doing any development or support of it.
 
@@ -464,7 +451,14 @@ an editor while debugging I suggest trying gdb-mode in gnu-emacs
 (Try typing M-x gdb RETURN).  Comments on this mode are welcome.
 
 
-               Writing Code for GDB
+Writing Code for GDB
+=====================
+
+Documentation about GDB's internals is in the subdirectory doc, as
+`gdbint.texinfo'.  In particular, there is a `cookbook' there on how
+to port GDB to a new machine.  You can read it by hand, print it
+by using TeX and texinfo, or process it into an `info' file for use
+with Emacs' info mode or the standalone `info' program.
 
 We appreciate having users contribute code that is of general use, but
 for it to be included in future GDB releases it must be cleanly
@@ -498,6 +492,12 @@ defined(SYSV).  If you use an #ifdef on some symbol that is defined
 in a header file (e.g. #ifdef TIOCSETP), *please* make sure that you
 have #include'd the relevant header file in that module!
 
+There is a list of all known `feature-test macros' in gdbint.texinfo.
+Each such macro should be defined (or left undefined) in a host-dependent,
+target-dependent, or native-dependent include file.  Not all of the
+macros are cleanly separated this way, yet.  As you make changes, move
+the code toward cleanliness.
+
 It is better to replace entire routines which may be system-specific,
 rather than put in a whole bunch of hooks which are probably not going
 to be helpful for any purpose other than your changes.  For example,
@@ -533,7 +533,8 @@ to use infptrace.c at all.  The same was true of core_file_command
 and exec_file_command.
 
 
-               Debugging gdb with itself
+Debugging gdb with itself
+==========================
 
 If gdb is limping on your machine, this is the preferred way to get it
 fully functional.  Be warned that in some ancient Unix systems, like
This page took 0.032804 seconds and 4 git commands to generate.