aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Tromey <tom@tromey.com>2020-02-22 11:48:26 -0700
committerTom Tromey <tom@tromey.com>2020-02-22 12:57:25 -0700
commit283be8bfa4c19c60f81abbbb43e41b6ccfdff4a9 (patch)
tree4e60faf23177f6a139412620150aee3b6eb6ce24
parentca793b969c39158aa5fb10508a13d2696bf9c6d2 (diff)
downloadfsf-binutils-gdb-283be8bfa4c19c60f81abbbb43e41b6ccfdff4a9.zip
fsf-binutils-gdb-283be8bfa4c19c60f81abbbb43e41b6ccfdff4a9.tar.gz
fsf-binutils-gdb-283be8bfa4c19c60f81abbbb43e41b6ccfdff4a9.tar.bz2
Add "usage" text to all TUI command help
This adds "usage" text to the help for all all the TUI commands. In some cases the usage is borderline, but I tend to think being complete is preferable. 2020-02-22 Tom Tromey <tom@tromey.com> * tui/tui-win.c (_initialize_tui_win): Add usage text. * tui/tui-stack.c (_initialize_tui_stack): Add usage text. * tui/tui-regs.c (_initialize_tui_regs): Add usage text. * tui/tui.c (_initialize_tui): Add usage text. Change-Id: I727f7a7cfc03efa248ef98f30a18be393819e30b
-rw-r--r--gdb/ChangeLog7
-rw-r--r--gdb/tui/tui-regs.c4
-rw-r--r--gdb/tui/tui-stack.c3
-rw-r--r--gdb/tui/tui-win.c3
-rw-r--r--gdb/tui/tui.c6
5 files changed, 18 insertions, 5 deletions
diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 059e9cd..f45b740 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,12 @@
2020-02-22 Tom Tromey <tom@tromey.com>
+ * tui/tui-win.c (_initialize_tui_win): Add usage text.
+ * tui/tui-stack.c (_initialize_tui_stack): Add usage text.
+ * tui/tui-regs.c (_initialize_tui_regs): Add usage text.
+ * tui/tui.c (_initialize_tui): Add usage text.
+
+2020-02-22 Tom Tromey <tom@tromey.com>
+
* tui/tui-win.c (tui_set_focus_command)
(tui_set_win_height_command): Use error_no_arg.
(_initialize_tui_win): Update help text.
diff --git a/gdb/tui/tui-regs.c b/gdb/tui/tui-regs.c
index 7858236..d33f0aa 100644
--- a/gdb/tui/tui-regs.c
+++ b/gdb/tui/tui-regs.c
@@ -654,6 +654,8 @@ _initialize_tui_regs ()
tuicmd = tui_get_cmd_list ();
cmd = add_cmd ("reg", class_tui, tui_reg_command, _("\
-TUI command to control the register window."), tuicmd);
+TUI command to control the register window.\n\
+Usage: tui reg NAME\n\
+NAME is the name of the register group to display"), tuicmd);
set_cmd_completer (cmd, tui_reggroup_completer);
}
diff --git a/gdb/tui/tui-stack.c b/gdb/tui/tui-stack.c
index 7758f2f..f1e075a 100644
--- a/gdb/tui/tui-stack.c
+++ b/gdb/tui/tui-stack.c
@@ -376,5 +376,6 @@ _initialize_tui_stack ()
{
add_com ("update", class_tui, tui_update_command,
_("Update the source window and locator to "
- "display the current execution point."));
+ "display the current execution point.\n\
+Usage: update"));
}
diff --git a/gdb/tui/tui-win.c b/gdb/tui/tui-win.c
index dad3464..b962e02 100644
--- a/gdb/tui/tui-win.c
+++ b/gdb/tui/tui-win.c
@@ -1035,7 +1035,8 @@ Use \"info win\" to see the names of the windows currently being displayed."));
add_com_alias ("wh", "winheight", class_tui, 0);
set_cmd_completer (cmd, winheight_completer);
add_info ("win", tui_all_windows_info,
- _("List of all displayed windows."));
+ _("List of all displayed windows.\n\
+Usage: info win"));
cmd = add_com ("focus", class_tui, tui_set_focus_command, _("\
Set focus to named window or next/prev window.\n\
Usage: focus [WINDOW-NAME | next | prev]\n\
diff --git a/gdb/tui/tui.c b/gdb/tui/tui.c
index 77d7c90..ac435d1 100644
--- a/gdb/tui/tui.c
+++ b/gdb/tui/tui.c
@@ -562,9 +562,11 @@ _initialize_tui ()
tuicmd = tui_get_cmd_list ();
add_cmd ("enable", class_tui, tui_enable_command,
- _("Enable TUI display mode."),
+ _("Enable TUI display mode.\n\
+Usage: tui enable"),
tuicmd);
add_cmd ("disable", class_tui, tui_disable_command,
- _("Disable TUI display mode."),
+ _("Disable TUI display mode.\n\
+Usage: tui disable"),
tuicmd);
}