This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

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


> From: Pierre-Marie de Rodat <derodat@adacore.com>
> Cc: Joel Brobecker <brobecker@adacore.com>,	Pierre-Marie de Rodat <derodat@adacore.com>
> Date: Mon,  7 Dec 2015 13:35:48 +0100
> 
> diff --git a/gdb/NEWS b/gdb/NEWS
> index a222dfb..060f1e2 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -28,6 +28,9 @@
>    and "maint info program-spaces" now list the corresponding items in
>    ascending ID order, for consistency with all other "info" commands.
>  
> +* In Ada, the overloads selection menu has been enhance to display the
                                                   ^^^^^^^
"enhanced"

> +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.

> +@node Overloading support for Ada
> +@subsubsection Overloading support for Ada
> +@cindex Ada, overloading

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.

> +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}"

> +In this case, just select one menu entry either to cancel expression evaluation
> +(type @code{0} and press @code{ENTER}) or to continue evaluation with a
         ^^^^^^^^           ^^^^^^^^^^^^
@kbd{0} and @key{RET}, respectively.  These are GNU conventions for
markup of user input and key names.

> +specific overloaded entity (type the corresponding number and press

Won't "specific instance" be more accurate?  Those entries are no
longer overloaded, are they?

> +@code{ENTER}).

@key{RET}.

> +@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.

> +@pxref{Overloading support for Ada}

@xref, not @pxref, and place a period after the closing brace.

OK with these fixed.

Thanks.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]