summaryrefslogtreecommitdiff
path: root/python/binaryview.py
diff options
context:
space:
mode:
authorBrian Potchik <brian@vector35.com>2018-11-19 12:26:16 -0500
committerBrian Potchik <brian@vector35.com>2018-11-19 12:26:16 -0500
commit52ff048b94e37ff41faf5be222da6517d912a6ae (patch)
tree3579e22345a720afc6f2d53550dd9ddcb59b4fac /python/binaryview.py
parent4a1d5c29b5baec20e363a976fb9bc1fc7c1b0ca8 (diff)
Update analysis_info documentation.
Diffstat (limited to 'python/binaryview.py')
-rw-r--r--python/binaryview.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 60ccf91f..cf1d6167 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -1121,7 +1121,11 @@ class BinaryView(object):
@property
def analysis_info(self):
- """Relevant analysis information with list of functions under active analysis (read-only)"""
+ """Provides instantaneous analysis state information and a list of current functions under analysis (read-only).
+ All times are given in units of milliseconds (ms). Per function `analysis_time` is the aggregation of time spend
+ performing incremental updates and is reset on a full function update. Per function `update_count` tracks the
+ current number of incremental updates and is reset on a full function update. Per function `submit_count` tracks the
+ current number of full updates that have completed. Note that the `submit_count` is currently not reset across analysis updates."""
info_ref = core.BNGetAnalysisInfo(self.handle)
info = info_ref[0]
active_info_list = []