Imagelibrary/binutils-gdb
1
0
Fork 1
mirror of https://github.com/bminor/binutils-gdb.git synced 2025-12-28 18:10:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve usability and/or readibility of help and apropos output.

Browse Source 
The "help" command can output long list of command names or classes.
Use the title style to style the command names or classes to make
the output more readable.

Similarly, change "apropos" command to also style the command names.

It is sometimes unclear why "apropos REGEXP" lists some commands,
and then the user has to manually do 'help command' for all commands
listed by "apropos" to see more details about the matching commands.

=> Add an optional flag -v so that "apropos -v REGEXP":
  * outputs the full documentation of matching commands.
  * highlights the documentation parts matching REGEXP.
This commit is contained in:
Philippe Waroquiers
2019-05-31 14:00:47 +02:00
parent 9303eb2fb1
commit 66d8c86285
4 changed files with 69 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
gdb/cli/cli-cmds.c
View File

@@ -1376,16 +1376,21 @@ show_user (const char *args, int from_tty)
/* Search through names of commands and documentations for a certain
regular expression. */
static void
apropos_command (const char *searchstr, int from_tty)
static void
apropos_command (const char *arg, int from_tty)
{
if (searchstr == NULL)
bool verbose = arg && check_for_argument (&arg, "-v", 2);
if (verbose)
arg = skip_spaces (arg);
if (arg == NULL || *arg == '\0')
error (_("REGEXP string is empty"));
compiled_regex pattern (searchstr, REG_ICASE,
compiled_regex pattern (arg, REG_ICASE,
_("Error in regular expression"));
apropos_cmd (gdb_stdout, cmdlist, pattern, "");
apropos_cmd (gdb_stdout, cmdlist, verbose, pattern, "");
}
/* Subroutine of alias_command to simplify it.
@@ -1981,8 +1986,11 @@ Run the ``make'' program using the rest of the line as arguments."));
Show definitions of non-python/scheme user defined commands.\n\
Argument is the name of the user defined command.\n\
With no argument, show definitions of all user defined commands."), &showlist);
add_com ("apropos", class_support, apropos_command,
_("Search for commands matching a REGEXP"));
add_com ("apropos", class_support, apropos_command, _("\
Search for commands matching a REGEXP\n\
Usage: apropos [-v] REGEXP\n\
Flag -v indicates to produce a verbose output, showing full documentation\n\
of the matching commands."));
add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
&max_user_call_depth, _("\