Document in NEWS and gdb.texinfo the "help", "apropos" and "show style" changes.
authorPhilippe Waroquiers <philippe.waroquiers@skynet.be>
Mon, 3 Jun 2019 19:51:56 +0000 (21:51 +0200)
committerPhilippe Waroquiers <philippe.waroquiers@skynet.be>
Mon, 3 Jun 2019 19:59:35 +0000 (21:59 +0200)
gdb/ChangeLog
gdb/NEWS
gdb/doc/ChangeLog
gdb/doc/gdb.texinfo

index 8619fd86156cee88d353ca62c51e461bbbf6dc6c..c17836ecb1ed2f751ca2f36b362b0ea9f281f3d1 100644 (file)
@@ -1,3 +1,8 @@
+2019-06-03  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
+
+       * NEWS: Mention the new set|show style [title|highlight].
+       Mention changes to "show style", "help" and "apropos".
+
 2019-06-03  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
 
        * cli/cli-decode.h (apropos_cmd): Add verbose argument.
index be1ec4eb411c3f73d71741383c7a39b2f54d9af9..41f4f7a8529057e6a2a8d1eb49dc877c09f8f590 100644 (file)
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -69,6 +69,36 @@ set logging debugredirect [on|off]
   By default, GDB debug output will go to both the terminal and the logfile.
   Set if you want debug output to go only to the log file.
 
+set style title foreground COLOR
+set style title background COLOR
+set style title intensity VALUE
+  Control the styling of titles.
+
+set style highlight foreground COLOR
+set style highlight background COLOR
+set style highlight intensity VALUE
+  Control the styling of highlightings.
+
+* Changed commands
+
+help
+  The "help" command uses the title style to enhance the
+  readibility of its output by styling the classes and
+  command names.
+
+apropos [-v] REGEXP
+  Similarly to "help", the "apropos" command also uses the
+  title style for the command names.  "apropos" accepts now
+  a flag "-v" (verbose) to show the full documentation
+  of matching commands and to use the highlight style to mark
+  the documentation parts matching REGEXP.
+
+show style
+  The "show style" and its subcommands are now styling
+  a style name in their output using its own style, to help
+  the user visualize the different styles.
+
+
 * New MI commands
 
 -complete
index 00388244fda9300190d66018c60b9c89af087ae5..59de4e6945fabb76c00536027ee9758f417ccd0c 100644 (file)
@@ -1,3 +1,9 @@
+2019-06-03  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
+
+       * gdb.texinfo (Help): Document the new -v apropos flag.
+       (Output Styling): Document the style name styling done by "show style".
+       Document the new title and highlight styles.
+
 2019-05-31  Philippe Waroquiers  <philippe.waroquiers@skynet.be>
 
        * gdb.texinfo (Shell Commands): Document pipe command.
index 79c22d0774214ee04b2163b2e8ab6eb470181479..0df345338e5fcb892d42b0908ffc65382b805f4a 100644 (file)
@@ -1895,10 +1895,13 @@ With a command name as @code{help} argument, @value{GDBN} displays a
 short paragraph on how to use that command.
 
 @kindex apropos
-@item apropos @var{args}
+@item apropos [-v] @var{regexp}
 The @code{apropos} command searches through all of the @value{GDBN}
 commands, and their documentation, for the regular expression specified in
-@var{args}.  It prints out all matches found.  For example:
+@var{args}.  It prints out all matches found.  The optional flag  @samp{-v},
+which stands for @samp{verbose}, indicates to output the full documentation
+of the matching commands and highlight the parts of the documentation
+matching @var{regexp}.  For example:
 
 @smallexample
 apropos alias
@@ -1908,13 +1911,38 @@ apropos alias
 results in:
 
 @smallexample
-@c @group
+@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
-@c @end group
+@end group
+@end smallexample
+
+@noindent
+while
+
+@smallexample
+apropos -v cut.*thread apply
+@end smallexample
+
+@noindent
+results in the below output, where @samp{cut for 'thread apply}
+is highlighted if styling is enabled.
+
+@smallexample
+@group
+taas -- Apply a command to all threads (ignoring errors
+and empty output).
+Usage: taas COMMAND
+shortcut for 'thread apply all -s COMMAND'
+
+tfaas -- Apply a command to all frames of all threads
+(ignoring errors and empty output).
+Usage: tfaas COMMAND
+shortcut for 'thread apply all -s frame apply all -s COMMAND'
+@end group
 @end smallexample
 
 @kindex complete
@@ -24784,6 +24812,11 @@ Set the intensity to @var{value}.  Valid intensities are @samp{normal}
 (the default), @samp{bold}, and @samp{dim}.
 @end table
 
+The @code{show style} command and its subcommands are styling
+a style name in their output using its own style.
+So, use @command{show style} to see the complete list of styles,
+their characteristics and the visual aspect of each style.
+
 The style-able objects are:
 @table @code
 @item filename
@@ -24804,6 +24837,23 @@ foreground color is cyan.
 Control the styling of addresses.  These are managed with the
 @code{set style address} family of commands.  By default, this style's
 foreground color is blue.
+
+@item title
+Control the styling of titles.  These are managed with the
+@code{set style title} family of commands.  By default, this style's
+intensity is bold.  Commands are using the title style to improve
+the readibility of large output.  For example, the commands
+@command{apropos} and @command{help} are using the title style
+for the command names.
+
+@item highlight
+Control the styling of highlightings.  These are managed with the
+@code{set style highlight} family of commands.  By default, this style's
+foreground color is red.  Commands are using the highlight style to draw
+the user attention to some specific parts of their output.  For example,
+the command @command{apropos -v REGEXP} uses the highlight style to
+mark the documentation parts matching @var{regexp}.
+
 @end table
 
 @node Numbers