Minor "catch" documentation improvements
Commit Message
This patch makes a few minor improvements to the catchpoint
documentation:
* "catch exception" and "catch handlers" now mention the argument in
the @item.
* "catch exception unhandled" is moved to be closer to "catch
exception", rather than after "catch handlers".
* "catch load" and "catch unload" now wrap the argument in @var.
gdb/doc/ChangeLog
2019-05-10 Tom Tromey <tromey@adacore.com>
* gdb.texinfo (Set Catchpoints): Add text for parameter to "catch
exception" and "catch handlers". Move "catch exception unhandled"
text. Use @var for "catch load" and "catch unload"
---
gdb/doc/ChangeLog | 6 ++++++
gdb/doc/gdb.texinfo | 16 ++++++++--------
2 files changed, 14 insertions(+), 8 deletions(-)
Comments
> From: Tom Tromey <tromey@adacore.com>
> Cc: Tom Tromey <tromey@adacore.com>
> Date: Fri, 10 May 2019 07:13:27 -0600
>
> This patch makes a few minor improvements to the catchpoint
> documentation:
>
> * "catch exception" and "catch handlers" now mention the argument in
> the @item.
>
> * "catch exception unhandled" is moved to be closer to "catch
> exception", rather than after "catch handlers".
>
> * "catch load" and "catch unload" now wrap the argument in @var.
>
> gdb/doc/ChangeLog
> 2019-05-10 Tom Tromey <tromey@adacore.com>
>
> * gdb.texinfo (Set Catchpoints): Add text for parameter to "catch
> exception" and "catch handlers". Move "catch exception unhandled"
> text. Use @var for "catch load" and "catch unload"
Thanks, this LGTM.
@@ -4509,7 +4509,7 @@ You cannot raise an exception interactively.
You cannot install an exception handler interactively.
@end itemize
-@item exception
+@item exception @r{[}@var{name}@r{]}
@kindex catch exception
@cindex Ada exception catching
@cindex catch Ada exceptions
@@ -4527,7 +4527,11 @@ called @code{Constraint_Error} is defined in package @code{Pck}, then
the command to use to catch such exceptions is @kbd{catch exception
Pck.Constraint_Error}.
-@item handlers
+@item exception unhandled
+@kindex catch exception unhandled
+An exception that was raised but is not handled by the program.
+
+@item handlers @r{[}@var{name}@r{]}
@kindex catch handlers
@cindex Ada exception handlers catching
@cindex catch Ada exceptions when handled
@@ -4547,10 +4551,6 @@ user-defined one. For instance, assuming an exception called
command to use to catch such exceptions handling is
@kbd{catch handlers Pck.Constraint_Error}.
-@item exception unhandled
-@kindex catch exception unhandled
-An exception that was raised but is not handled by the program.
-
@item assert
@kindex catch assert
A failed Ada assertion.
@@ -4727,8 +4727,8 @@ A call to @code{fork}.
@kindex catch vfork
A call to @code{vfork}.
-@item load @r{[}regexp@r{]}
-@itemx unload @r{[}regexp@r{]}
+@item load @r{[}@var{regexp}@r{]}
+@itemx unload @r{[}@var{regexp}@r{]}
@kindex catch load
@kindex catch unload
The loading or unloading of a shared library. If @var{regexp} is