Re: [rfa:doco] Update *CONVERT* documentation

[Andrew Cagney <ac131313@redhat.com>]

>> Date: Fri, 13 Jun 2003 15:11:37 -0400
>> From: Andrew Cagney <ac131313@redhat.com>
>> 
>> Attached is a patch to update anything to do with *CONVERT* or *TYPE* so=20
>> that it [hopefully] reflects current reality.
>> 
>> - any thing deprecated is documented as such (and cross referenced to=20
>> the replacement)
>> - the old Raw and Virtual chapter is deleted (it's no longer relevant)
>> - the new methods are updated to match my most recent patch
>> 
>> ok?
> 
> 
> Approved, with the following comments:
> 
> 
>> -You should only use @code{REGISTER_TO_VALUE} with registers for which
>> -the @code{CONVERT_REGISTER_P} macro returns a non-zero value.
>> +@code{REGISTER_TO_VALUE} should only be used with registers for which
>> +@code{CONVERT_REGISTER_P} returns a non-zero value.

That "should" should be a "shall" - it's a strict requirement.

> 
> I'd rather we don't change active voice into passive.  If anything,
> we should change passive into active.

I've never understood this use of the second person active on something 
that is specifying behavior of the third person - GDB (I think I got 
that right).  The above is specifying register_to_value's requirements.

>> +@anchor{register_type} eturns the type that represents the register
> 

Tks.
                         ^^^^^^
> A typo.

enjoy,
Andrew