Docs: clarify lttng.1 shm-path section

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index b2505d0ff7d2c3802ad6cc3924b153b1b71b0add..f2b08bbfa9f6d665d499c0b364adde8b261e8c2f 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -302,6 +302,13 @@ $ lttng start
 After the start, you'll be able to read the events while they are being
 recorded in /tmp/lttng.
 
+.TP
+.BR "\-\-shm-path PATH"
+
+Path where shared memory holding buffers should be created. Useful
+when used with PRAMFS or other persistent memory filesystems to extract
+trace data in the event of a crash requiring a reboot.
+
 .TP
 .BR "\-U, \-\-set-url=URL"
 Set URL for the consumer output destination. It is persistent for the
@@ -935,10 +942,6 @@ Name of the snapshot's output.
 Maximum size in bytes of the snapshot. The maximum size does not include the
 metadata file. Human readable format is accepted: {+k,+M,+G}. For instance,
 \-\-max-size 5M
-
-The minimum size of a snapshot is computed by multiplying the total amount of
-streams in the session by the largest subbuffer size. This is to ensure
-fairness between channels when extracting data.
 .TP
 .BR "\-C, \-\-ctrl-url URL"
 Set control path URL. (Must use -D also)