X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-enable-channel.1.txt;h=bec0906428c5bfba6e9f91ab3e8f783cd96b472e;hp=d66d2fb51228064ddfa0105445ad47a5e9e4dcfe;hb=db0f7697361017ef0d00b2faf322b131b138fca5;hpb=360c4f63da21d6d5518a381aa78441d4b72da446 diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt index d66d2fb51..bec090642 100644 --- a/doc/man/lttng-enable-channel.1.txt +++ b/doc/man/lttng-enable-channel.1.txt @@ -361,14 +361,23 @@ Default values: Timeouts ~~~~~~~~ -option:--blocking-timeout: - Set the channel's blocking timeout value to 'TIMEOUTUS' µs. 0 - (default) does not block. -1 blocks forever until room is - available in the buffer to write the event. Positive - values are a timeout bounding the maximum blocking time - when trying to write into the buffer. Note that this option - only affects applications launched with the - LTTNG_UST_ALLOW_BLOCKING environment variable set. +option:--blocking-timeout='TIMEOUTUS':: + Set the channel's blocking timeout value to 'TIMEOUTUS' µs + for applications executed with a set `LTTNG_UST_ALLOW_BLOCKING` + environment variable: ++ +-- +0 (default):: + Do not block. + +-1:: + Block forever until room is available in the sub-buffer to write the + event record. + +__n__, a positive value:: + Wait for at most __n__ µs when trying to write into a sub-buffer. +-- + include::common-cmd-help-options.txt[]