mirror/binutils-gdb
2
0
Fork 0
mirror of https://sourceware.org/git/binutils-gdb.git synced 2024-11-27 03:51:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improvements to gdb.LazyString documentation

Browse Source 
I noticed the gdb.LazyString documentation did not mention how to
create one.  Then, while adding this, I found a couple other ways that
this documentation could be clarified.

Approved-By: Eli Zaretskii <eliz@gnu.org>
This commit is contained in:
Tom Tromey 2024-11-15 08:02:25 -07:00
parent 82eff6743b
commit a7d1f26ec3
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
gdb/doc/python.texi
View File

@ -1279,9 +1279,10 @@ fetched and converted to the given length.
@end defun @end defun
@defun Value.lazy_string (@r{[}encoding @r{[}, length@r{]]}) @defun Value.lazy_string (@r{[}encoding @r{[}, length@r{]]})
If this @code{gdb.Value} represents a string, then this method This method attempts to convert this @code{gdb.Value} to a
converts the contents to a @code{gdb.LazyString} (@pxref{Lazy Strings @code{gdb.LazyString} (@pxref{Lazy Strings In Python}). Values of
In Python}). Otherwise, this method will throw an exception. array or pointer type can be converted; for other types, this method
will throw an exception.
If the optional @var{encoding} argument is given, it must be a string If the optional @var{encoding} argument is given, it must be a string
naming the encoding of the @code{gdb.LazyString}. Some examples are: naming the encoding of the @code{gdb.LazyString}. Some examples are:
@ -6971,11 +6972,13 @@ A @code{gdb.LazyString} is represented in @value{GDBN} as an
that will be used to encode that region of memory, and a @code{length} that will be used to encode that region of memory, and a @code{length}
to delimit the region of memory that represents the string. The to delimit the region of memory that represents the string. The
difference between a @code{gdb.LazyString} and a string wrapped within difference between a @code{gdb.LazyString} and a string wrapped within
a @code{gdb.Value} is that a @code{gdb.LazyString} will be treated a @code{gdb.Value} is that a @code{gdb.LazyString} will only be
differently by @value{GDBN} when printing. A @code{gdb.LazyString} is
retrieved and encoded during printing, while a @code{gdb.Value} retrieved and encoded during printing, while a @code{gdb.Value}
wrapping a string is immediately retrieved and encoded on creation. wrapping a string is immediately retrieved and encoded on creation.
A @code{gdb.LazyString} can be created using the
@code{gdb.Value.lazy_string} method (@pxref{Values From Inferior}).
A @code{gdb.LazyString} object has the following functions: A @code{gdb.LazyString} object has the following functions:
@defun LazyString.value () @defun LazyString.value ()