Formatting improvements from 93q4 release.
authorRoland Pesch <pesch@cygnus>
Mon, 29 Nov 1993 05:58:11 +0000 (05:58 +0000)
committerRoland Pesch <pesch@cygnus>
Mon, 29 Nov 1993 05:58:11 +0000 (05:58 +0000)
gdb/doc/ChangeLog
gdb/doc/gdb.texinfo
gdb/doc/remote.texi
readline/doc/rluser.texinfo

index aa3f5170831321a39e848b820022f8ca713bafdc..8707c41390ddac854c7684117218f370f90d2026 100644 (file)
@@ -1,5 +1,7 @@
 Sun Nov 28 18:06:25 1993  Roland H. Pesch  (pesch@fowanton.cygnus.com)
 
+       * gdb.texinfo, remote.texi: formatting improvements
+
        * gdb.texinfo (New Features): mention threads.
        (Summary, C): fix xrefs in newly contributed text.
        (Threads): index entries, clarifications, example
index ebb8e01dd95a3dc6257a94e30b55e220d98cfb05..1111f8076322ebd1f1fc318cc7a101b813df5ae5 100644 (file)
@@ -29,7 +29,7 @@
 @syncodeindex vr cp
 
 @c !!set GDB manual's edition---not the same as GDB version!
-@set EDITION 4.10
+@set EDITION 4.11
 
 @c !!set GDB manual's revision date
 @set DATE November 1993
@@ -217,16 +217,16 @@ more information, see @ref{C,,C and C++}.
 Support for Modula-2 and Chill is partial.  For information on Modula-2,
 see @ref{Modula-2,,Modula-2}.  There is no further documentation on Chill yet.
 
-Debugging pascal programs which use sets, subranges, file variables, or nested
+Debugging Pascal programs which use sets, subranges, file variables, or nested
 functions does not currently work.  @value{GDBN} does not support
-entering expressions, printing values, etc. using Pascal syntax.
+entering expressions, printing values, or similar features using Pascal syntax.
 @end ifset
 @ifset FORTRAN
 @cindex Fortran
 @value{GDBN} can be used to debug programs written in Fortran, although
-it does not yet support entering expressions, printing values, etc.
-using Fortran syntax.  It may be necessary to refer to some variables
-with a trailing underscore.
+it does not yet support entering expressions, printing values, or
+similar features using Fortran syntax.  It may be necessary to refer to
+some variables with a trailing underscore.
 @end ifset
 @end ifclear
 
@@ -344,7 +344,7 @@ Hitachi America, Ltd. sponsored the support for Hitachi microprocessors.
 @item Targets
 Using the new command @code{target}, you can select at runtime whether
 you are debugging local files, local processes, standalone systems over
-a serial port, realtime systems over a TCP/IP connection, etc.  The
+a serial port, or realtime systems over a TCP/IP connection.  The
 command @code{load} can download programs into a remote system.  Serial
 stubs are available for Motorola 680x0, Intel 80386, and Sparc remote
 systems; GDB also supports debugging realtime processes running under
@@ -791,8 +791,8 @@ in sequential order.  The order makes a difference when the
 * i960-Nindy Remote::          @value{GDBN} with a remote i960 (Nindy)
 @end ifset
 @ifset AMD29K
-* UDI29K Remote::               @value{GDBN} and the UDI protocol for AMD29K
-* EB29K Remote::               @value{GDBN} with a remote EB29K
+* UDI29K Remote::               The UDI protocol for AMD29K
+* EB29K Remote::               The EBMON protocol for AMD29K
 @end ifset
 @ifset VXWORKS
 * VxWorks Remote::             @value{GDBN} and VxWorks
@@ -2177,9 +2177,10 @@ program stops there.  @xref{Disabling, ,Disabling breakpoints}.
 Set breakpoints on all functions matching the regular expression
 @var{regex}.  This command
 sets an unconditional breakpoint on all matches, printing a list of all
-breakpoints it set. Once these breakpoints are set, they are treated
-just like the breakpoints set with the @code{break} command.  They can
-be deleted, disabled, made conditional, etc., in the standard ways.
+breakpoints it set.  Once these breakpoints are set, they are treated
+just like the breakpoints set with the @code{break} command.  You can
+delete them, disable them, or make them conditional the same way as any
+other breakpoint.
 
 @ifclear CONLY
 When debugging C++ programs, @code{rbreak} is useful for setting
@@ -3306,7 +3307,9 @@ frame.  The first line shows the frame number, the function name, the
 arguments, and the source file and line number of execution in that
 frame.  The second line shows the text of that source line.  
 
+@need 1000
 For example:
+
 @smallexample
 @group
 (@value{GDBP}) up
@@ -3621,8 +3624,8 @@ directory, @value{GDBN} will, as a last resort, look in the current
 directory.
 
 Whenever you reset or rearrange the source path, @value{GDBN} will clear out
-any information it has cached about where source files are found, where
-each line is in the file, etc.
+any information it has cached about where source files are found and where
+each line is in the file.
 
 @kindex directory
 When you start @value{GDBN}, its source path is empty.
@@ -7178,7 +7181,7 @@ CPU simulator.  @xref{Simulator,,Simulated CPU Target}.
 @kindex target udi
 Remote AMD29K target, using the AMD UDI protocol.  The @var{keyword}
 argument specifies which 29K board or simulator to use.  @xref{UDI29K
-Remote,,@value{GDBN} and the UDI protocol for AMD29K}.
+Remote,,The UDI protocol for AMD29K}.
 
 @item target amd-eb @var{dev} @var{speed} @var{PROG}
 @kindex target amd-eb
@@ -7187,7 +7190,7 @@ Remote PC-resident AMD EB29K board, attached over serial lines.
 @var{dev} is the serial device, as for @code{target remote};
 @var{speed} allows you to specify the linespeed; and @var{PROG} is the
 name of the program to be debugged, as it appears to DOS on the PC.
-@xref{EB29K Remote, ,@value{GDBN} with a remote EB29K}.
+@xref{EB29K Remote, ,The EBMON protocol for AMD29K}.
 
 @end ifset
 @ifset H8
@@ -7266,8 +7269,8 @@ configuration of GDB; use @code{help targets} to list them.
 * i960-Nindy Remote::          @value{GDBN} with a remote i960 (Nindy)
 @end ifset
 @ifset AMD29K
-* UDI29K Remote::               @value{GDBN} and the UDI protocol for AMD29K
-* EB29K Remote::               @value{GDBN} with a remote EB29K
+* UDI29K Remote::               The UDI protocol for AMD29K
+* EB29K Remote::               The EBMON protocol for AMD29K
 @end ifset
 @ifset VXWORKS
 * VxWorks Remote::             @value{GDBN} and VxWorks
@@ -8277,7 +8280,7 @@ We recommend that you save your time for something else.
 Of course, if you can find a simpler example to report @emph{instead}
 of the original one, that is a convenience for us.  Errors in the
 output will be easier to spot, running under the debugger will take
-less time, etc.
+less time, and so on.
 
 However, simplification is not vital; if you do not want to do this,
 report the bug anyway and send us the entire test case you used.
@@ -8770,6 +8773,8 @@ Display a quick summary of how to invoke @code{configure}.
 Configure the source to install programs and files under directory
 @file{@var{dir}}.
 
+@c avoid splitting the warning from the explanation:
+@need 2000
 @item --srcdir=@var{path}
 @strong{Warning: using this option requires GNU @code{make}, or another
 @code{make} that implements the @code{VPATH} feature.}@*
index 26611a8c1051ce05f2c36ffae3b5f18a4c2aad56..cfa37ccbc0e801cd9ddf52e00f09358975894cae 100644 (file)
@@ -196,7 +196,7 @@ its meaning is architecture-dependent (for example, different numbers
 might represent divide by zero, misaligned access, etc).  When this
 exception occurs, control should be transferred directly to
 @var{exception_address}, and the processor state (stack, registers,
-etc.) should be just as it is when a processor exception occurs.  So if
+and so on) should be just as it is when a processor exception occurs.  So if
 you want to use a jump instruction to reach @var{exception_address}, it
 should be a simple jump, not a jump to subroutine.
 
@@ -339,7 +339,7 @@ remote} again to connect once more.)  If you type @kbd{n}, @value{GDBN}
 goes back to waiting.
 
 @node Protocol
-@subsubsection Outline of the communication protocol
+@subsubsection Communication protocol
 
 @cindex debugging stub, example
 @cindex remote stub, example
@@ -401,10 +401,12 @@ Read @var{count} bytes at location @var{addr}.
 @item M@var{addr},@var{count}:@dots{}
 Write @var{count} bytes at location @var{addr}.
 
+@need 500
 @item c
 @itemx c@var{addr}
 Resume execution at the current address (or at @var{addr} if supplied).
 
+@need 500
 @item s
 @itemx s@var{addr}
 Step the target program for one instruction, from either the current
@@ -643,7 +645,7 @@ a break is detected.
 
 @ifset AMD29K
 @node UDI29K Remote
-@subsection @value{GDBN} and the UDI protocol for AMD29K
+@subsection The UDI protocol for AMD29K
 
 @cindex UDI
 @cindex AMD29K via UDI
@@ -666,7 +668,7 @@ to its pathname.
 @end table
 
 @node EB29K Remote
-@subsection @value{GDBN} and the EBMON protocol for AMD29K
+@subsection The EBMON protocol for AMD29K
 
 @cindex EB29K board
 @cindex running 29K programs
@@ -810,6 +812,7 @@ cd /usr/joe/work29k
 @value{GDBP} myfoo
 @end example
 
+@need 500
 Now you can use the @code{target} command:
 
 @example
@@ -958,6 +961,7 @@ network.  To connect to a target whose host name is ``@code{tt}'', type:
 (vxgdb) target vxworks tt
 @end example
 
+@need 750
 @value{GDBN} displays messages like these:
 
 @smallexample
@@ -965,6 +969,7 @@ Attaching remote machine across net...
 Connected to tt.
 @end smallexample
 
+@need 1000
 @value{GDBN} then attempts to read the symbol tables of any object modules
 loaded into the VxWorks target since it was last booted.  @value{GDBN} locates
 these files by searching the directories listed in the command search
@@ -1188,7 +1193,7 @@ development board as a ``normal exit'' of your program.
 MIPS board attached to a serial line.  This is available when
 you configure @value{GDBN} with @samp{--target=mips-idt-ecoff}.
 
-@noindent
+@need 1000
 Use these @value{GDBN} commands to specify the connection to your target board:
 
 @table @code
index 67fe64e57dd378264b6631fbd4a4793134c7aaf8..869ab93eb3aa3cfe966ad986e8f405c0af0d94d8 100644 (file)
@@ -124,7 +124,6 @@ empty line.
 @node Readline Movement Commands
 @subsection Readline Movement Commands
 
-
 The above table describes the most basic possible keystrokes that you need
 in order to do editing of the input line.  For your convenience, many
 other commands have been added in addition to @key{C-b}, @key{C-f},
@@ -340,8 +339,10 @@ In the above example, @key{C-u} is bound to the function
 * Miscellaneous Commands::     Other miscillaneous commands.
 @end menu
 
+@need 2000
 @node Commands For Moving
 @subsubsection Commands For Moving
+
 @ftable @code
 @item beginning-of-line (@key{C-a})
 Move to the start of the current line.
@@ -366,6 +367,7 @@ Clear the screen leaving the current line at the top of the screen.
 
 @end ftable
 
+@need 2000
 @node Commands For History
 @subsubsection Commands For Manipulating The History
 
@@ -393,10 +395,11 @@ the history as necessary.  This is an incremental search.
 
 @item forward-search-history (@key{C-s})
 Search forward starting at the current line and moving `down' through
-the the history as neccessary.
+the the history as necessary.
 
 @end ftable
 
+@need 2000
 @node Commands For Text
 @subsubsection Commands For Changing Text
 
@@ -443,11 +446,11 @@ negative argument, do the previous word, but do not move point.
 
 @end ftable
 
+@need 2000
 @node Commands For Killing
 @subsubsection Killing And Yanking
 
 @ftable @code
-
 @item kill-line (@key{C-k})
 Kill the text from the current cursor position to the end of the line.
 
@@ -478,8 +481,10 @@ Rotate the kill-ring, and yank the new top.  You can only do this if
 the prior command is yank or yank-pop.
 @end ftable
 
+@need 2000
 @node Numeric Arguments
 @subsubsection Specifying Numeric Arguments
+
 @ftable @code
 
 @item digit-argument (@key{M-0}, @key{M-1}, ... @key{M--})
@@ -491,6 +496,7 @@ Do what @key{C-u} does in emacs.  By default, this is not bound.
 @end ftable
 
 
+@need 2000
 @node Commands For Completion
 @subsubsection Letting Readline Type For You
 
@@ -507,8 +513,10 @@ you can do variable name completion...
 List the possible completions of the text before point.
 @end ftable
 
+@need 2000
 @node Miscellaneous Commands
 @subsubsection Some Miscellaneous Commands
+
 @ftable @code
 
 @item re-read-init-file (@key{C-x} @key{C-r})
@@ -539,6 +547,7 @@ Undo all changes made to this line.  This is like typing the `undo'
 command enough times to get back to the beginning.
 @end ftable
 
+@need 2000
 @node Readline Vi Mode
 @subsection Readline Vi Mode