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 <jeremie.galarneau@efficios.com>
Change-Id: I7c25a8a60008d584b9376fce74fb925fc02b846a

diff --git a/tests/utils/lttngtest/environment.py b/tests/utils/lttngtest/environment.py
index 0efb2b5f526ea5edba9ea5199e87772645d3db4d..6567467ebb19328f8208e32ab7e1d21a1807c1ad 100644 (file)
--- 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):