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
This commit is contained in:
Tom Tromey 2020-02-22 11:48:26 -07:00
parent ca793b969c
commit 283be8bfa4
5 changed files with 18 additions and 5 deletions

View File

@ -1,3 +1,10 @@
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)

View File

@ -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);
}

View File

@ -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"));
}

View File

@ -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\

View File

@ -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);
}