From 5b4a1a8dbe6b15414c586d8fc6dbaecdcf4046f3 Mon Sep 17 00:00:00 2001 From: Philippe Waroquiers Date: Sun, 10 May 2020 22:22:01 +0200 Subject: [PATCH] Update NEWS and documentation for help and apropos changes. gdb/ChangeLog 2020-05-15 Philippe Waroquiers * NEWS: Mention changes to help and apropos. gdb/doc/ChangeLog 2020-05-15 Philippe Waroquiers * gdb.texinfo (Help): Document the help and apropos changes. (Aliases): Document new meaning of -a abbreviation flag. --- gdb/ChangeLog | 4 ++++ gdb/NEWS | 8 ++++++++ gdb/doc/ChangeLog | 5 +++++ gdb/doc/gdb.texinfo | 22 ++++++++++++---------- 4 files changed, 29 insertions(+), 10 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 8823d23e803..86499f9982f 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,7 @@ +2020-05-15 Philippe Waroquiers + + * NEWS: Mention changes to help and apropos. + 2020-05-15 Philippe Waroquiers * command.h (enum command_class): Improve comments, document diff --git a/gdb/NEWS b/gdb/NEWS index 5b9eabe746c..a059fc7aa0e 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -3,6 +3,14 @@ *** Changes since GDB 9 +* Help and apropos commands will now show the documentation of a + command only once, even if that command has one or more aliases. + These commands now show the command name, then all of its aliases, + and finally the description of the command. + +* 'help aliases' now shows only the user defined aliases. GDB predefined + aliases are shown together with their aliased command. + * GDB now supports debuginfod, an HTTP server for distributing ELF/DWARF debugging information as well as source code. diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index c09c9dfadf2..0cb4182ef2c 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2020-05-15 Philippe Waroquiers + + * gdb.texinfo (Help): Document the help and apropos changes. + (Aliases): Document new meaning of -a abbreviation flag. + 2020-05-05 Kamil Rytarowski * gdb.texinfo (info proc, info proc cmdline, info proc cwd) diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index d5bf59349e2..8f3301259af 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -2041,8 +2041,10 @@ Command name abbreviations are allowed if unambiguous. @item help @var{class} Using one of the general help classes as an argument, you can get a -list of the individual commands in that class. For example, here is the -help display for the class @code{status}: +list of the individual commands in that class. If a command has +aliases, the aliases are given after the command name, separated by +commas. For example, here is the help display for the class +@code{status}: @smallexample (@value{GDBP}) help status @@ -2052,9 +2054,11 @@ List of commands: @c Line break in "show" line falsifies real output, but needed @c to fit in smallbook page size. -info -- Generic command for showing things +info, inf, i -- Generic command for showing things about the program being debugged -show -- Generic command for showing things +info address -- Describe where symbol SYM is stored. +... +show, info set -- Generic command for showing things about the debugger Type "help" followed by command name for full @@ -2065,7 +2069,9 @@ Command name abbreviations are allowed if unambiguous. @item help @var{command} With a command name as @code{help} argument, @value{GDBN} displays a -short paragraph on how to use that command. +short paragraph on how to use that command. If that command has +one or more aliases, @value{GDBN} will display a first line with +the command name and all its aliases separated by commas. @kindex apropos @item apropos [-v] @var{regexp} @@ -2087,9 +2093,6 @@ results in: @group alias -- Define a new command that is an alias of an existing command aliases -- Aliases of other commands -d -- Delete some breakpoints or auto-display expressions -del -- Delete some breakpoints or auto-display expressions -delete -- Delete some breakpoints or auto-display expressions @end group @end smallexample @@ -27512,8 +27515,7 @@ underscores. that is being aliased. The @samp{-a} option specifies that the new alias is an abbreviation -of the command. Abbreviations are not shown in command -lists displayed by the @samp{help} command. +of the command. Abbreviations are not used in command completion. The @samp{--} option specifies the end of options, and is useful when @var{ALIAS} begins with a dash. -- 2.30.2