This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] edit documentation for TUI mode
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Bob Wilson <bwilson at tensilica dot com>
- Cc: gdb-patches at sources dot redhat dot com
- Date: Fri, 11 May 2007 20:58:14 +0300
- Subject: Re: [PATCH] edit documentation for TUI mode
- References: <46423A94.2090607@tensilica.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Wed, 09 May 2007 14:18:12 -0700
> From: Bob Wilson <bwilson@tensilica.com>
>
> I noticed that the TUI-related sections of the GDB docs are a little rough. I'm
> no expert on this feature, but I thought I'd have a go at cleaning up the docs
> anyway. I discovered a few minor discrepancies between the current behavior and
> the document, along with numerous issues of style, formatting and grammar.
> Here's what I came up with. Is it OK?
Thanks! This is approved, provided that you take care of a couple
minor comments below:
> +@pindex @value{GDBTUI}
> +The TUI mode is enabled by default when you invoke @value{GDBN} as
> +either @samp{@value{GDBTUI}} or @samp{@value{GDBP} -tui}.
> +You can also switch in and out of TUI mode while @value{GDBN} runs.
The last sentence begs a question: ``how''? We should either answer
that right there, or have an xref to where the appropriate command is
described.
> -@table @key
> +@table @asis
> @kindex PgUp
> -@item PgUp
> +@item @key{PgUp}
> Scroll the active window one page up.
Why did you switch to `@table @asis' and an explicit @key in each
item? What was wrong with the previous method?