Imagelibrary/binutils-gdb
1
0
Fork 1
mirror of https://github.com/bminor/binutils-gdb.git synced 2025-12-27 01:28:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

1. Update conditional markup:

Browse Source 
(a) to make H8 configuration come out right (first attempt since
     conversion to texinfo conditionals);
 (b) to exploit yesterday's makeinfo bugfix, using conditionals in menus
     rather than multiple alternative menus.

2. Update H8 text to refer to H8/500 as well as H8/300.

3. Define config file gdb-config.texi as a link in Makefile, based on a
   DOC_CONFIG variable.
This commit is contained in:
Roland Pesch
1993-03-27 01:32:11 +00:00
parent 0f0834c518
commit 1d7c3357dd
6 changed files with 315 additions and 1013 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
gdb/doc/Makefile.in
View File

@@ -47,6 +47,8 @@ READLINE_DIR = ${gdbdir}/../readline/doc
SET_TEXINPUTS = TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$$TEXINPUTS
DOC_CONFIG = all
# Don Knuth's TeX formatter
TEX = tex
@@ -154,6 +156,15 @@ lrefcard.ps : $(srcdir)/refcard.tex $(srcdir)/lpsrc.sed
GDBvn.texi : ${gdbdir}/Makefile.in
echo "@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/VERSION = //p'`" > ./GDBvn.texi
# Choose configuration for GDB manual (normally `all'; normally not tied into
# `configure' script because most users prefer generic version of manual,
# not one for their binary config---which may not be specifically
# defined anyways).
gdb-config.texi: ${DOC_CONFIG}-config.texi
ln -s ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi || \
ln ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi || \
cp ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi
# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
# If your texinfo or makeinfo don't support these, get a new texinfo release
#
@@ -196,7 +207,7 @@ gdb.info: ${SFILES_DOC}
# it out for gdb manual's include files---but only if not configured
# in main sourcedir.
links2roff: $(SFILES_INCLUDED)
if [ ! -f gdb-config.texi ]; then \
if [ ! -f gdb.texinfo ]; then \
ln -s $(SFILES_INCLUDED) . || \
ln $(SFILES_INCLUDED) . || \
cp $(SFILES_INCLUDED) . ; \

42
gdb/doc/all-config.texi Normal file
View File

@@ -0,0 +1,42 @@
@c GDB version number is recorded in the variable GDBVN
@include GDBvn.texi
@c
@set AGGLOMERATION
@clear AMDxxixK
@set BARETARGET
@set CONLY
@set DOSHOST
@clear FSFDOC
@set Hviii
@set HviiiEXCLUSIVE
@clear Icmlx
@clear NOVEL
@clear POSIX
@set PRECONFIGURED
@clear REMOTESTUB
@set SIMS
@clear SERIAL
@clear SPARC
@clear STmm
@clear VXWORKS
@clear ZviiiK
@c ----------------------------------------------------------------------
@c STRINGS:
@c
@c Name of GDB program. Used also for (gdb) prompt string.
@set GDBP gdb
@c
@c Name of GDB product. Used in running text.
@set GDBN GDB
@c
@c Name of GDB initialization file.
@set GDBINIT .gdbinit
@c
@c Name of target.
@set TARGET Hitachi H/300 and H/500
@c
@c Name of GCC product
@set NGCC GCC
@c
@c Name of GCC program
@set GCC gcc

104
gdb/doc/gdb-config.texi
View File

@@ -1,104 +0,0 @@
@c GDB MANUAL configuration file.
@c Copyright (c) 1993 Free Software Foundation, Inc.
@c
@c NOTE: While the GDB manual is configurable (by changing these
@c switches), its configuration is ***NOT*** automatically tied in to
@c source configuration---because the authors expect that, save in
@c unusual cases, the most inclusive form of the manual is appropriate
@c no matter how the program itself is configured.
@c
@c The only automatically-varying variable is the GDB version number,
@c which the Makefile rewrites based on the VERSION variable from
@c `../Makefile.in'.
@c
@c GDB version number is recorded in the variable GDBVN
@include GDBvn.texi
@c
@c ----------------------------------------------------------------------
@c PLATFORM FLAGS:
@set GENERIC
@c
@c Hitachi H8/300 target:
@set Hviii
@c Hitachi H8/300 target ONLY:
@clear HviiiEXCLUSIVE
@c
@c SPARC target:
@set SPARC
@c
@c AMD 29000 target:
@set AMDxxixK
@c
@c Intel 960 target:
@set Icmlx
@c
@c Tandem ST2000 (phone switch) target:
@set STmm
@c
@c Zilog 8000 target:
@set ZviiiK
@c
@c Lucid "Energize" environment:
@clear LUCID
@c
@c Wind River Systems VxWorks environment:
@set VXWORKS
@c
@c ----------------------------------------------------------------------
@c DOC FEATURE FLAGS:
@c
@c Include change-from-old?
@set NOVEL
@c
@c Bare-board target?
@clear BARETARGET
@c
@c Restrict languages discussed to C?
@clear CONLY
@c
@c Specifically for host machine running DOS?
@clear DOSHOST
@c
@c Talk about CPU simulator targets?
@set SIMS
@c
@c Is manual stand-alone, or part of an agglomeration, with overall GPL?
@clear AGGLOMERATION
@c
@c Remote serial line settings of interest?
@set SERIAL
@c
@c Discuss features requiring Posix or similar OS environment?
@set POSIX
@c
@c Discuss remote serial debugging stub?
@set REMOTESTUB
@c
@c Refrain from discussing how to configure sw and format doc?
@clear PRECONFIGURED
@c
@c Refrain from referring to unfree publications?
@set FSFDOC
@c
@c ----------------------------------------------------------------------
@c STRINGS:
@c
@c Name of GDB program. Used also for (gdb) prompt string.
@set GDBP gdb
@c
@c Name of GDB product. Used in running text.
@set GDBN GDB
@c
@c Name of GDB initialization file.
@set GDBINIT .gdbinit
@c
@c Name of host. Should not be used in generic configs, but generic
@c value may catch some flubs.
@set HOST machine specific
@c
@c Name of GCC product
@set NGCC GCC
@c
@c Name of GCC program
@set GCC gcc

1032
gdb/doc/gdb.texinfo
View File

File diff suppressed because it is too large Load Diff

87
gdb/doc/gdbinv-s.texi
View File

@@ -837,19 +837,19 @@ the time of attachment.
@end ifset
@ifset Hviii
@node Hitachi H8/300 Remote
@subsection @value{GDBN} and the Hitachi H8/300
@value{GDBN} needs to know these things to talk to your H8/300:
@node Hitachi H8 Remote
@subsection @value{GDBN} and the Hitachi H8/300 and H8/500
@value{GDBN} needs to know these things to talk to your H8/300 or H8/500:
@enumerate
@item
that you want to use @samp{target hms}, the remote debugging
interface for the H8/300 (this is the default when
GDB is configured specifically for the H8/300);
interface for the H8/300 and H8/500 (this is the default when
GDB is configured specifically for the H8/300 or H8/500);
@item
what serial device connects your host to your H8/300 (the first serial
device available on your host is the default);
what serial device connects your host to your Hitachi board (the first
serial device available on your host is the default);
@ignore
@c this is only for Unix hosts, not currently of interest.
@@ -858,34 +858,34 @@ what speed to use over the serial device.
@end ignore
@end enumerate
@kindex device
@cindex serial device for H8/300
@ignore
@c only for Unix hosts
Use the special @code{gdb83} command @samp{device @var{port}} if you
@kindex device
@cindex serial device, H8/300 or H8/500
Use the special @code{@value{GDBP}} command @samp{device @var{port}} if you
need to explicitly set the serial device. The default @var{port} is the
first available port on your host. This is only necessary on Unix
hosts, where it is typically something like @file{/dev/ttya}.
@kindex speed
@cindex serial line speed for H8/300
@code{gdb83} has another special command to set the communications speed
for the H8/300: @samp{speed @var{bps}}. This command also is only used
from Unix hosts; on DOS hosts, set the line speed as usual from outside
GDB with the DOS @kbd{mode} command (for instance, @w{@samp{mode
@cindex serial line speed, H8/300 or H8/500
@code{@value{GDBP}} has another special command to set the communications
speed: @samp{speed @var{bps}}. This command also is only used from Unix
hosts; on DOS hosts, set the line speed as usual from outside GDB with
the DOS @kbd{mode} command (for instance, @w{@samp{mode
com2:9600,n,8,1,p}} for a 9600 bps connection).
@end ignore
@value{GDBN} depends on an auxiliary terminate-and-stay-resident program
called @code{asynctsr} to communicate with the H8/300 development board
called @code{asynctsr} to communicate with the development board
through a PC serial port. You must also use the DOS @code{mode} command
to set up the serial port on the DOS side.
The following sample session illustrates the steps needed to start a
program under @value{GDBN} control on your H8/300. The example uses a sample
program under @value{GDBN} control on an H8/300. The example uses a sample
H8/300 program called @file{t.x}.
First hook up your H8/300 development board. In this example, we use a
First hook up your development board. In this example, we use a
board attached to serial port @code{COM2}; if you use a different serial
port, substitute its name in the argument of the @code{mode} command.
When you call @code{asynctsr}, the auxiliary comms program used by the
@@ -907,21 +907,22 @@ COM2: 9600, n, 8, 1, p
@emph{Warning:} We have noticed a bug in PC-NFS that conflicts with
@code{asynctsr}. If you also run PC-NFS on your DOS host, you may need to
disable it, or even boot without it, to use @code{asynctsr} to control
your H8/300 board.
your development board.
@end quotation
Now that serial communications are set up, and the H8/300 is connected,
you can start up @value{GDBN}. Call @code{@value{GDBP}} with the name of your
program as the argument. @code{@value{GDBP}} prompts you, as usual, with the
prompt @samp{(@value{GDBP})}. Use two special commands to begin your debugging
session: @samp{target hms} to specify cross-debugging to the Hitachi board,
and the @code{load} command to download your program to the board.
@code{load} displays the names of the
program's sections, and a @samp{*} for each 2K of data downloaded. (If
you want to refresh @value{GDBN} data on symbols or on the executable file
without downloading, use the @value{GDBN} commands @code{file} or
@code{symbol-file}. These commands, and @code{load} itself, are
described in @ref{Files,,Commands to specify files}.)
@kindex target hms
Now that serial communications are set up, and the development board is
connected, you can start up @value{GDBN}. Call @code{@value{GDBP}} with
the name of your program as the argument. @code{@value{GDBP}} prompts
you, as usual, with the prompt @samp{(@value{GDBP})}. Use two special
commands to begin your debugging session: @samp{target hms} to specify
cross-debugging to the Hitachi board, and the @code{load} command to
download your program to the board. @code{load} displays the names of
the program's sections, and a @samp{*} for each 2K of data downloaded.
(If you want to refresh @value{GDBN} data on symbols or on the
executable file without downloading, use the @value{GDBN} commands
@code{file} or @code{symbol-file}. These commands, and @code{load}
itself, are described in @ref{Files,,Commands to specify files}.)
@smallexample
(eg-C:\H8300\TEST) @value{GDBP} t.x
@@ -947,14 +948,14 @@ resumes execution after stopping at a breakpoint. You can use the
@code{help} command at any time to find out more about @value{GDBN} commands.
Remember, however, that @emph{operating system} facilities aren't
available on your H8/300; for example, if your program hangs, you can't
send an interrupt---but you can press the @sc{reset} switch!
available on your development board; for example, if your program hangs,
you can't send an interrupt---but you can press the @sc{reset} switch!
Use the @sc{reset} button on the H8/300 board
Use the @sc{reset} button on the development board
@itemize @bullet
@item
to interrupt your program (don't use @kbd{ctl-C} on the DOS host---it has
no way to pass an interrupt signal to the H8/300); and
no way to pass an interrupt signal to the development board); and
@item
to return to the @value{GDBN} command prompt after your program finishes
@@ -963,7 +964,7 @@ to detect program completion.
@end itemize
In either case, @value{GDBN} will see the effect of a @sc{reset} on the
H8/300 board as a ``normal exit'' of your program.
development board as a ``normal exit'' of your program.
@end ifset
@ifset SIMS
@@ -973,22 +974,22 @@ H8/300 board as a ``normal exit'' of your program.
@ifset GENERIC
@cindex simulator
@cindex simulator, Z8000
@cindex simulator, H8/300
@cindex simulator, H8/300 or H8/500
@cindex Z8000 simulator
@cindex H8/300 simulator
@cindex H8/300 or H8/500 simulator
@cindex CPU simulator
For some configurations, @value{GDBN} includes a CPU simulator that you
can use instead of a hardware CPU to debug your programs. Currently,
a simulator is available when @value{GDBN} is configured to debug Zilog
Z8000 or Hitachi H8/300 targets.
Z8000 or Hitachi H8/300 or H8/500 targets.
@end ifset
@ifclear GENERIC
@ifset Hviii
@cindex simulator, H8/300
@cindex Hitachi H8/300 simulator
When configured for debugging Hitachi H8/300 targets, @value{GDBN} includes
an H8/300 CPU simulator.
@cindex simulator, H8/300 or H8/500
@cindex Hitachi H8/300 or H8/500 simulator
When configured for debugging Hitachi H8/300 or H8/500 targets,
@value{GDBN} includes an H8/300 or H8/500 CPU simulator.
@end ifset
@ifset ZviiiK

50
gdb/doc/h8-config.texi
View File

@@ -1,18 +1,42 @@
@set Hviii
@set HviiiEXCLUSIVE
@clear NOVEL
@set BARETARGET
@set CONLY
@set DOSHOST
@set SIMS
@set AGGLOMERATION
@clear SERIAL
@clear VXWORKS
@clear POSIX
@clear SPARC
@c GDB version number is recorded in the variable GDBVN
@include GDBvn.texi
@c
@set AGGLOMERATION
@clear AMDxxixK
@set BARETARGET
@set CONLY
@set DOSHOST
@clear FSFDOC
@set Hviii
@set HviiiEXCLUSIVE
@clear Icmlx
@clear NOVEL
@clear POSIX
@set PRECONFIGURED
@clear REMOTESTUB
@set SIMS
@clear SERIAL
@clear SPARC
@clear STmm
@set PRECONFIGURED
@clear VXWORKS
@clear ZviiiK
@c ----------------------------------------------------------------------
@c STRINGS:
@c
@c Name of GDB program. Used also for (gdb) prompt string.
@set GDBP gdb
@c
@c Name of GDB product. Used in running text.
@set GDBN GDB
@c
@c Name of GDB initialization file.
@set GDBINIT .gdbinit
@c
@c Name of target.
@set TARGET Hitachi H/300 and H/500
@c
@c Name of GCC product
@set NGCC GCC
@c
@c Name of GCC program
@set GCC gcc