This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: Document how to exit "python-interactive"
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Khoo Yit Phang <khooyp at cs dot umd dot edu>
- Cc: gdb-patches at sourceware dot org, khooyp at cs dot umd dot edu
- Date: Thu, 23 Aug 2012 19:47:49 +0300
- Subject: Re: Document how to exit "python-interactive"
- References: <E4E55FE9-8E45-49D4-8DC7-31A2DC7EE56E@cs.umd.edu>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> From: Khoo Yit Phang <khooyp@cs.umd.edu>
> Date: Thu, 23 Aug 2012 12:29:17 -0400
> Cc: Khoo Yit Phang <khooyp@cs.umd.edu>
>
> I'd like to update the documentation to explain how to return from "python-interactive" to GDB.
Thanks.
>
> Thanks!
>
> Yit
> August 23, 2012
>
>
> [2:text/plain Hide Save:python-interactive-exit.txt (1kB)]
>
> # HG changeset patch
> # Parent 3a8ab84de40f6a3b09615bd9f9acef671062c85c
> Document how to return from "python-interactive" to GDB.
>
> gdb/ChangeLog:
>
> 2012-08-23 Khoo Yit Phang <khooyp@cs.umd.edu>
>
> Document how to return from "python-interactive" to GDB.
> * doc/gdb.texinfo (Python Commands): Update documentation.
> * python/python.c (_initialize_python): Update documentation.
>
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -22515,7 +22515,8 @@
> @item python-interactive @r{[}@var{command}@r{]}
> @itemx pi @r{[}@var{command}@r{]}
> Without an argument, the @code{python-interactive} command can be used
> -to start an interactive Python prompt.
> +to start an interactive Python prompt. To return to @value{GDBN},
> +type @code{EOF} (e.g., @samp{Ctrl-D}) on an empty prompt.
I think "type the @code{EOF} character" is better.
Also, please use @kbd{Ctrl-D}. Finally, I think "on the empty prompt"
is redundant (and may even be incorrect -- doesn't it work even on a
non-empty line?).
> python_interactive_command,
> #ifdef HAVE_PYTHON
> _("\
> -Start a Python interactive prompt.\n\
> +Start a Python interactive prompt. To return to GDB, type EOF\n\
I think the second sentence should begin on a new line. Don't you get
that line truncated in "apropos" output?
OK with those changes.