This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: Ping: [RFA] [Doc] Non-stop mode user documentation
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Sandra Loosemore <sandra at codesourcery dot com>
- Cc: gdb-patches at sourceware dot org, pedro at codesourcery dot com
- Date: Mon, 11 Aug 2008 22:37:49 +0300
- Subject: Re: Ping: [RFA] [Doc] Non-stop mode user documentation
- References: <489F781C.7040106@codesourcery.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Sun, 10 Aug 2008 19:22:04 -0400
> From: Sandra Loosemore <sandra@codesourcery.com>
> CC: Pedro Alves <pedro@codesourcery.com>
>
> Ping?
>
> http://sourceware.org/ml/gdb-patches/2008-07/msg00520.html
Did I miss that? sorry if so.
> I've attached a new version of the patch with a fix for a typo I spotted after
> submitting the original version.
Thanks.
> + Whenever @value{GDBN} stops your program, due to a breakpoint or a
> + signal, it automatically selects the thread where that breakpoint or
> + signal happened. @value{GDBN} alerts you to the context switch with a
> + message of the form @samp{[Switching to @var{systag}]} to identify the
> + thread.
That @var{systag} is rather mysterious, and it's not explained
anywhere. Isn't that simply "thread N"?
> + mode optimizes for single-stepping. It stops other threads from
> + ``seizing the prompt'' ^^^^^^^^^^^^^^^^^^^
"prevents other threads" is better, I think.
Also, I'm not sure ``seizing the prompt'' (and "steal the prompt"
later) will be understood by all readers.
> + @cindex foreground execution
> + @cindex execution, foreground
> + @cindex background execution
> + @cindex execution, background
> + @cindex asynchronous execution
> + @cindex execution, asynchronous
It is generally not useful to have several index entries beginning
with the same word and pointing to the same page. In this case, I'd
replace the 3 entries that begin with "execution" with just one, like
this:
@cindex execution, foreground, background and asynchronous
> + @item step
> + @kindex step&
> + @xref{Continuing and Stepping}.
> +
> + @item stepi
> + @kindex stepi&
> + @xref{Continuing and Stepping}.
If you want each one of several @xref's to the same node to place the
reader at the right spot for each command, include the keyword in the
@xref, like this:
@xref{Continuing and Stepping, step}
@xref{Continuing and Stepping, stepi}
Without this, both @xref's might just place you at the beginning of
the same node (this depends on the Info reader, as a matter of fact).
> + Background execution is especially useful in conjunction with non-stop
> + mode for debugging programs with multiple threads; @pxref{Non-Stop Mode}.
@pxref should only be used inside parens, because it produces an extra
period. Here, you want "see @ref" instead.
Otherwise, okay.
Thanks!