[RFA] doc for "info record"

[RFA] doc for "info record"

[Michael Snyder]

[-- Attachment #1: Type: text/plain, Size: 34 bytes --]

Look ok to you Eli?  Pedro?  Hui?

[-- Attachment #2: infodoc.txt --]
[-- Type: text/plain, Size: 1325 bytes --]

2009-10-21  Michael Snyder  <msnyder@vmware.com>

	* gdb.texinfo (Process Record and Replay): Document new form of
	info record command.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.634
diff -u -p -r1.634 gdb.texinfo
--- gdb.texinfo	19 Oct 2009 09:51:42 -0000	1.634
+++ gdb.texinfo	21 Oct 2009 15:30:37 -0000
@@ -5516,9 +5516,19 @@ oldest record to make room for each new 
 @item show record stop-at-limit
 Show the current setting of @code{stop-at-limit}.
 
-@kindex info record insn-number
-@item info record insn-number
-Show the current number of recorded instructions.
+@kindex info record
+@item info record
+Show various statistics about the state of process record and its
+in-memory execution log buffer, including:
+
+@table @code
+@item whether in record mode or replay mode.
+@item Lowest recorded instruction number (counting from when the current execution log started recording instructions).
+@item Highest recorded instruction number.
+@item Current instruction about to be replayed (if in replay mode).
+@item Number of instructions contained in the execution log.
+@item Max number of instructions that may be contained in the execution log.
+@end table
 
 @kindex record delete
 @kindex rec del

Re: [RFA] doc for "info record"

[Eli Zaretskii]

> Date: Wed, 21 Oct 2009 08:27:02 -0700
> From: Michael Snyder <msnyder@vmware.com>
> 
> Look ok to you Eli?

Yes, with a few comments:

> +Show various statistics about the state of process record and its
> +in-memory execution log buffer, including:
> +
> +@table @code

@table, and @code on top of that, is inappropriate for what you want
here: a list of p[lain-text items.  Please use @itemize @bullet or
@itemize @minus.  Note that with @itemize, you need to have each @item
alone on its line, and the text should be on the following line, like
this:

  @item
  Whether in record mode or replay mode.

> +@item whether in record mode or replay mode.
> +@item Lowest recorded instruction number (counting from when the current execution log started recording instructions).

Please capitalize the first word of each @item consistently.

> +@item Max number of instructions that may be contained in the execution log.
         ^^^
No need to use abbreviations in a manual.

Okay with these corrections.

Thanks.

Re: [RFA] doc for "info record"

[Pedro Alves]

On Wednesday 21 October 2009 16:27:02, Michael Snyder wrote:
> Look ok to you Eli?  Pedro?  Hui?

FAOD, it looks fine to me too, pending Eli's remarks
being addressed.  Thanks!

-- 
Pedro Alves

Re: [RFA] doc for "info record"

[Michael Snyder]

Eli Zaretskii wrote:
>> Date: Wed, 21 Oct 2009 08:27:02 -0700
>> From: Michael Snyder <msnyder@vmware.com>
>>
>> Look ok to you Eli?
> 
> Yes, with a few comments:
> 
>> +Show various statistics about the state of process record and its
>> +in-memory execution log buffer, including:
>> +
>> +@table @code
> 
> @table, and @code on top of that, is inappropriate for what you want
> here: a list of p[lain-text items.  Please use @itemize @bullet or
> @itemize @minus.  Note that with @itemize, you need to have each @item
> alone on its line, and the text should be on the following line, like
> this:
> 
>   @item
>   Whether in record mode or replay mode.
> 
>> +@item whether in record mode or replay mode.
>> +@item Lowest recorded instruction number (counting from when the current execution log started recording instructions).
> 
> Please capitalize the first word of each @item consistently.
> 
>> +@item Max number of instructions that may be contained in the execution log.
>          ^^^
> No need to use abbreviations in a manual.
> 
> Okay with these corrections.

Done, and committed.

Re: [RFA] doc for "info record"

[Hui Zhu]

Thanks.

Hui

On Fri, Oct 23, 2009 at 03:33, Michael Snyder <msnyder@vmware.com> wrote:
> Eli Zaretskii wrote:
>>>
>>> Date: Wed, 21 Oct 2009 08:27:02 -0700
>>> From: Michael Snyder <msnyder@vmware.com>
>>>
>>> Look ok to you Eli?
>>
>> Yes, with a few comments:
>>
>>> +Show various statistics about the state of process record and its
>>> +in-memory execution log buffer, including:
>>> +
>>> +@table @code
>>
>> @table, and @code on top of that, is inappropriate for what you want
>> here: a list of p[lain-text items.  Please use @itemize @bullet or
>> @itemize @minus.  Note that with @itemize, you need to have each @item
>> alone on its line, and the text should be on the following line, like
>> this:
>>
>>  @item
>>  Whether in record mode or replay mode.
>>
>>> +@item whether in record mode or replay mode.
>>> +@item Lowest recorded instruction number (counting from when the current
>>> execution log started recording instructions).
>>
>> Please capitalize the first word of each @item consistently.
>>
>>> +@item Max number of instructions that may be contained in the execution
>>> log.
>>
>>         ^^^
>> No need to use abbreviations in a manual.
>>
>> Okay with these corrections.
>
> Done, and committed.
>
>
>