doc/man: add links between man pages about session rotation

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index 95e62e6f1ec069f0438033725433502ad173d2d9..f3328648af4cbc0859ca3ea92c11b8d357d241cc 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -245,12 +245,12 @@ no space left in the last file, _trace file rotation_ happens: the first
 file is cleared and new sub-buffers containing events are written there.
 
 LTTng does not guarantee that you can view the trace of an active
 file is cleared and new sub-buffers containing events are written there.
 
 LTTng does not guarantee that you can view the trace of an active

-tracing session (before you run the man:lttng-stop(1) command), even
+tracing session before you run the man:lttng-stop(1) command, even

 with multiple trace files, because LTTng could overwrite them at any
 moment, or some of them could be incomplete. You can archive a
 tracing session's current trace chunk while the tracing session is
 active to obtain an unmanaged and self-contained LTTng trace: see
 with multiple trace files, because LTTng could overwrite them at any
 moment, or some of them could be incomplete. You can archive a
 tracing session's current trace chunk while the tracing session is
 active to obtain an unmanaged and self-contained LTTng trace: see

-man:lttng-rotate(1) and man:lttng-enable-rotation(1).
+the man:lttng-rotate(1) and man:lttng-enable-rotation(1) commands.

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

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index ac4bebfd756355b9c9a7f80857de162a42128b45..9d5b313a8e4ac230fea1a8da15437be530eba1ef 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -45,13 +45,19 @@ of a given tracing session. When a snapshot is taken, the memory dump
 is sent to the registered snapshot outputs.
 
 The tracing session should be created in _snapshot mode_ to make sure
 is sent to the registered snapshot outputs.
 
 The tracing session should be created in _snapshot mode_ to make sure

-taking snapshots is allowed. This is done at tracing session creation
-time using the man:lttng-create(1) command.
+that taking snapshots is allowed. This is done at tracing session
+creation time using the man:lttng-create(1) command's
+nloption:--snapshot option.

 
 Note that, when a snapshot is taken, the sub-buffers are not cleared.
 This means that different recorded snapshots may contain the same
 events.
 
 
 Note that, when a snapshot is taken, the sub-buffers are not cleared.
 This means that different recorded snapshots may contain the same
 events.
 

+If you want, instead, to keep all the trace data, but divide it into
+archived chunks which are then free to process (just like snapshots),
+see the lttng-rotate(1) and lttng-enable-rotation(1) commands. Trace
+chunk archives do not overlap like snapshots can.
+

 
 Snapshot outputs
 ~~~~~~~~~~~~~~~~
 
 Snapshot outputs
 ~~~~~~~~~~~~~~~~