Document tracing session rotation features

[lttng-tools.git] / doc / man / lttng-stop.1.txt

diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt
index 6405d7b726a0e55cfb85e5d3326dcdff7c598227..aafde32d88f0663e0a03fa6529523cbe4b7d87b5 100644 (file)
--- a/doc/man/lttng-stop.1.txt
+++ b/doc/man/lttng-stop.1.txt
@@ -18,7 +18,7 @@ DESCRIPTION
 The `lttng stop` command stops the various LTTng tracers for a given
 active tracing session.
 
 The `lttng stop` command stops the various LTTng tracers for a given
 active tracing session.
 

-Stoping the LTTng tracers has the effect that all enabled event rules
+Stopping the LTTng tracers has the effect that all enabled event rules

 within enabled channels cannot make event sources _emit_ trace events
 anymore.
 
 within enabled channels cannot make event sources _emit_ trace events
 anymore.
 


@@ -38,13 +38,22 @@ option:--no-wait option, the 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.
 
 trace might not be valid when the command is done. In this case, there
 is no way to know when the trace becomes valid.
 

+If at least one rotation occurred during the chosen tracing session's
+lifetime (see man:lttng-rotate(1) and man:lttng-enable-rotation(1)), the
+`lttng stop` command renames the current trace chunk subdirectory and
+prints the renamed path. Although it is safe to read the content of this
+renamed subdirectory while the tracing session remains inactive (until
+the next man:lttng-start(1)), it is :not: a trace chunk archive: you
+need to destroy the tracing session with man:lttng-destroy(1) or make
+a rotation with man:lttng-rotate(1) to archive it.
+

 
 include::common-cmd-options-head.txt[]
 
 
 option:-n, option:--no-wait::
 
 include::common-cmd-options-head.txt[]
 
 
 option:-n, option:--no-wait::

-       Do not ensure that the chosen tracing session's trace data is valid
-       before returning to the prompt.
+    Do not ensure that the chosen tracing session's trace data is valid
+    before returning to the prompt.

 
 
 include::common-cmd-help-options.txt[]
 
 
 include::common-cmd-help-options.txt[]