This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [python] [patch] set/show extended-prompt
- From: Eli Zaretskii <eliz at gnu dot org>
- To: pmuldoon at redhat dot com
- Cc: gdb-patches at sourceware dot org
- Date: Thu, 11 Aug 2011 19:20:56 +0300
- Subject: Re: [python] [patch] set/show extended-prompt
- References: <m3liv0yol6.fsf@redhat.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> From: Phil Muldoon <pmuldoon@redhat.com>
> Date: Thu, 11 Aug 2011 16:06:45 +0100
>
>
> This patch adds extended-prompt capabilities to GDB. In addition it
> adds a prompt substitution library. I made the extended-prompt lazily
> control the prompt_hook on setting, over controlling it unconditionally. The
> rest of the function remains the same other than in-Python documentation
> as was found in Archer.
Thanks, I have a few comments about the documentation part:
> +@xref{gdb.prompt} for a list of the flags that can be used for
^
If you run "make info", it will complain here, because you need to add
a comma after the right brace.
> + The prompt is updated with the value of the
> +flags each time it is displayed.
Is "flags" a good term? I think "escape sequence" is better, e.g.:
Any escape sequences specified as part of the prompt string are
replaced with the corresponding strings each time the prompt is
displayed.
> +Note that when an extended-prompt is set, it takes control of the
> +@var{prompt_hook} hook. @xref{prompt_hook} for further information.
^
Likewise, you need a comma here.
> +@item show extended-prompt
> +Prints the extended prompt. Each time the prompt is displayed, it is
> +updated with the current value of the flags passed to it with ``set
> +extended-prompt''.
@code{set extended-prompt}. And the same comment about "flags"
applies here as well.
> +@smallexample
> +substitute_prompt (``frame: \f, print arguments: \p@{print frame-arguments@}'')
> +@end smallexample
The line inside @example should be broken into two, as it is too long.
> +will return the string:
This line needs an @exdent before it, because it is not a new
paragraph.
> +@smallexample
> +``frame: main, print arguments: scalars''
> +@end smallexample
Aren't these ``..'' quotes left verbatim in the printed version of the
manual? I think you need literal ".." quotes here, since they are not
converted inside @smallexample.