Document tracing session rotation features

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

diff --git a/doc/man/lttng-regenerate.1.txt b/doc/man/lttng-regenerate.1.txt
index a3af401f758d3fa42c7a8a032ed7646afe89364d..2b19515018133126323ce7cae879e9452a269507 100644 (file)
--- a/doc/man/lttng-regenerate.1.txt
+++ b/doc/man/lttng-regenerate.1.txt
@@ -39,6 +39,10 @@ wall time is NTP-corrected. Regenerating the tracing session's metadata ensures
 that trace viewers can accurately determine the events time relative to Unix
 Epoch.
 
 that trace viewers can accurately determine the events time relative to Unix
 Epoch.
 

+If you use man:lttng-rotate(1) or man:lttng-enable-rotation(1) to make
+tracing session rotations, this action regenerates the current and
+next trace chunks's metadata files.
+

 
 Regenerating a tracing session's state dump
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Regenerating a tracing session's state dump
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


@@ -52,7 +56,7 @@ lost.
 include::common-cmd-options-head.txt[]
 
 
 include::common-cmd-options-head.txt[]
 
 

-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::

     Regenerate the data of the tracing session named 'SESSION'
     instead of the current tracing session.
 
     Regenerate the data of the tracing session named 'SESSION'
     instead of the current tracing session.