X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-ust.3.txt;h=5c9c9f5de2167addcb4427aaedf5a581c456b754;hb=d742d2aadf357e5256a0d06196dbffcbf80294b2;hp=9f9a1d53a9bd2269088f620c4ec7035cd31deac5;hpb=702d1b7d91bc75f4fc01415fc625af1b834ddec4;p=lttng-ust.git

diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt
index 9f9a1d53..5c9c9f5d 100644
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -1293,11 +1293,15 @@ are located in a specific directory under `$LTTNG_HOME` (or `$HOME` if
 `$LTTNG_HOME` is not set).
 
 `LTTNG_UST_ALLOW_BLOCKING`::
-    If set, allow application to retry event tracing when there's
+    If set, allow the application to retry event tracing when there's
     no space left for the event record in the sub-buffer, therefore
     effectively blocking the application until space is made available
-    or timeout is reached. This only has effect on channels with
-    `blocking-timeout` set.
+    or the configured timeout is reached.
++
+To allow an application to block during tracing, you also need to
+specify a blocking timeout when you create a channel with the
+nloption:--blocking-timeout option of the man:lttng-enable-channel(1)
+command.
 +
 This option can be useful in workloads generating very large trace data
 throughput, where blocking the application is an acceptable trade-off to