gdb: Rewrite documentation for layout and focus commands.

Changes the documentation for the layout and focus commands.

Instead of documenting each layout (or focus) sub-command as a separate
command, document a single layout (and focus) command which takes a
parameter, then list the possible parameters in a table nested under
each command.

The documentation for the layout command has been extended little to
make it clearer which windows are shown in each layout.

gdb/ChangeLog:

	* doc/gdb.texinfo (TUI): Restructure documentation on TUI layout
	and focus commands.
This commit is contained in:
Andrew Burgess
2015-07-06 11:33:31 +01:00
parent 7c79d316af
commit 6008fc5fcd
2 changed files with 36 additions and 16 deletions

View File

@@ -1,3 +1,8 @@
2015-07-06 Andrew Burgess <andrew.burgess@embecosm.com>
* doc/gdb.texinfo (TUI): Restructure documentation on TUI layout
and focus commands.
2015-07-06 Joel Brobecker <brobecker@adacore.com> 2015-07-06 Joel Brobecker <brobecker@adacore.com>
* NEWS: Create a new section for the next release branch. * NEWS: Create a new section for the next release branch.

View File

@@ -25070,43 +25070,58 @@ Disable TUI mode, returning to the console interpreter.
@kindex info win @kindex info win
List and give the size of all displayed windows. List and give the size of all displayed windows.
@item layout next @item layout @var{name}
@kindex layout @kindex layout
Changes which TUI windows are displayed. In each layout the command
window is always displayed, the @var{name} parameter controls which
additional windows are displayed, and can be any of the following:
@table @code
@item next
Display the next layout. Display the next layout.
@item layout prev @item prev
Display the previous layout. Display the previous layout.
@item layout src @item src
Display the source window only. Display the source and command windows.
@item layout asm @item asm
Display the assembly window only. Display the assembly and command windows.
@item layout split @item split
Display the source and assembly window. Display the source, assembly, and command windows.
@item layout regs @item regs
Display the register window together with the source or assembly window. When in @code{src} layout display the register, source, and command
windows. When in @code{asm} or @code{split} layout display the
register, assembler, and command windows.
@end table
@item focus next @item focus @var{name}
@kindex focus @kindex focus
Changes which TUI window is currently active for scrolling. The
@var{name} parameter can be any of the following:
@table @code
@item next
Make the next window active for scrolling. Make the next window active for scrolling.
@item focus prev @item prev
Make the previous window active for scrolling. Make the previous window active for scrolling.
@item focus src @item src
Make the source window active for scrolling. Make the source window active for scrolling.
@item focus asm @item asm
Make the assembly window active for scrolling. Make the assembly window active for scrolling.
@item focus regs @item regs
Make the register window active for scrolling. Make the register window active for scrolling.
@item focus cmd @item cmd
Make the command window active for scrolling. Make the command window active for scrolling.
@end table
@item refresh @item refresh
@kindex refresh @kindex refresh