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

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

[Andrew Burgess]

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.
---
 gdb/doc/gdb.texinfo | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index d0c5bcf18e1..7251515923e 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -29392,8 +29392,12 @@
 @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.,
@@ -29405,6 +29409,7 @@
 @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
-- 
2.25.4

Re: [PATCH] gdb/doc: add some index entries relating to mi-async setting

[Andrew Burgess]

I have now pushed this patch.

Thanks,
Andrew


* Andrew Burgess <aburgess@redhat.com> [2021-12-07 10:49:47 +0000]:

> 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.
> ---
>  gdb/doc/gdb.texinfo | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index d0c5bcf18e1..7251515923e 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -29392,8 +29392,12 @@
>  @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.,
> @@ -29405,6 +29409,7 @@
>  @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
> -- 
> 2.25.4
>