[PATCH] Doc corrections to gdb.texinfo

[PATCH] Doc corrections to gdb.texinfo

[Nick Roberts]

Probably obvious, but not committed just in case.

OK to commit?

-- 
Nick                                           http://www.inet.net.nz/~nickrob


2007-02-16  Nick Roberts  <nickrob@snap.net.nz>

	* gdb.texinfo (Top): Put Appendix A after numbered sections.
	(Files): Use correct title for pxref.
	(Non-debug DLL symbols): Don't use `see' for pxref.
	(Embedded Processors): Fix typo.
	(GDB/MI Breakpoint Commands): Execution commands generate
	*stopped not ^done.


*** gdb.texinfo	16 Feb 2007 16:02:24 +1300	1.386
--- gdb.texinfo	16 Feb 2007 16:45:13 +1300	
*************** Copyright (C) 1988-2006 Free Software Fo
*** 151,160 ****
  * GDB/MI::                      @value{GDBN}'s Machine Interface.
  
  * GDB Bugs::                    Reporting bugs in @value{GDBN}
- * Formatting Documentation::    How to format and print @value{GDBN} documentation
  
  * Command Line Editing::        Command Line Editing
  * Using History Interactively:: Using History Interactively
  * Installing GDB::              Installing GDB
  * Maintenance Commands::        Maintenance Commands
  * Remote Protocol::             GDB Remote Serial Protocol
--- 151,160 ----
  * GDB/MI::                      @value{GDBN}'s Machine Interface.
  
  * GDB Bugs::                    Reporting bugs in @value{GDBN}
  
  * Command Line Editing::        Command Line Editing
  * Using History Interactively:: Using History Interactively
+ * Formatting Documentation::    How to format and print @value{GDBN} documentation
  * Installing GDB::              Installing GDB
  * Maintenance Commands::        Maintenance Commands
  * Remote Protocol::             GDB Remote Serial Protocol
*************** Out of @value{GDBN}}).
*** 11458,11465 ****
  Occasionally it is necessary to change to a different file during a
  @value{GDBN} session.  Or you may run @value{GDBN} and forget to
  specify a file you want to use.  Or you are debugging a remote target
! via @code{gdbserver} (@pxref{Server, file}).  In these situations the
! @value{GDBN} commands to specify new files are useful.
  
  @table @code
  @cindex executable file
--- 11458,11466 ----
  Occasionally it is necessary to change to a different file during a
  @value{GDBN} session.  Or you may run @value{GDBN} and forget to
  specify a file you want to use.  Or you are debugging a remote target
! via @code{gdbserver} (@pxref{Server, , Using the gdbserver
! program}).  In these situations the @value{GDBN} commands to specify
! new files are useful.
  
  @table @code
  @cindex executable file
*************** Note that the internal name of the DLL m
*** 13802,13809 ****
  though the file name of the DLL is lower-case, or vice-versa. Since
  symbols within @value{GDBN} are @emph{case-sensitive} this may cause
  some confusion. If in doubt, try the @code{info functions} and
! @code{info variables} commands or even @code{maint print msymbols} (see
! @pxref{Symbols}). Here's an example:
  
  @smallexample
  (@value{GDBP}) info function CreateFileA
--- 13803,13810 ----
  though the file name of the DLL is lower-case, or vice-versa. Since
  symbols within @value{GDBN} are @emph{case-sensitive} this may cause
  some confusion. If in doubt, try the @code{info functions} and
! @code{info variables} commands or even @code{maint print msymbols}
! (@pxref{Symbols}). Here's an example:
  
  @smallexample
  (@value{GDBP}) info function CreateFileA
*************** acceptable commands.
*** 14279,14285 ****
  * MIPS Embedded::               MIPS Embedded
  * OpenRISC 1000::               OpenRisc 1000
  * PA::                          HP PA Embedded
! * PowerPC:                      PowerPC
  * SH::                          Renesas SH
  * Sparclet::                    Tsqware Sparclet
  * Sparclite::                   Fujitsu Sparclite
--- 14280,14286 ----
  * MIPS Embedded::               MIPS Embedded
  * OpenRISC 1000::               OpenRisc 1000
  * PA::                          HP PA Embedded
! * PowerPC::                     PowerPC
  * SH::                          Renesas SH
  * Sparclet::                    Tsqware Sparclet
  * Sparclite::                   Fujitsu Sparclite
*************** Setting a watchpoint on a variable in th
*** 18431,18437 ****
  (gdb)
  -exec-continue
  ^running
! ^done,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
  value=@{old="-268439212",new="55"@},
  frame=@{func="main",args=[],file="recursive2.c",
  fullname="/home/foo/bar/recursive2.c",line="5"@}
--- 18432,18439 ----
  (gdb)
  -exec-continue
  ^running
! (gdb)
! *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
  value=@{old="-268439212",new="55"@},
  frame=@{func="main",args=[],file="recursive2.c",
  fullname="/home/foo/bar/recursive2.c",line="5"@}
*************** for the watchpoint going out of scope.
*** 18449,18455 ****
  (gdb)
  -exec-continue
  ^running
! ^done,reason="watchpoint-trigger",
  wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
  frame=@{func="callee4",args=[],
  file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
--- 18451,18458 ----
  (gdb)
  -exec-continue
  ^running
! (gdb)
! *stopped,reason="watchpoint-trigger",
  wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
  frame=@{func="callee4",args=[],
  file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
*************** fullname="/home/foo/bar/devo/gdb/testsui
*** 18457,18463 ****
  (gdb)
  -exec-continue
  ^running
! ^done,reason="watchpoint-scope",wpnum="5",
  frame=@{func="callee3",args=[@{name="strarg",
  value="0x11940 \"A string argument.\""@}],
  file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
--- 18460,18467 ----
  (gdb)
  -exec-continue
  ^running
! (gdb)
! *stopped,reason="watchpoint-scope",wpnum="5",
  frame=@{func="callee3",args=[@{name="strarg",
  value="0x11940 \"A string argument.\""@}],
  file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
*************** enabled="y",addr="",what="C",times="0"@}
*** 18491,18497 ****
  (gdb)
  -exec-continue
  ^running
! ^done,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
  value=@{old="-276895068",new="3"@},
  frame=@{func="callee4",args=[],
  file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
--- 18495,18502 ----
  (gdb)
  -exec-continue
  ^running
! (gdb)
! *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
  value=@{old="-276895068",new="3"@},
  frame=@{func="callee4",args=[],
  file="../../../devo/gdb/testsuite/gdb.mi/basics.c",

Re: [PATCH] Doc corrections to gdb.texinfo

[Eli Zaretskii]

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Fri, 16 Feb 2007 16:59:25 +1300
> 
> Probably obvious, but not committed just in case.
> 
> OK to commit?

Thanks, all the changes are okay with me, with the exception of this
one:

> *************** Out of @value{GDBN}}).
> *** 11458,11465 ****
>   Occasionally it is necessary to change to a different file during a
>   @value{GDBN} session.  Or you may run @value{GDBN} and forget to
>   specify a file you want to use.  Or you are debugging a remote target
> ! via @code{gdbserver} (@pxref{Server, file}).  In these situations the
> ! @value{GDBN} commands to specify new files are useful.
>   
>   @table @code
>   @cindex executable file
> --- 11458,11466 ----
>   Occasionally it is necessary to change to a different file during a
>   @value{GDBN} session.  Or you may run @value{GDBN} and forget to
>   specify a file you want to use.  Or you are debugging a remote target
> ! via @code{gdbserver} (@pxref{Server, , Using the gdbserver
> ! program}).  In these situations the @value{GDBN} commands to specify
> ! new files are useful.
>   
>   @table @code
>   @cindex executable file

Can you explain why you thought this change was necessary?

Re: [PATCH] Doc corrections to gdb.texinfo

[Nick Roberts]

 > Thanks, all the changes are okay with me, with the exception of this
 > one:
 > 
 > > *************** Out of @value{GDBN}}).
 > > *** 11458,11465 ****
 > >   Occasionally it is necessary to change to a different file during a
 > >   @value{GDBN} session.  Or you may run @value{GDBN} and forget to
 > >   specify a file you want to use.  Or you are debugging a remote target
 > > ! via @code{gdbserver} (@pxref{Server, file}).  In these situations the
 > > ! @value{GDBN} commands to specify new files are useful.
 > >   
 > >   @table @code
 > >   @cindex executable file
 > > --- 11458,11466 ----
 > >   Occasionally it is necessary to change to a different file during a
 > >   @value{GDBN} session.  Or you may run @value{GDBN} and forget to
 > >   specify a file you want to use.  Or you are debugging a remote target
 > > ! via @code{gdbserver} (@pxref{Server, , Using the gdbserver
 > > ! program}).  In these situations the @value{GDBN} commands to specify
 > > ! new files are useful.
 > >   
 > >   @table @code
 > >   @cindex executable file
 > 
 > Can you explain why you thought this change was necessary?

The cross reference name `file' doesn't mean anything to me.  Perhaps the
author was confused by the name of the node that the link is already in.  In
any case I think that the section name being linked to is clearer.

-- 
Nick                                           http://www.inet.net.nz/~nickrob

Re: [PATCH] Doc corrections to gdb.texinfo

[Eli Zaretskii]

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Sun, 18 Feb 2007 10:33:45 +1300
> Cc: gdb-patches@sourceware.org
> 
> The cross reference name `file' doesn't mean anything to me.

It refers to the fact that you specify a file, as the surrounding text
suggests.  Moreover, at least in the stand-alone Info reader, the
``file'' thing causes it to look for the string "file" in the
referenced node and put point there, if found.  So it looks like in
this case, whoever added that ``file'' part, actually knew what they
were doing.

> In any case I think that the section name being linked to is
> clearer.

We can have them both: your change left the second argument of @pxref
empty.  How about leaving ``file'' in the second argument, and adding
your 3rd arg?

Re: [PATCH] Doc corrections to gdb.texinfo

[Nick Roberts]

 > > The cross reference name `file' doesn't mean anything to me.
 > 
 > It refers to the fact that you specify a file, as the surrounding text
 > suggests.  Moreover, at least in the stand-alone Info reader, the
 > ``file'' thing causes it to look for the string "file" in the
 > referenced node and put point there, if found.  So it looks like in
 > this case, whoever added that ``file'' part, actually knew what they
 > were doing.

You're probably right.  I keep thinking I'm looking directly at info in Emacs
and forget that, for some reason, it puts own unique spin on things.

 > > In any case I think that the section name being linked to is
 > > clearer.
 > 
 > We can have them both: your change left the second argument of @pxref
 > empty.  How about leaving ``file'' in the second argument, and adding
 > your 3rd arg?

OK, I've done that and committed the changes.

-- 
Nick                                           http://www.inet.net.nz/~nickrob

Re: [PATCH] Doc corrections to gdb.texinfo

[Eli Zaretskii]

> From: Nick Roberts <nickrob@snap.net.nz>
> Date: Sun, 18 Feb 2007 21:05:55 +1300
> Cc: gdb-patches@sourceware.org
> 
> OK, I've done that and committed the changes.

Thanks.