Re: [PATCH] memattr bounds

[Jim Blandy <jimb at redhat dot com>]

Don Howard <dhoward@redhat.com> writes:
> Is the doco descriptive enough?  I'm trying to be brief without being
> terse...
> Index: doc/gdb.texinfo
> ===================================================================
> RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
> retrieving revision 1.102
> diff -p -u -w -r1.102 gdb.texinfo
> --- doc/gdb.texinfo	11 Jun 2002 20:36:57 -0000	1.102
> +++ doc/gdb.texinfo	24 Jun 2002 21:59:06 -0000
> @@ -5601,9 +5601,10 @@ to enable, disable, or remove a memory r
>  
>  @table @code
>  @kindex mem
> -@item mem @var{address1} @var{address2} @var{attributes}@dots{}
> -Define memory region bounded by @var{address1} and @var{address2}
> -with attributes @var{attributes}@dots{}.
> +@item mem @var{lower} @var{upper} @var{attributes}@dots{}
> +Define memory region bounded by @var{lower} and @var{upper} with
> +attributes @var{attributes}@dots{}.  Note that @var{upper} == 0 is a
> +special case: it indicates the max memory address.

Why try to be terse or brief?  This is the reference manual; it's more
important to be clear and complete, no?

Also, I don't think it's cool to use `==' in the reference manual;
it's supposed to be English.  :)

        As a special case, if @var{upper} is zero, then the memory
        region ends at the top of the address space.