2.10: --blocking-timeout uses `inf` instead of -1 for infinity

[lttng-docs.git] / 2.10 / lttng-docs-2.10.txt

diff --git a/2.10/lttng-docs-2.10.txt b/2.10/lttng-docs-2.10.txt
index 37117b0b6c07ae8d9262465682a789a248af0440..bda65ce45704ce72c0c838c56f82c8f6a0f4631d 100644 (file)
--- a/2.10/lttng-docs-2.10.txt
+++ b/2.10/lttng-docs-2.10.txt
@@ -138,7 +138,7 @@ instrumented with LTTng-UST which is explicitly allowed to block:
 [role="term"]
 ----
 $ lttng create
-$ lttng enable-channel --userspace --blocking-timeout=-1 blocking-channel
+$ lttng enable-channel --userspace --blocking-timeout=inf blocking-channel
 $ lttng enable-event --userspace --channel=blocking-channel --all
 $ lttng start
 $ LTTNG_UST_ALLOW_BLOCKING=1 my-app
@@ -1308,15 +1308,19 @@ always keep a fixed amount of the latest data.
 Which mechanism you should choose depends on your context: prioritize
 the newest or the oldest event records in the ring buffer?
 
-Beware that, in overwrite mode, the tracer abandons a whole sub-buffer
+Beware that, in overwrite mode, the tracer abandons a _whole sub-buffer_
 as soon as a there's no space left for a new event record, whereas in
 discard mode, the tracer only discards the event record that doesn't
 fit.
 
-In discard mode, LTTng increments a count of lost event records when
-an event record is lost and saves this count to the trace. In
-overwrite mode, LTTng keeps no information when it overwrites a
-sub-buffer before consuming it.
+In discard mode, LTTng increments a count of lost event records when an
+event record is lost and saves this count to the trace. In overwrite
+mode, since LTTng 2.8, LTTng increments a count of lost sub-buffers when
+a sub-buffer is lost and saves this count to the trace. In this mode,
+the exact number of lost event records in those lost sub-buffers is not
+saved to the trace. Trace analyses can use the trace's saved discarded
+event record and sub-buffer counts to decide whether or not to perform
+the analyses even if trace data is known to be missing.
 
 There are a few ways to decrease your probability of losing event
 records.
@@ -5953,7 +5957,7 @@ in blocking mode to +__TIMEOUTUS__+:
 0 (default)::
     Never block (non-blocking mode).
 
--1::
+`inf`::
     Block forever until space is available in a sub-buffer to record
     the event.
 
@@ -6022,7 +6026,7 @@ and <<basic-tracing-session-control,start tracing>>:
 [role="term"]
 ----
 $ lttng create
-$ lttng enable-channel --userspace --blocking-timeout=-1 blocking-channel
+$ lttng enable-channel --userspace --blocking-timeout=inf blocking-channel
 $ lttng enable-event --userspace --channel=blocking-channel --all
 $ lttng start
 ----