lttng-add-trigger(1): clarify the `--rate-policy` documentation

[lttng-tools.git] / doc / man / lttng-add-trigger.1.txt

diff --git a/doc/man/lttng-add-trigger.1.txt b/doc/man/lttng-add-trigger.1.txt
index e183b8c3bf3d9cb4ff11548f9c11b0b5c74aed40..e29ddf7c395aeabc55135c2690d2e2ad62893d3a 100644 (file)
--- a/doc/man/lttng-add-trigger.1.txt
+++ b/doc/man/lttng-add-trigger.1.txt
@@ -248,7 +248,8 @@ See below for the nloption:--rate-policy option.
 Common action options (as of LTTng{nbsp}{lttng_version}):
 
 nloption:--rate-policy='POLICY'::
-    Set the rate policy of the action to 'POLICY'.
+    Set the rate policy of the action to 'POLICY' instead of
+    `every:1` (always execute).
 +
 A trigger which ``fires'' (its condition is satisfied) leads to an
 execution request for each of its actions, in order. An execution
@@ -257,9 +258,6 @@ request count{nbsp}__C__ of{nbsp}__A__. An execution request can then
 become an actual execution when{nbsp}__C__ satisfies the rate policy
 of{nbsp}__A__.
 +
-The default action rate policy is `every:1` (always execute{nbsp}__A__).
-Use this option to specify another rate policy.
-+
 'POLICY' is one of:
 +
 --
@@ -275,6 +273,8 @@ requests.
 In other words, execute{nbsp}__A__ every 'COUNT' execution requests.
 --
 +
+'COUNT' must be an integer greater than{nbsp}0.
++
 As of LTTng{nbsp}{lttng_version}, you can use this option with any
 action type, but new action types in the future may not support it.