This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFA/doc] Redefine the length argument in remote Z packets
> Date: Fri, 29 Jan 2010 10:30:24 -0500
> From: Daniel Jacobowitz <dan@codesourcery.com>
> Cc: gdb-patches@sourceware.org
>
> > > Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at
> > > -address @var{addr} of size @var{length}.
> > > +address @var{addr} of size @var{kind}.
> >
> > This is one place where it's confusing.
>
> Because I read this four times and never saw "of size KIND". Ack!
>
> How's this?
We still have a few places similar to "of size KIND":
> -@item z2,@var{addr},@var{length}
> -@itemx Z2,@var{addr},@var{length}
> +@item z2,@var{addr},@var{kind}
> +@itemx Z2,@var{addr},@var{kind}
> @cindex @samp{z2} packet
> @cindex @samp{Z2} packet
> -Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint.
> +Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint covering
> +@var{kind} bytes at @var{addr}.
"covering KIND bytes" sounds awkward. How about
Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint.
@var{kind} is 2 for watching a 2-byte region, 4 for watching a
4-byte region.
and similarly with Z3 and Z4?
Also, here:
> +and @sc{mips} can insert either a 2 or 4 byte breakpoint. Some
> +architectures have additional meanings for @var{kind};
> +@xref{Architecture-Specific Protocol Details}.
you want "see @ref" instead of "@xref", because the latter produces a
capitalized "See", which will look wrong after a semi-colon.