This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] gdb: Rewrite documentation for layout and focus commands.
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Andrew Burgess <andrew dot burgess at embecosm dot com>
- Cc: gdb-patches at sourceware dot org, andrew dot burgess at embecosm dot com
- Date: Mon, 06 Jul 2015 20:11:09 +0300
- Subject: Re: [PATCH] gdb: Rewrite documentation for layout and focus commands.
- Authentication-results: sourceware.org; auth=none
- References: <e3155235016225f2f9cfeacc97caba93cc137f7c dot 1436188349 dot git dot andrew dot burgess at embecosm dot com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Cc: Andrew Burgess <andrew.burgess@embecosm.com>
> Date: Mon, 6 Jul 2015 14:15:39 +0100
>
> The following patch changes the documentation for the layout and focus
> commands. Though I have extended the documentation for layout
> slightly most of this patch is really about reformatting the layout of
> the documentation.
>
> The change is really just my personal preference, but I think the new
> layout is clearer, do people agree?
This is fine with me, but please be consistent in your style. For
example:
> +@item regs
> +When in @code{src} or @code{asm} layout the register window is
> +displayed in addition to the existing source or assembler window.
> +When in @code{split} layout then the register and assembler windows
> +are displayed. The command window is always displayed.
This uses passive tense "is displayed", whereas all the rest use
"Display", which is shorter and more in line with how we describe
settings.
> +@item focus @var{name}
> @kindex focus
> +Changes which TUI window is currently active for scrolling. The value
> +of @var{name} can be any of the following:
"The value of @var{name}" sounds strange. I suggest The @var{name}
parameter can be any of ...".
OK with those changes.
Thanks.