From: Tom Tromey <tom@tromey.com>
Date: Sat, 8 Sep 2018 15:08:56 +0000 (-0600)
Subject: Document that Frame.block can throw
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=60c0454d3dda99635d331f6002f3f04fe34546a7;p=binutils-gdb.git

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 f266f75b591..22987d2defe 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,9 @@
+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:
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 86a91110e0e..e1b79cc30b2 100644
--- 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 ()