[PATCH] DOCO: Enhance the menu to select function overloads with signatures

Pierre-Marie de Rodat derodat@adacore.com
Tue Dec 8 09:22:00 GMT 2015


On 12/07/2015 05:00 PM, Eli Zaretskii wrote:
>> +* In Ada, the overloads selection menu has been enhance to display the
>                                                     ^^^^^^^
> "enhanced"

Fixed.

>> +show ada print-signatures"
>> +  Control whether parameter types and return types are displayed in overloads
>> +  selection menus. It is activaled (@code{on}) by default.
>                      ^^
> Two spaces between sentences, please.

Fixed here and in the other occurence.

> This index entry is backwards: it should be "overloading, Ada".
> That's because the reader is much more likely to think of
> "overloading" than of "Ada" when she wants to look up this entry.

Fixed, thank you for the rationale.

>> +If, after narrowing, the set of matching definitions still contains more than
>> +one definition, GDB will display a menu to query which one it should use, for
>                     ^^^
> "@value{GDBN}"

Fixed.

> @kbd{0} and @key{RET}, respectively.  These are GNU conventions for
> markup of user input and key names.

Done, thanks.

>> +specific overloaded entity (type the corresponding number and press
>
> Won't "specific instance" be more accurate?  Those entries are no
> longer overloaded, are they?

I’m not sure what you mean here: the reason we have this menu is because 
the name “f” is overloaded (i.e. multiple entities have the same name). 
They still have the same name when the user is about to select one of 
them, so they are still overloaded.

… Anyway I switched to “specific instance” as it’s correct. ;-)

>> +@code{ENTER}).
>
> @key{RET}.

Fixed.

>> +@kindex set ada print-signatures
>> +@item set ada print-signatures
>> +Control whether parameter types and return types are displayed in overloads
>> +selection menus. It is activaled (@code{on}) by default.
>                    ^^
> Two spaces where indicated.  Also, I thing you can safely delete
> "activated" and leave just @code{on} without parentheses.

Done.

>> +@pxref{Overloading support for Ada}
>
> @xref, not @pxref, and place a period after the closing brace.

Fixed the two occurences.

> OK with these fixed.
>
> Thanks.

Pushed now. Many thanks for reviewing!

-- 
Pierre-Marie de Rodat



More information about the Gdb-patches mailing list