doc: lttng-destroy(1): document --no-wait option
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Tue, 4 Apr 2017 21:27:58 +0000 (17:27 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 5 May 2017 13:32:33 +0000 (09:32 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/lttng-destroy.1.txt

index 49f3f7a043014cf6dd9b0b0d3a8ff11be9404a4d..4b3f4f00e213989aa74d51f4b15f14a1463d575d 100644 (file)
@@ -10,7 +10,7 @@ lttng-destroy - Destroy an LTTng tracing session
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--all | 'SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION']
 
 
 DESCRIPTION
@@ -28,7 +28,13 @@ is destroyed. `lttng list` outputs all the existing tracing sessions
 If the option:--all option is used, *all* the tracing sessions, as listed
 in the output of `lttng list`, are destroyed.
 
-Destroying a tracing session stops any tracing running within the latter.
+Destroying a tracing session stops any tracing running within the
+latter. By default, the implicit man:lttng-stop(1) command invoked by
+the `lttng destroy` command ensures that the tracing session's trace
+data is valid before returning. With the option:--no-wait option, the
+man:lttng-stop(1) command finishes immediately, hence a local trace
+might not be valid when the command is done. In this case, there is no
+way to know when the trace becomes valid.
 
 Destroying a tracing session does not destroy the recorded trace data,
 if any; it frees resources acquired by the session daemon and tracer
@@ -41,6 +47,10 @@ include::common-cmd-options-head.txt[]
 option:-a, option:--all::
     Destroy all tracing sessions.
 
+option:-n, option:--no-wait::
+    Do not ensure that the chosen tracing session's trace data is valid
+    before returning to the prompt.
+
 
 include::common-cmd-help-options.txt[]
 
This page took 0.037291 seconds and 4 git commands to generate.