Re: Flash support part 3: documentation

[Daniel Jacobowitz <drow at false dot org>]

On Sat, Jul 22, 2006 at 05:05:28PM +0300, Eli Zaretskii wrote:
> > Here's yet another revision of the patch.
> 
> This is approved to go in; thanks.

Hi Eli,

I'll be around to applying these patches shortly, after unanticipated
delay.  I have two small changes to the documentation; does this look
OK (along with Vlad's patch)?  The only changes are a minor grammar
nit, and a clarification for one thing we found particularly confusing
when implementing this spec: that vFlashWrite packets only have an
ordering requirement w.r.t. other vFlashWrite packets, but that GDB's
behavior of sending all the erase packets before any write packets
was intended to be OK.

-- 
Daniel Jacobowitz
CodeSourcery

Index: src/gdb/doc/gdb.texinfo
===================================================================
--- src.orig/gdb/doc/gdb.texinfo	2006-09-20 18:18:50.000000000 -0400
+++ src/gdb/doc/gdb.texinfo	2006-09-20 18:12:14.000000000 -0400
@@ -23181,10 +23181,12 @@ Direct the stub to write data to flash a
 is passed in binary form using the same encoding as for the @samp{X}
 packet (@pxref{Binary Data}).  The memory ranges specified by
 @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must
-not overlap, and must appear in order of increasing addresses.  If a
-packet writes to an address that was neither erased by a preceding
-@samp{vFlashErase} packet nor by some other target-specific method,
-the results are unpredictable.
+not overlap, and must appear in order of increasing addresses
+(although @samp{vFlashErase} packets for higher addresses may already
+have been received; the ordering is guaranteed only between
+@samp{vFlashWrite} packets).  If a packet writes to an address that was
+neither erased by a preceding @samp{vFlashErase} packet nor by some other
+target-specific method, the results are unpredictable.
 
 
 Reply:
@@ -25367,7 +25369,7 @@ host is called:
 @section Memory map format
 @cindex memory map format
 
-To be able to write into flash memory, @value{GDBN} needs to obtain
+To be able to write into flash memory, @value{GDBN} needs to obtain a
 memory map from the target.  This section describes the format of the
 memory map.