From: Jérémie Galarneau Date: Mon, 1 May 2023 21:34:36 +0000 (-0400) Subject: Docs: test environment: clarify the behavior of a TraceTestApplication X-Git-Url: https://git.liburcu.org/?p=lttng-tools.git;a=commitdiff_plain;h=e88109fc2e2b94e4720fed2beac1ae871d8149c3 Docs: test environment: clarify the behavior of a TraceTestApplication A TraceTestApplication, as opposed to a WaitTraceTestApplication, traces immediately when it is launched. This is useful to test tracing from a constructor, but should most likely not be used for other purposes. Signed-off-by: Jérémie Galarneau Change-Id: I7c25a8a60008d584b9376fce74fb925fc02b846a --- diff --git a/tests/utils/lttngtest/environment.py b/tests/utils/lttngtest/environment.py index 0efb2b5f5..6567467eb 100644 --- a/tests/utils/lttngtest/environment.py +++ b/tests/utils/lttngtest/environment.py @@ -189,7 +189,8 @@ class WaitTraceTestApplication: class TraceTestApplication: """ - Create an application to trace. + Create an application that emits events as soon as it is launched. In most + scenarios, it is preferable to use a WaitTraceTestApplication. """ def __init__(self, binary_path, environment):