aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorTom Tromey <tromey@adacore.com>2022-06-07 07:05:02 -0600
committerTom Tromey <tromey@adacore.com>2022-07-15 09:26:54 -0600
commit72be9d6be7de305b34ac298f1466167b9aba9bc2 (patch)
tree44543f544c27b7d0006baa6559e72e2d49f4eba0 /gdb/doc
parentc4a3dbaf1132105586586617a59d0e7566eefd41 (diff)
downloadgdb-72be9d6be7de305b34ac298f1466167b9aba9bc2.zip
gdb-72be9d6be7de305b34ac298f1466167b9aba9bc2.tar.gz
gdb-72be9d6be7de305b34ac298f1466167b9aba9bc2.tar.bz2
Add 'summary' mode to Value.format_string
This adds a 'summary' mode to Value.format_string and to gdb.print_options. For the former, it lets Python code format values using this mode. For the latter, it lets a printer potentially detect if it is being called in a backtrace with 'set print frame-arguments' set to 'scalars'. I considered adding a new mode here to let a pretty-printer see whether it was being called in a 'backtrace' context at all, but I'm not sure if this is really desirable.
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/python.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 4573ba67..5dd907f 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -1160,6 +1160,12 @@ Additionally, @value{GDBN} only styles some value contents, so not
every output string will contain escape sequences.
When @code{False}, which is the default, no output styling is applied.
+
+@item summary
+@code{True} when just a summary should be printed. In this mode,
+scalar values are printed in their entirety, but aggregates such as
+structures or unions are omitted. This mode is used by @code{set
+print frame-arguments scalars} (@pxref{Print Settings}).
@end table
@end defun