Re: [reverse RFC] Add documentation for process record and replay

[Eli Zaretskii <eliz at gnu dot org>]

> Date: Thu, 16 Oct 2008 15:35:01 +0800
> From: teawater <teawater@gmail.com>
> Cc: msnyder@vmware.com, gdb-patches@sourceware.org
> 
> According to the suggestions. I make a new patch.
> 
> 2008-10-16  Hui Zhu  <teawater@gmail.com>
> 
> 	* gdb.texinfo: Add documentation for process record and replay.

OK.  This needs some rewording and rephrasing, but I can do that
later, after the patch is committed.  (However, please fix the few
simple formatting errors I mention below.)

I'm somewhat concerned about the fact that the functionality and
limitations of the ``record and replay'' target are not described at
all.  If I were to debug using such an architecture, I'd like to know
what it can and cannot do.  For example, if I replay, does the I/O
happen like it happened during the recorded session?  What about
signals? crashes? etc.  Are there things that simply cannot be
reproduced exactly, due to fundamental limitations of the replay
target?

Shouldn't we give the reader some idea about these issues?

> +running. Therefore you need to first start the process @code{run},
          ^^
Please make sure you have 2 spaces after each period that ends a
sentence.

> +earlier point), the inferior process will become "live" at that earlier state,
> +and it will then be possible to continue debugging the process "live" from
> +that state.

``live'', not "live".  In Texinfo, please always use ``...'' quoting
rather than "..", because the former produces prettier results in the
printed manual.  ".." should be reserved only for string constants in
code fragments.

> +@kindex set record-insn-number-max @var{limit}

Please don't put arguments in the index entries.  Index entries should
name only the command name.

> +@item set record-stop-at-limit
> +@item set record-stop-at-limit on

Only the first item of several that share the same description can use
@item, the rest should use @itemx.

> +@itemx set record-stop-at-limit off

@itemx cannot be the first item.

> +(see "Set values of variables", above); it means you will abandon the

Is this a reference to another section?  If so, please use @pxref,
which will produce a true hyperlink that can be followed in an Info
reader.