[v5,4/4] Linux checkpoints: Update NEWS and gdb.texinfo regarding multiple inferiors

Message ID 20241210020313.584564-5-kevinb@redhat.com
State New
Headers
Series Make linux checkpoints work with multiple inferiors |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Build passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Build passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Test passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Test passed

Commit Message

Kevin Buettner Dec. 10, 2024, 1:54 a.m. UTC
  ---
 gdb/NEWS            |  2 ++
 gdb/doc/gdb.texinfo | 20 +++++++++++++++++++-
 2 files changed, 21 insertions(+), 1 deletion(-)
  

Comments

Eli Zaretskii Dec. 10, 2024, 1:04 p.m. UTC | #1
> From: Kevin Buettner <kevinb@redhat.com>
> Cc: pedro@palves.net,
> 	Kevin Buettner <kevinb@redhat.com>
> Date: Mon,  9 Dec 2024 18:54:07 -0700
> 
> ---
>  gdb/NEWS            |  2 ++
>  gdb/doc/gdb.texinfo | 20 +++++++++++++++++++-
>  2 files changed, 21 insertions(+), 1 deletion(-)

Thanks.

> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -174,6 +174,8 @@ vFile:stat
>    vFile:fstat but takes a filename rather than an open file
>    descriptor.
>  
> +* Linux checkpoint code has been updated to work with multiple inferiors.
> +

This part is okay.

> +Checkpoint IDs will be displayed as either a non-negative integer or
> +in the form @var{I}.@var{N}, where @var{I} is the inferior number, a
> +positive integer, as shown by the command @code{info inferiors}, and
> +@var{N}, a non-negative integer, is the checkpoint number for that
> +inferior.  The single non-negative integer form is used when
> +there is only one inferior.  The @var{I}.@var{N} form is used when
> +there are multiple inferiors.

Please always use lower-case letters inside @var.  In Info format,
they are capitalized by makeinfo, but in other formats we get slanted
typeface which is much more pretty than upper-case.

> +The active state indicator is a single letter, either @code{y} or
> +@code{n}, indicating yes or no.  Only one checkpoint per inferior may
> +be active at once.  The active checkpoint in the current inferior is
> +also shown by a @code{*} at the start of the line.  Checkpoints whose
> +active state is @code{n} can be switched to

Please use @samp for the indicators, not @code.  These are not words,
so they will look strange without quotes in formats other than Info
(where makeinfo quotes them).

The gdb.texinfo part is okay with these nits fixed.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>
  

Patch

diff --git a/gdb/NEWS b/gdb/NEWS
index 361d7726ba0..0c2d3637ce7 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -174,6 +174,8 @@  vFile:stat
   vFile:fstat but takes a filename rather than an open file
   descriptor.
 
+* Linux checkpoint code has been updated to work with multiple inferiors.
+
 *** Changes in GDB 15
 
 * The MPX commands "show/set mpx bound" have been deprecated, as Intel
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 85ac3d9aab6..05a6acd95b2 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -4322,18 +4322,36 @@  listed:
 
 @table @code
 @item Checkpoint ID
+@item Active state indicator
 @item Process ID
 @item Code Address
 @item Source line, or label
 @end table
 
+Checkpoint IDs will be displayed as either a non-negative integer or
+in the form @var{I}.@var{N}, where @var{I} is the inferior number, a
+positive integer, as shown by the command @code{info inferiors}, and
+@var{N}, a non-negative integer, is the checkpoint number for that
+inferior.  The single non-negative integer form is used when
+there is only one inferior.  The @var{I}.@var{N} form is used when
+there are multiple inferiors.
+
+The active state indicator is a single letter, either @code{y} or
+@code{n}, indicating yes or no.  Only one checkpoint per inferior may
+be active at once.  The active checkpoint in the current inferior is
+also shown by a @code{*} at the start of the line.  Checkpoints whose
+active state is @code{n} can be switched to using the @code{restart}
+command or deleted using the @code{delete checkpoint} command.
+
 @kindex restart @var{checkpoint-id}
 @item restart @var{checkpoint-id}
 Restore the program state that was saved as checkpoint number
 @var{checkpoint-id}.  All program variables, registers, stack frames
 etc.@:  will be returned to the values that they had when the checkpoint
 was saved.  In essence, gdb will ``wind back the clock'' to the point
-in time when the checkpoint was saved.
+in time when the checkpoint was saved.  The checkpoint number
+@var{checkpoint-id} is specified in the same form as that output by the
+@code{info checkpoints} command.
 
 Note that breakpoints, @value{GDBN} variables, command history etc.
 are not affected by restoring a checkpoint.  In general, a checkpoint