Make documentation of "python" command match actual behavior

The example in the documentation for the "python" command shows GDB
outputting instructions for how to terminate a sequence of python
commands entered from the command line.  The documentation shows that
the following two lines are being output, though this does not occur
when actually using the "python" command from GDB:

    Type python script
    End with a line saying just "end".

While display of this text might be helpful, GDB has several other
commands which also use the "end" terminator that offer no such text.
Examples include the "if" and "while" commands.  For example,

(gdb) if 1==1
 >print "a"
 >end
$1 = "a"

This seems similar to doing:

(gdb) python
 >print 23
 >end
23

If we decide that we want the "python" command to print such a message,
we should also adjust the behavior for other GDB commands which also use
"end" to terminate a command list.  I.e, if this decision is made, the
"if" and "while" commands ought to also print similar messages.

So, for the moment anyway, this commit adjusts the documentation of the
python command to match its implementation.

This patch was taken from a larger body of work originating from the
Archer project.  I haven't been able to determine its original author,
though I did find a commit log from Jan Kratochvil (in the Archer
repository) which suggests that the change had originally been made to
gdb.texinfo, but got inadvertently dropped when the python related
documentation was split out to python.texi.

gdb/doc/ChangeLog:

	* python.texi (python command): Revise example to match
	command behavior.

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index fe3df3d4d1903c72b406cf2c44f1f154aee5fd65..948b2b2c04bce043a61b1f7fe930f819b82602f2 100644 (file)
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2019-07-20  Kevin Buettner  <kevinb@redhat.com>
+
+       * python.texi (python command): Revise example to match
+       command behavior.
+
 2019-07-09  Pedro Alves  <palves@redhat.com>
 
        * gdb.texinfo (C++ Exception GDB/MI Catchpoint Commands): Adjust

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index f769ad03a2b3b4455f457eae21977a8d1479c7c7..034623513b2b92309c3445e8ff2dcebfa8f14768 100644 (file)
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -90,8 +90,6 @@ containing @code{end}.  For example:
 
 @smallexample
 (@value{GDBP}) python
-Type python script
-End with a line saying just "end".
 >print 23
 >end
 23