[PATCH 1/2] gdb/tui: Update help text for scroll commands

Andrew Burgess
2020-01-24T21:22:32Z

GDB has some commands ('+', '-', '<', and '>') for scrolling the SRC
and ASM TUI windows from the CMD window, however the help text for
these commands lists the arguments in the wrong order.

This commit updates the help text to match how GDB actually works, and
also extends the text to describe what the arguments mean, and what
the defaults are.

There should be no change in GDBs functionality after this commit.

gdb/ChangeLog:

* tui/tui-win.c (_initialize_tui_win): Update help text for '+',
'-', '<', and '>' commands.

Change-Id: Ib2624891de1f4ba983838822206304e4c3ed982e
---
gdb/ChangeLog | 5 +++++
gdb/tui/tui-win.c | 16 ++++++++++++----
2 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/gdb/tui/tui-win.c b/gdb/tui/tui-win.c
index 8b7c39916a3..185ae26f698 100644
--- a/gdb/tui/tui-win.c
+++ b/gdb/tui/tui-win.c
@@ -1063,16 +1063,24 @@ FOCUS_USAGE
set_cmd_completer (cmd, focus_completer);
add_com ("+", class_tui, tui_scroll_forward_command, _("\
Scroll window forward.\n\
-Usage: + [WIN] [N]"));
+Usage: + [N] [WIN]\n\
+Scroll window WIN N lines forwards. Both WIN and N are optional, N\n\
+defaults to 1, and WIN defaults to the currently focused window."));
add_com ("-", class_tui, tui_scroll_backward_command, _("\
Scroll window backward.\n\
-Usage: - [WIN] [N]"));
+Usage: - [N] [WIN]\n\
+Scroll window WIN N lines backwards. Both WIN and N are optional, N\n\
+defaults to 1, and WIN defaults to the currently focused window."));
add_com ("<", class_tui, tui_scroll_left_command, _("\
Scroll window text to the left.\n\
-Usage: < [WIN] [N]"));
+Usage: < [N] [WIN]\n\
+Scroll window WIN N characters left. Both WIN and N are optional, N\n\
+defaults to 1, and WIN defaults to the currently focused window."));
add_com (">", class_tui, tui_scroll_right_command, _("\
Scroll window text to the right.\n\
-Usage: > [WIN] [N]"));
+Usage: > [N] [WIN]\n\
+Scroll window WIN N characters right. Both WIN and N are optional, N\n\
+defaults to 1, and WIN defaults to the currently focused window."));

/* Define the tui control variables. */
add_setshow_enum_cmd ("border-kind", no_class, tui_border_kind_enums,
--
2.14.5