Use @defvar to document gdb.pretty_printers
While referencing the manual, I noticed that gdb.pretty_printers wasn't documented using @defvar. This made it more difficult to find in the info pages. This patch adds the @defvar and also an introductory paragraph in that node. gdb/doc/ChangeLog 2019-03-20 Tom Tromey <tromey@adacore.com> * python.texi (Selecting Pretty-Printers): Use @defvar for gdb.pretty_printers.
This commit is contained in:
parent
595915c1c1
commit
48869a5f9c
|
@ -1,3 +1,8 @@
|
|||
2019-03-20 Tom Tromey <tromey@adacore.com>
|
||||
|
||||
* python.texi (Selecting Pretty-Printers): Use @defvar for
|
||||
gdb.pretty_printers.
|
||||
|
||||
2019-03-14 Simon Marchi <simon.marchi@efficios.com>
|
||||
|
||||
* gdb.texinfo (GDB/MI Development and Front Ends): Fix closing
|
||||
|
|
|
@ -1363,10 +1363,21 @@ printer exists, then this returns @code{None}.
|
|||
@subsubsection Selecting Pretty-Printers
|
||||
@cindex selecting python pretty-printers
|
||||
|
||||
@value{GDBN} provides several ways to register a pretty-printer:
|
||||
globally, per program space, and per objfile. When choosing how to
|
||||
register your pretty-printer, a good rule is to register it with the
|
||||
smallest scope possible: that is prefer a specific objfile first, then
|
||||
a program space, and only register a printer globally as a last
|
||||
resort.
|
||||
|
||||
@findex gdb.pretty_printers
|
||||
@defvar gdb.pretty_printers
|
||||
The Python list @code{gdb.pretty_printers} contains an array of
|
||||
functions or callable objects that have been registered via addition
|
||||
as a pretty-printer. Printers in this list are called @code{global}
|
||||
printers, they're available when debugging all inferiors.
|
||||
@end defvar
|
||||
|
||||
Each @code{gdb.Progspace} contains a @code{pretty_printers} attribute.
|
||||
Each @code{gdb.Objfile} also contains a @code{pretty_printers}
|
||||
attribute.
|
||||
|
|
Loading…
Reference in New Issue