[rfa:doco] switch <- and -> in remote examples

[rfa:doco] switch <- and -> in remote examples

[Andrew Cagney]

Hello,

This patch just switches the use of <- and -> in the remote protocol 
example.  I think it reads better vis:

	-> Z?
	<- OK

(well at least for a left to right reader :-/).

ok?
Andrew

Re: [rfa:doco] switch <- and -> in remote examples

[Daniel Jacobowitz]

On Fri, Aug 23, 2002 at 04:14:25PM -0400, Andrew Cagney wrote:
> Hello,
> 
> This patch just switches the use of <- and -> in the remote protocol 
> example.  I think it reads better vis:
> 
> 	-> Z?
> 	<- OK
> 
> (well at least for a left to right reader :-/).

(No patch, but) I agree.  -> should be what the client is sending,
since it's a client manual.

-- 
Daniel Jacobowitz
MontaVista Software                         Debian GNU/Linux Developer

Re: [rfa:doco] switch <- and -> in remote examples

[Andrew Cagney]

[-- Attachment #1: Type: text/plain, Size: 385 bytes --]

> On Fri, Aug 23, 2002 at 04:14:25PM -0400, Andrew Cagney wrote:
> 
>> Hello,
>> 
>> This patch just switches the use of <- and -> in the remote protocol 
>> example.  I think it reads better vis:
>> 
>> 	-> Z?
>> 	<- OK
>> 
>> (well at least for a left to right reader :-/).
> 
> 
> (No patch, but) I agree.  -> should be what the client is sending,
> since it's a client manual.
> 


[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 2662 bytes --]

2002-08-23  Andrew Cagney  <ac131313@redhat.com>
 
 	* gdb.texinfo (Examples): Use ``->'' for a packet send and ``<-''
 	for a packet receive.
 
Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.114
diff -p -r1.114 gdb.texinfo
*** doc/gdb.texinfo	19 Aug 2002 22:09:03 -0000	1.114
--- doc/gdb.texinfo	23 Aug 2002 20:06:34 -0000
*************** protocol---for example, if there is only
*** 14248,14254 ****
  machine, you might want your program to do something special if it
  recognizes a packet meant for @value{GDBN}.
  
! In the examples below, @samp{<-} and @samp{->} are used to indicate
  transmitted and received data respectfully.
  
  @cindex protocol, @value{GDBN} remote serial
--- 14248,14254 ----
  machine, you might want your program to do something special if it
  recognizes a packet meant for @value{GDBN}.
  
! In the examples below, @samp{->} and @samp{<-} are used to indicate
  transmitted and received data respectfully.
  
  @cindex protocol, @value{GDBN} remote serial
*************** the package was received correctly) or @
*** 14290,14297 ****
  retransmission):
  
  @smallexample
! <- @code{$}@var{packet-data}@code{#}@var{checksum}
! -> @code{+}
  @end smallexample
  @noindent
  
--- 14290,14297 ----
  retransmission):
  
  @smallexample
! -> @code{$}@var{packet-data}@code{#}@var{checksum}
! <- @code{+}
  @end smallexample
  @noindent
  
*************** Example sequence of a target being re-st
*** 15082,15110 ****
  does not get any direct output:
  
  @smallexample
! <- @code{R00}
! -> @code{+}
  @emph{target restarts}
! <- @code{?}
! -> @code{+}
! -> @code{T001:1234123412341234}
  <- @code{+}
  @end smallexample
  
  Example sequence of a target being stepped by a single instruction:
  
  @smallexample
! <- @code{G1445@dots{}}
! -> @code{+}
! <- @code{s}
! -> @code{+}
! @emph{time passes}
! -> @code{T001:1234123412341234}
  <- @code{+}
! <- @code{g}
  -> @code{+}
! -> @code{1455@dots{}}
  <- @code{+}
  @end smallexample
  
  @include gpl.texi
--- 15082,15110 ----
  does not get any direct output:
  
  @smallexample
! -> @code{R00}
! <- @code{+}
  @emph{target restarts}
! -> @code{?}
  <- @code{+}
+ <- @code{T001:1234123412341234}
+ -> @code{+}
  @end smallexample
  
  Example sequence of a target being stepped by a single instruction:
  
  @smallexample
! -> @code{G1445@dots{}}
  <- @code{+}
! -> @code{s}
! <- @code{+}
! @emph{time passes}
! <- @code{T001:1234123412341234}
  -> @code{+}
! -> @code{g}
  <- @code{+}
+ <- @code{1455@dots{}}
+ -> @code{+}
  @end smallexample
  
  @include gpl.texi

Re: [rfa:doco] switch <- and -> in remote examples

[Eli Zaretskii]

> Date: Fri, 23 Aug 2002 16:24:05 -0400
> From: Daniel Jacobowitz <drow@mvista.com>
> > 
> > 	-> Z?
> > 	<- OK
> > 
> > (well at least for a left to right reader :-/).
> 
> (No patch, but) I agree.  -> should be what the client is sending,
> since it's a client manual.

I'd suggest to try to use @result{} for the former, and see if it
gives better results in print.

Otherwise, I don't mind the change.

Re: [rfa:doco] switch <- and -> in remote examples

[Andrew Cagney]

>> Date: Fri, 23 Aug 2002 16:24:05 -0400
>> From: Daniel Jacobowitz <drow@mvista.com>
> 
>> > 
>> > 	-> Z?
>> > 	<- OK
>> > 
>> > (well at least for a left to right reader :-/).
> 
>> 
>> (No patch, but) I agree.  -> should be what the client is sending,
>> since it's a client manual.
> 
> 
> I'd suggest to try to use @result{} for the former, and see if it
> gives better results in print.
> 
> Otherwise, I don't mind the change.

It looks better but the display ends up looking something like:

	=> Z?
	<- OK

(i.e., the send doesn't match the receive).

I've checked this in,
Andrew