summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Burgess <andrew.burgess@embecosm.com>2015-07-06 11:33:31 +0100
committerAndrew Burgess <andrew.burgess@embecosm.com>2015-07-06 22:39:21 +0100
commit6008fc5fcd34e3f1cde89c86e3b62bcc7ad7ea7c (patch)
tree178d7d5fa23a29b7dbddcaaa9cbfc050496dcbcb
parent7c79d316af486c456f6f092d0841a9e16527bfd6 (diff)
downloadbinutils-gdb-6008fc5fcd34e3f1cde89c86e3b62bcc7ad7ea7c.tar.gz
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.
-rw-r--r--gdb/ChangeLog5
-rw-r--r--gdb/doc/gdb.texinfo47
2 files changed, 36 insertions, 16 deletions
diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 96843e8d54a..d6d45bfba1b 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -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>
* NEWS: Create a new section for the next release branch.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 842711a2816..eec4dce9a9f 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -25070,43 +25070,58 @@ Disable TUI mode, returning to the console interpreter.
@kindex info win
List and give the size of all displayed windows.
-@item layout next
+@item layout @var{name}
@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.
-@item layout prev
+@item prev
Display the previous layout.
-@item layout src
-Display the source window only.
+@item src
+Display the source and command windows.
-@item layout asm
-Display the assembly window only.
+@item asm
+Display the assembly and command windows.
-@item layout split
-Display the source and assembly window.
+@item split
+Display the source, assembly, and command windows.
-@item layout regs
-Display the register window together with the source or assembly window.
+@item regs
+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
+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.
-@item focus prev
+@item prev
Make the previous window active for scrolling.
-@item focus src
+@item src
Make the source window active for scrolling.
-@item focus asm
+@item asm
Make the assembly window active for scrolling.
-@item focus regs
+@item regs
Make the register window active for scrolling.
-@item focus cmd
+@item cmd
Make the command window active for scrolling.
+@end table
@item refresh
@kindex refresh