[PATCH 23/24] Add "usage" text to all TUI command help

Tom Tromey
2020-01-04T18:34:30Z

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-01-04 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
---
gdb/ChangeLog | 7 +++++++
gdb/tui/tui-regs.c | 4 +++-
gdb/tui/tui-stack.c | 3 ++-
gdb/tui/tui-win.c | 3 ++-
gdb/tui/tui.c | 6 ++++--
5 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/gdb/tui/tui-regs.c b/gdb/tui/tui-regs.c
index ad57069968c..520fe5838aa 100644
--- a/gdb/tui/tui-regs.c
+++ b/gdb/tui/tui-regs.c
@@ -643,6 +643,8 @@ _initialize_tui_regs (void)
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 18e91882770..e42c0bda845 100644
--- a/gdb/tui/tui-stack.c
+++ b/gdb/tui/tui-stack.c
@@ -375,5 +375,6 @@ _initialize_tui_stack (void)
{
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 4f9478b62a0..0d022baf25f 100644
--- a/gdb/tui/tui-win.c
+++ b/gdb/tui/tui-win.c
@@ -1034,7 +1034,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 bc8c0159740..399d5916b39 100644
--- a/gdb/tui/tui.c
+++ b/gdb/tui/tui.c
@@ -557,9 +557,11 @@ _initialize_tui (void)
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);
}
--
2.17.2