From: Philippe Proulx Date: Tue, 4 Apr 2017 21:27:58 +0000 (-0400) Subject: doc: lttng-destroy(1): document --no-wait option X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=commitdiff_plain;h=d0d2c3e407d939b89599f2f3fa470e8f04cb5120 doc: lttng-destroy(1): document --no-wait option Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt index 49f3f7a04..4b3f4f00e 100644 --- a/doc/man/lttng-destroy.1.txt +++ b/doc/man/lttng-destroy.1.txt @@ -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[]