Python summary strings:
- you can use a Python script to write a summary string for data-types, in one of
three ways:
-P option and typing the script a line at a time
-s option and passing a one-line Python script
-F option and passing the name of a Python function
these options all work for the "type summary add" command
your Python code (if provided through -P or -s) is wrapped in a function
that accepts two parameters: valobj (a ValueObject) and dict (an LLDB
internal dictionary object). if you use -F and give a function name,
you're expected to define the function on your own and with the right
prototype. your function, however defined, must return a Python string
- test case for the Python summary feature
- a few quirks:
Python summaries cannot have names, and cannot use regex as type names
both issues will be fixed ASAP
major redesign of type summary code:
- type summary working with strings and type summary working with Python code
are two classes, with a common base class SummaryFormat
- SummaryFormat classes now are able to actively format objects rather than
just aggregating data
- cleaner code to print descriptions for summaries
the public API now exports a method to easily navigate a ValueObject hierarchy
New InputReaderEZ and PriorityPointerPair classes
Several minor fixes and improvements
git-svn-id: https://llvm.org/svn/llvm-project/llvdb/trunk@135238 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/www/varformats.html b/www/varformats.html
index b0a1af1..3fd647d 100755
--- a/www/varformats.html
+++ b/www/varformats.html
@@ -784,6 +784,17 @@
(i_am_cool) one = x=3<br>
</code> </p>
+ <p>When defining a named summmary, binding it to one or more types becomes optional.
+ Even if you bind the named summary to a type, and later change the summary string
+ for that type, the named summary will not be changed by that. You can delete
+ named summaries by using the <code>type summary delete</code> command, as if the
+ summary name was the datatype that the summary is applied to</p>
+
+ <p>A summary attached to a variable using the </code>--summary</code> option,
+ has the same semantics that a custom format attached using the <code>-f</code>
+ option has: it stays attached till you attach a new one, or till you let
+ your program run again.</p>
+
</div>
</div>