From 1e7e78ba0184d78c90481b0a24ef197659270ba7 Mon Sep 17 00:00:00 2001 From: Brendan Jackman Date: Mon, 30 Jan 2017 15:49:42 +0000 Subject: [PATCH] Workload: fix docstring for `ftrace` param - This parameter should be a Devlib object for collecting traces, not a Trappy object for parsing them. - Add note to say where you can get one of these things from. --- libs/wlgen/wlgen/workload.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/libs/wlgen/wlgen/workload.py b/libs/wlgen/wlgen/workload.py index 66903f71f..6e65ca9cb 100644 --- a/libs/wlgen/wlgen/workload.py +++ b/libs/wlgen/wlgen/workload.py @@ -165,8 +165,9 @@ class Workload(object): This method starts the execution of the workload. If the user provides an ftrace object, the method will also collect a trace. - :param ftrace: FTrace object to collect a trace - :type ftrace: :mod:`trappy.trace.FTrace` + :param ftrace: FTrace object to collect a trace. If using + :class:`TestEnv`, you can use :attr:`TestEnv.ftrace` for this. + :type ftrace: :mod:`devlib.trace.FTraceCollector` :param cgroup: specifies the cgroup name in which the workload has to run -- GitLab