Document that Frame.block can throw

PR python/16484 points out that Frame.block can throw an exception,
but this is not documented.

This patch fixes the documentation.  Changing Frame.block to return
None would be nice, but I suspect it's too late for that change.

gdb/doc/ChangeLog
2018-09-10  Tom Tromey  <tom@tromey.com>

	PR python/16484:
	* python.texi (Frames In Python): Document that Frame.block can
	throw.

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index f266f75..22987d2 100644 (file)
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,5 +1,11 @@
 2018-09-10  Tom Tromey  <tom@tromey.com>
 
+       PR python/16484:
+       * python.texi (Frames In Python): Document that Frame.block can
+       throw.
+
+2018-09-10  Tom Tromey  <tom@tromey.com>
+
        PR python/23487:
        * gdb.texinfo (Pretty-Printer Commands): Fix typo in example.
 

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 86a9111..e1b79cc 100644 (file)
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4321,7 +4321,10 @@ Returns the frame's resume address.
 @end defun
 
 @defun Frame.block ()
-Return the frame's code block.  @xref{Blocks In Python}.
+Return the frame's code block.  @xref{Blocks In Python}.  If the frame
+does not have a block -- for example, if there is no debugging
+information for the code in question -- then this will throw an
+exception.
 @end defun
 
 @defun Frame.function ()