lttng-create(1): specify that `--shm-path` only applies to UST channels

This is a current limitation, but could change in the future.

Fixes: https://bugs.lttng.org/issues/1158
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: Ie2b8114f35d7fd095790aae6add4653c5da169bf

diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
index ea19a159d822da75486637fd0994a956cc01a936..42fdf651e4f807deb0b685de8389f60dd0236094 100644 (file)
--- a/doc/man/lttng-create.1.txt
+++ b/doc/man/lttng-create.1.txt
@@ -1,6 +1,6 @@
 lttng-create(1)
 ===============
-:revdate: 14 June 2021
+:revdate: 7 December 2021
 
 
 NAME
@@ -53,7 +53,9 @@ Specify the path of the directory containing the shared memory files
 holding the channel ring buffers with the option:--shm-path option.
 Specifying a location on an NVRAM file system makes it possible to
 recover the latest recorded trace data when the system reboots after a
-crash with the man:lttng-crash(1) utility.
+crash with the man:lttng-crash(1) utility. Note that, as of
+LTTng{nbsp}{lttng_version}, this feature is only available for user
+space channels.
 
 By default, the `create` command automatically spawns:
 
@@ -335,6 +337,10 @@ option:-o 'DIR', option:--output='DIR'::
 option:--shm-path='DIR'::
     Set the path of the directory containing the shared memory files
     holding the channel ring buffers to 'DIR' on the local file sytem.
++
+NOTE: As of LTTng{nbsp}{lttng_version}, LTTng only considers this option
+for user space (including Java and Python) channels, but this may change
+in the future.
 
 
 URL