From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
To: gdb-patches@sourceware.org
Cc: Philippe Waroquiers <philippe.waroquiers@skynet.be>
Subject: [RFA 4/4] Document in NEWS and gdb.texinfo the "help", "apropos" and "show style" changes.
Date: Fri, 31 May 2019 13:19:00 -0000 [thread overview]
Message-ID: <20190531131903.21203-5-philippe.waroquiers@skynet.be> (raw)
In-Reply-To: <20190531131903.21203-1-philippe.waroquiers@skynet.be>
---
gdb/ChangeLog | 5 +++++
gdb/NEWS | 30 ++++++++++++++++++++++++++
gdb/doc/ChangeLog | 6 ++++++
gdb/doc/gdb.texinfo | 52 +++++++++++++++++++++++++++++++++++++++++++--
4 files changed, 91 insertions(+), 2 deletions(-)
diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 7018c3347a..ce226c1808 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -7100,3 +7100,8 @@ End:
(print_help_for_command): Style the command name using title style.
* cli/cli-cmds.c (apropos_command): Parse optional -v flag.
(_initialize_cli_cmds): Describe -v in apropos_command help.
+
+2019-05-31 Philippe Waroquiers <philippe.waroquiers@skynet.be>
+
+ * NEWS: Mention the new set|show style [title|highlight].
+ Mention changes to "show style", "help" and "apropos".
diff --git a/gdb/NEWS b/gdb/NEWS
index ab582c036d..7e03de1b89 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -57,6 +57,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
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index c075d74eec..392569e497 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -12868,3 +12868,9 @@ fill-column: 74
version-control: never
coding: utf-8
End:
+
+2019-05-31 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.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index f2d8710d7d..1a5fbff056 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -1831,10 +1831,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
@@ -1853,6 +1856,29 @@ delete -- Delete some breakpoints or auto-display expressions
@c @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
+@c @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'
+@c @end group
+@end smallexample
+
@kindex complete
@item complete @var{args}
The @code{complete @var{args}} command lists all the possible completions
@@ -24705,6 +24731,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
@@ -24725,6 +24756,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
--
2.20.1
next prev parent reply other threads:[~2019-05-31 13:19 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-31 13:19 [RFA 0/4] Improve "show style", use style in "help" and "apropos" Philippe Waroquiers
2019-05-31 13:19 ` [RFA 2/4] Improve usability and/or readibility of help and apropos output Philippe Waroquiers
2019-05-31 20:22 ` Tom Tromey
2019-05-31 13:19 ` Philippe Waroquiers [this message]
2019-05-31 13:46 ` [RFA 4/4] Document in NEWS and gdb.texinfo the "help", "apropos" and "show style" changes Eli Zaretskii
2019-05-31 13:19 ` [RFA 3/4] Update tests following changes to "help" and "apropos" Philippe Waroquiers
2019-05-31 20:34 ` Tom Tromey
2019-05-31 13:19 ` [RFA 1/4] Add highlight style, title style, fputs_highlighted. Improve 'show style' Philippe Waroquiers
2019-05-31 20:10 ` Tom Tromey
2019-06-01 8:47 ` Philippe Waroquiers
2019-06-03 14:21 ` Tom Tromey
2019-05-31 20:35 ` [RFA 0/4] Improve "show style", use style in "help" and "apropos" Tom Tromey
2019-06-18 13:09 ` Pedro Alves
2019-06-18 16:04 ` Tom Tromey
2019-06-18 20:11 ` Philippe Waroquiers
2019-06-18 20:46 ` Tom Tromey
2019-06-18 20:53 ` Philippe Waroquiers
2019-06-18 20:58 ` Philippe Waroquiers
2019-06-18 22:40 ` Pedro Alves
2019-06-19 0:25 ` Philippe Waroquiers
2019-06-19 19:44 ` Tom Tromey
2019-06-19 19:26 ` Tom Tromey
2019-06-19 22:56 ` Pedro Alves
2019-06-20 14:21 ` Tom Tromey
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190531131903.21203-5-philippe.waroquiers@skynet.be \
--to=philippe.waroquiers@skynet.be \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox