From: Andrew Burgess <aburgess@redhat.com>
Date: Tue, 7 Dec 2021 10:43:38 +0000 (+0000)
Subject: gdb/doc: add some index entries relating to mi-async setting
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=042574aa6e57a2a3792dc83e242d197cb3e63067;p=binutils-gdb.git

gdb/doc: add some index entries relating to mi-async setting

I noticed that the mi-async setting was not referenced from the index
in any way, this commit tries to rectify that a bit.

The @cindex lines I think are not controversial, these same index
entries are used elsewhere in the manual for async related topics (see
@node Background Execution).

The only bit that might be controversial is that I've added a @kindex
entry for 'set mi-async' when the command is documented as '-gdb-set
mi-async' (with a similar difference for the show/-gdb-show).

My reasoning here is that nothing else is indexed under -gdb-set or
-gdb-show, and as -gdb-set/-gdb-show are just the MI equivalent for
set/show anything that is documented under set/show can be adjusted
using -gdb-set/-gdbshow, and so, I've tried to keep the index
consistent for mi-async.
---

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 2d3414175c1..7da6805f804 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -29402,8 +29402,12 @@ find if asynchronous execution is enabled using the
 @code{-list-target-features} command.
 
 @table @code
-@item -gdb-set mi-async on
-@item -gdb-set mi-async off
+@cindex foreground execution
+@cindex background execution
+@cindex asynchronous execution
+@cindex execution, foreground, background and asynchronous
+@kindex set mi-async
+@item -gdb-set mi-async @r{[}on@r{|}off@r{]}
 Set whether MI is in asynchronous mode.
 
 When @code{off}, which is the default, MI execution commands (e.g.,
@@ -29415,6 +29419,7 @@ commands (e.g., @code{-exec-continue} becomes the equivalent of the
 @code{c&} CLI command), and so @value{GDBN} is capable of processing
 MI commands even while the target is running.
 
+@kindex show mi-async
 @item -gdb-show mi-async
 Show whether MI asynchronous mode is enabled.
 @end table