From: Mathieu Desnoyers Date: Sat, 6 May 2017 02:26:31 +0000 (-0400) Subject: doc: remove duplicate LTTNG_UST_BLOCKING_RETRY_TIMEOUT man page entry X-Git-Tag: v2.10.0-rc2~8 X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=2000efe2de6088c545a8470725bb976fd3b199bf;p=lttng-ust.git doc: remove duplicate LTTNG_UST_BLOCKING_RETRY_TIMEOUT man page entry Signed-off-by: Mathieu Desnoyers --- diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt index 832e79ef..21f60984 100644 --- a/doc/man/lttng-ust.3.txt +++ b/doc/man/lttng-ust.3.txt @@ -1297,7 +1297,7 @@ are located in a specific directory under `$LTTNG_HOME` (or `$HOME` if there's no space left for the event record in the sub-buffer. + -- -`0` (default):: +`0`:: Never block the application. Positive value:: @@ -1309,6 +1309,8 @@ Negative value:: Block the application until there's space left for the event record. -- + +Default: {lttng_ust_blocking_retry_timeout}. ++ This option can be useful in workloads generating very large trace data throughput, where blocking the application is an acceptable trade-off to prevent discarding event records. @@ -1341,24 +1343,6 @@ with time constraints on the process startup time. + Default: {lttng_ust_register_timeout}. -`LTTNG_UST_BLOCKING_RETRY_TIMEOUT`:: - Maximum time during which event tracing retry is attempted on buffer - full condition (millliseconds). Setting this environment to non-zero - value effectively blocks the application on buffer full condition. - Setting this environment variable to non-zero values may - significantly affect application timings. Setting this to a negative - value may block the application indefinitely if there is no consumer - emptying the ring buffer. The delay between retry attempts is the - minimum between the specified timeout value and 100ms. This option - can be useful in workloads generating very large trace data - throughput, where blocking the application is an acceptable - trade-off to not discard events. _Use with caution_. -+ -The value `0` means _do not retry_. The value `-1` means _retry forever_. -Value > `0` means a maximum timeout of the given value. -+ -Default: {lttng_ust_blocking_retry_timeout}. - `LTTNG_UST_WITHOUT_BADDR_STATEDUMP`:: Prevents `liblttng-ust` from performing a base address state dump (see the <> section above) if