X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-destroy.1.txt;h=e68ad77ae0d6bd10895eb3da58327b610e169282;hp=49f3f7a043014cf6dd9b0b0d3a8ff11be9404a4d;hb=6a0e3480d14f8691ea30855d1895e073bffc57d0;hpb=7c1a4458be934fec31aa27a0eb52e4d0b8cb3803 diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt index 49f3f7a04..e68ad77ae 100644 --- a/doc/man/lttng-destroy.1.txt +++ b/doc/man/lttng-destroy.1.txt @@ -1,5 +1,6 @@ lttng-destroy(1) -=============== +================ +:revdate: 18 January 2018 NAME @@ -10,7 +11,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,12 +29,25 @@ 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 side, making sure to flush all trace data. +If at least one rotation occurred during the chosen tracing session's +lifetime (see man:lttng-rotate(1) and man:lttng-enable-rotation(1)), and +without the option:--no-wait option, all the tracing session's output +directory's subdirectories are considered trace chunk archives once the +command returns: it is safe to read them, modify them, move them, or +remove them. + include::common-cmd-options-head.txt[] @@ -41,6 +55,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[]