aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrendan Jackman <brendan.jackman@arm.com>2016-10-07 17:50:37 +0100
committerJavi Merino <merino.jav@gmail.com>2016-10-08 15:08:57 +0100
commit5e97a10f18e26d77c131e0454bf807427d02dfe9 (patch)
treeecb56e61bf358ecbd18b4ad07c44e80f2b9bebad
parent7aa844881431305812f4310f77b2ba17f59de97a (diff)
downloadtrappy-5e97a10f18e26d77c131e0454bf807427d02dfe9.tar.gz
ftrace: Note in documentation that `window` is inclusive
-rw-r--r--trappy/ftrace.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/trappy/ftrace.py b/trappy/ftrace.py
index a43a921..55c795e 100644
--- a/trappy/ftrace.py
+++ b/trappy/ftrace.py
@@ -453,12 +453,15 @@ class FTrace(GenericFTrace):
the end timestamp. Timestamps are relative to the first trace
event that's parsed. If you want to trace until the end of
the trace, set the second element to None. If you want to use
- timestamps extracted from the trace file use "abs_window".
+ timestamps extracted from the trace file use "abs_window". The
+ window is inclusive: trace events exactly matching the start
+ or end timestamps will be included.
:param abs_window: a tuple indicating an absolute time window.
This parameter is similar to the "window" one but its values
represent timestamps that are not normalized, (i.e. the ones
- you find in the trace file)
+ you find in the trace file). The window is inclusive.
+
:type path: str
:type name: str