Added notes about locks being cleared after 4 weeks

cfengine · Nov 14, 2023 · 5a5789b · 5a5789b
1 parent ec78597
commit 5a5789b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 23 deletions.
diff --git a/reference/components/cf-agent.markdown b/reference/components/cf-agent.markdown
@@ -860,7 +860,7 @@ hostnamekeys => "true";
 **Description:** The value of `ifelapsed` is a global default representing
 the time that must elapse before a promise will be rechecked.
 
-This overrides the global settings. Promises which take a long time
+This configures the default setting for `cf-agent`. Promises which take a long time
 to verify should usually be protected with a long value for this
 parameter. This serves as a resource 'spam' protection. A CFEngine
 check could easily run every 5 minutes provided resource intensive
@@ -877,22 +877,17 @@ another which is not tied to a specific time.
 **Example:**
 
 ```cf3
-#local
-
-body action example
-{
-ifelapsed   => "120";   # 2 hours
-expireafter => "240";   # 4 hours
-}
-
-# global
-
 body agent control
 {
-ifelapsed   => "180";   # 3 hours
+  ifelapsed   => "180";   # 3 hours
 }
 ```
 
+**Notes:**
+* This is not a reliable way to control frequency over a long period of time.
+* Locks provide simple but weak frequency control.
+* Locks older than 4 weeks are automatically purged.
+
 **See also:** [Promise locking][Promises#Promise locking], [ifelapsed action body attribute][Promise types#ifelapsed]
 
 ### inform

diff --git a/reference/promise-types.markdown b/reference/promise-types.markdown
@@ -94,24 +94,19 @@ for the specific promise it's attached to.
 **Example:**
 
 ```cf3
-#local
-
 body action example
 {
   ifelapsed   => "120";  # 2 hours
   expireafter => "240";  # 4 hours
 }
-
-# global
-
-body agent control
-{
-  ifelapsed   => "180";  # 3 hours
-}
 ```
 
-**See also:** [promise locking][Promises#Promise locking], [ifelapsed in body agent control][cf-agent#ifelapsed],
-[`ifelapsed` and function caching][Functions#function caching]
+**Notes:**
+* This is not a reliable way to control frequency over a long period of time.
+* Locks provide simple but weak frequency control.
+* Locks older than 4 weeks are automatically purged.
+
+**See also:** [promise locking][Promises#Promise Locking], [ifelapsed in body agent control][cf-agent#ifelapsed], [`ifelapsed` and function caching][Functions#function caching]
 
 **History:**