X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-destroy.1.txt;h=5084485fd2a8ce0103929a39e3bdddcb5c059d98;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hp=74921bb25c05889028dac02fed2c1a5e7af6b896;hpb=ce19b9ed9bd9591bd0c4d1998780082a490991fd;p=lttng-tools.git

diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt
index 74921bb25..5084485fd 100644
--- a/doc/man/lttng-destroy.1.txt
+++ b/doc/man/lttng-destroy.1.txt
@@ -1,45 +1,82 @@
 lttng-destroy(1)
-===============
+================
+:revdate: 3 May 2021
 
 
 NAME
 ----
-lttng-destroy - Destroy an LTTng tracing session
+lttng-destroy - Destroy LTTng tracing sessions
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--all | 'SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION']
 
 
 DESCRIPTION
 -----------
-The `lttng destroy` command destroys one or more tracing sessions.
+The `lttng destroy` command destroys:
 
-If no options are specified, the current tracing session is destroyed
-(see linklttng:lttng-create(1) for more information about the current
-tracing session).
+With the 'SESSION' argument::
+    The tracing session named 'SESSION'.
 
-If 'SESSION' is specified, the existing tracing session named 'SESSION'
-is destroyed. `lttng list` outputs all the existing tracing sessions
-(see linklttng:lttng-list(1)).
+With the option:--all option::
+    *All* the tracing sessions of the connected session daemon for your
+    Unix user, or for all users if your Unix user is `root`, as listed
+    in the output of `lttng list` (see man:lttng-list(1)).
++
+See the ``Session daemon connection'' section of man:lttng(1) to learn
+how a user application connects to a session daemon.
 
-If the option:--all option is used, *all* the tracing sessions, as listed
-in the output of `lttng list`, are destroyed.
+Otherwise::
+    The current tracing session (see man:lttng-concepts(7) to learn more
+    about the current tracing session).
++
+In that case, the current tracing session becomes nonexistent.
 
-Destroying a tracing session stops any tracing running within the latter.
+See man:lttng-concepts(7) to learn more about tracing sessions.
 
-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.
+``Destroying'' a tracing session means freeing the resources which the
+LTTng daemons and tracers acquired for it, also making sure to flush all
+the recorded trace data to either the local file system or the connected
+LTTng relay daemon (see man:lttng-relayd(8)), depending on the tracing
+session mode.
+
+The `destroy` command stops any tracing activity within the selected
+tracing session(s). By default, the command runs an implicit
+man:lttng-stop(1) command to ensure that the trace data of the tracing
+session(s) is valid before it exits. Make the command exit immediately
+with the option:--no-wait option. In this case, however, the traces(s)
+might not be valid when the command exits, and there's no way to know
+when it/they become valid.
+
+If, for a tracing session{nbsp}__TS__ to destroy with the `destroy`
+command, the following statements are true:
+
+* You don't specify the option:--no-wait option.
+
+* LTTng archived the current trace chunk (see man:lttng-concepts(7))
+  of{nbsp}__TS__ at least once during its lifetime.
+
+Then all the subdirectories of the output directory of{nbsp}__TS__
+(local or remote) are considered trace chunk archives once the `destroy`
+command exits. In other words, it's safe to read them, modify them, move
+them, or remove then.
 
 
 include::common-cmd-options-head.txt[]
 
 
 option:-a, option:--all::
-    Destroy all tracing sessions.
+    Destroy all the tracing sessions of your Unix user, or of all users
+    if your Unix user is `root`, as listed in the output of
+    man:lttng-list(1), instead of the current tracing session or the
+    tracing session named 'SESSION'.
+
+option:-n, option:--no-wait::
+    Do :not: ensure that the trace data of the tracing session(s) to
+    destroy is valid before exiting.
 
 
 include::common-cmd-help-options.txt[]
@@ -50,6 +87,7 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-create(1),
-linklttng:lttng-set-session(1),
-linklttng:lttng(1)
+man:lttng(1),
+man:lttng-concepts(7),
+man:lttng-create(1),
+man:lttng-list(1)