[PATCH/DOC] Prec: add doc for record save and record record restore

[PATCH/DOC] Prec: add doc for record save and record record restore

[Hui Zhu]

Hi,

I found that there is not doc for record save and record record
restore.  Add this patch for this 2 commands.

Thanks,
Hui

2010-06-18  Hui Zhu  <teawater@gmail.com>

	* gdb.texinfo: (Process Record and Replay): Add documentation
	for commands "record save" and "record restore".


---
 doc/gdb.texinfo |   10 ++++++++++
 1 file changed, 10 insertions(+)

--- a/doc/gdb.texinfo
+++ b/doc/gdb.texinfo
@@ -5639,6 +5639,16 @@ usual ``live'' debugging of the process
 When the inferior process exits, or @value{GDBN} detaches from it,
 process record and replay target will automatically stop itself.

+@kindex record save
+@item record save @var{filename}
+Save the execution log to a file @file{@var{filename}}.
+Default filename is 'gdb_record.<process_id>'.
+
+@kindex record restore
+@item record restore @var{filename}
+Restore the execution log from a file @file{@var{filename}}.
+File must be created with @code{record save}.
+
 @kindex set record insn-number-max
 @item set record insn-number-max @var{limit}
 Set the limit of instructions to be recorded.  Default value is 200000.

Re: [PATCH/DOC] Prec: add doc for record save and record record restore

[Eli Zaretskii]

> From: Hui Zhu <teawater@gmail.com>
> Date: Fri, 18 Jun 2010 11:21:01 +0800
> 
> I found that there is not doc for record save and record record
> restore.  Add this patch for this 2 commands.

Thanks.

> +Default filename is 'gdb_record.<process_id>'.

This needs the markup fixed and some explanations:

  Default filename is @file{gdb_record.@var{process_id}}, where
  @var{process_id} is the process ID of the @value{GDBN} process.

> +File must be created with @code{record save}.

"File must have been created with @code{record save}."

Okay with these changes.

Re: [PATCH/DOC] Prec: add doc for record save and record record restore

[Hui Zhu]

On Fri, Jun 18, 2010 at 15:31, Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Hui Zhu <teawater@gmail.com>
>> Date: Fri, 18 Jun 2010 11:21:01 +0800
>>
>> I found that there is not doc for record save and record record
>> restore.  Add this patch for this 2 commands.
>
> Thanks.
>
>> +Default filename is 'gdb_record.<process_id>'.
>
> This needs the markup fixed and some explanations:
>
>  Default filename is @file{gdb_record.@var{process_id}}, where
>  @var{process_id} is the process ID of the @value{GDBN} process.

The process_id is the id of inferior.  Do you think I can change it to:
@var{process_id} is the process ID of the inferior.

Thanks,
Hui

>
>> +File must be created with @code{record save}.
>
> "File must have been created with @code{record save}."
>
> Okay with these changes.
>

Re: [PATCH/DOC] Prec: add doc for record save and record record restore

[Eli Zaretskii]

> From: Hui Zhu <teawater@gmail.com>
> Date: Fri, 18 Jun 2010 15:48:54 +0800
> Cc: gdb-patches@sourceware.org
> 
> >  Default filename is @file{gdb_record.@var{process_id}}, where
> >  @var{process_id} is the process ID of the @value{GDBN} process.
> 
> The process_id is the id of inferior.  Do you think I can change it to:
> @var{process_id} is the process ID of the inferior.

Yes.

Re: [PATCH/DOC] Prec: add doc for record save and record record restore

[Hui Zhu]

On Fri, Jun 18, 2010 at 16:04, Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Hui Zhu <teawater@gmail.com>
>> Date: Fri, 18 Jun 2010 15:48:54 +0800
>> Cc: gdb-patches@sourceware.org
>>
>> >  Default filename is @file{gdb_record.@var{process_id}}, where
>> >  @var{process_id} is the process ID of the @value{GDBN} process.
>>
>> The process_id is the id of inferior.  Do you think I can change it to:
>> @var{process_id} is the process ID of the inferior.
>
> Yes.
>

Checked in.

Thanks,
Hui