[Bug python/23108] New: gdb.GdbError documentation could be improved

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=23108

Bug ID: 23108
Summary: gdb.GdbError documentation could be improved
Product: gdb
Version: HEAD
Status: NEW
Severity: normal
Priority: P2
Component: python
Assignee: unassigned at sourceware dot org
Reporter: tromey at sourceware dot org
Target Milestone: ---

From irc:

https://sourceware.org/gdb/onlinedocs/gdb/Exception-Handling.html
<izabera> this page casually mentions gdb.GdbError [11:51]
<izabera> is that the only place where it's documented?


And indeed, this could be improved by making GdbError appear more
like the other types mentioned in that node.

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=23108

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Assignee|unassigned at sourceware dot org |tromey at sourceware dot org

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=23108

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
CC| |tromey at redhat dot com

--- Comment #1 from Tom Tromey <tromey at sourceware dot org> ---
*** Bug 15613 has been marked as a duplicate of this bug. ***

[cvs-commit at gcc dot gnu.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=23108

--- Comment #2 from cvs-commit at gcc dot gnu.org <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Tom Tromey <***@sourceware.org>:

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=4a5a194ae8a871a781d4cdc73c7ba3ae7deafbaa

commit 4a5a194ae8a871a781d4cdc73c7ba3ae7deafbaa
Author: Tom Tromey <***@tromey.com>
Date: Sat Sep 8 09:39:41 2018 -0600

Reword gdb.GdbError text

PR python/23108 points out that the gdb.GdbError documentation is
somewhat difficult to find. The exception is apparently just
mentioned in passing. This patch introduces a new table and adds a
bit more text to try to make it more obvious.

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

PR python/23108:
* python.texi (Exception Handling): Rearrange gdb.GdbError text
and add a table.

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=23108

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |RESOLVED
Resolution|--- |FIXED
Target Milestone|--- |8.3

--- Comment #3 from Tom Tromey <tromey at sourceware dot org> ---
Fixed.