Skip to content

Commit 8963543

Browse files
authored
Merge pull request #3346 from nickanderson/rename-normal-order-policy-eval/master
Renamed Normal ordering to Policy evaluation
2 parents be6f33a + 7314a97 commit 8963543

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

examples/tutorials/writing-and-serving-policy/policy-style.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ guide.
2828
## Promise ordering
2929

3030
There are two common styles that are used when writing policy. The
31-
[Normal Order][Normal ordering] style dictates that promises should be
32-
written in in the Normal Order that the agent evaluates promises
33-
in. The other is reader optimized where promises are written in the
31+
[Normal Order][Policy evaluation] style dictates that promises should be
32+
written in the order that the agent evaluates promises.
33+
The other is reader optimized where promises are written in the
3434
order they make sense to the reader. Both styles have their merits,
3535
but there seems to be a trend toward the reader optimized style.
3636

reference/functions.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ When enabled
111111
[cached functions](https://docs.cfengine.com/docs/{{site.cfengine.branch}}/search.html?q=The+return+value+is+cached)
112112
are **not executed on every pass of convergence**. Instead, the function will
113113
only be executed once during the
114-
[agent evaluation step][Normal ordering#Agent evaluation step]
114+
[agent evaluation step][Policy evaluation#Agent evaluation step]
115115
and its result will be cached until the end of that agent execution.
116116

117117
**Note:** Cached functions are executed multiple times during
118-
[policy validation and pre-evaluation][Normal ordering#cf-promises policy validation step].
118+
[policy validation and pre-evaluation][Policy evaluation#cf-promises policy validation step].
119119
Function caching is *per-process*, so results will not be cached between
120120
separate components e.g. `cf-agent`, `cf-serverd` and `cf-promises`.
121121
Additionally functions are cached by hashing the function arguments. If you have

reference/language-concepts.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,11 @@ CFEngine's boolean classifiers that describe context.
6363
An association of the form "LVALUE *represents* RVALUE", where RVALUE may be a
6464
scalar value or a list of scalar values: a string, integer or real number.
6565

66-
This documentation about the language concepts introduces in addition
66+
This documentation about the language concepts introduces:
6767

68-
* [**normal ordering**][Normal ordering],
69-
* [**loops**][Loops],
70-
* [**pattern matching and referencing**][Pattern matching and referencing],
71-
and
68+
* Policy evaluation (also known as [**Normal order**][Policy evaluation])
69+
* [**loops**][Loops] and implicit iteration
70+
* [**pattern matching and referencing**][Pattern matching and referencing]
7271
* [**namespaces**][namespaces]
7372

7473
## Syntax, identifiers and names

reference/language-concepts/classes.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ If a class is set, then it is certain that the corresponding fact is true.
289289
However, that a class is not set could mean that something is not the case, or
290290
that something is simply not known. This is only a problem with soft classes,
291291
where the state of a class can change during the execution of a policy,
292-
depending on the [order][normal ordering] in which bundles and promises are
292+
depending on the [order][Policy evaluation] in which bundles and promises are
293293
evaluated.
294294

295295
## Making decisions based on classes

reference/language-concepts/normal-ordering.markdown renamed to reference/language-concepts/policy-evaluation.markdown

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: default
3-
title: Normal ordering
3+
title: Policy evaluation
4+
alias: Normal ordering
45
published: true
56
sorting: 40
67
---
@@ -10,7 +11,7 @@ attributes and properties, ordering is irrelevant and should not be considered.
1011
More complex patterned data structures require ordering to be preserved, e.g.
1112
editing in files. CFEngine solves this in a two-part strategy:
1213

13-
CFEngine maintains a default order of promise-types. This is based on a simple
14+
CFEngine maintains a default order of promise-types, referred to as `Normal order`. This is based on a simple
1415
logic of what needs to come first, e.g. it makes no sense to create something
1516
and then delete it, but it could make sense to delete and then create (an
1617
equilibrium). This is called normal ordering and is described below. You can

reference/promise-types.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sorting: 20
66
---
77

88
Within a bundle, the promise types are executed in a round-robin fashion in the
9-
following [normal ordering][Normal ordering]. Which promise types are available
9+
following [normal order][Policy evaluation]. Which promise types are available
1010
depends on the [bundle][bundles] type:
1111

1212
| Promise type | common | agent | server | monitor |

reference/promise-types/custom.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Due to the implementation details, the following attributes from the `classes` b
9898
### Evaluation passes and normal order
9999

100100
In CFEngine, each bundle is evaluated in multiple passes (3 main passes for most promise types).
101-
Within each evaluation pass of a bundle, the promises are not evaluated from top to bottom, but based on a [normal order][Normal ordering] of the promise types.
101+
Within each evaluation pass of a bundle, the promises are not evaluated from top to bottom, but based on the [normal order][Policy evaluation] of the bundle type.
102102
Custom promise types are added dynamically and don't have a predefined order, they are evaluated as they appear within a bundle (top to bottom), but at the end of each evaluation pass, after all the built in promise types.
103103
As with other promise types, we recommend not relying too much on this ordering, if you want some promises to be evaluated before others, use the `bundlesequence` or `depends_on` attribute to achieve this.
104104

reference/promise-types/vars.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ two_example_com::
377377
comment => "Define a global domain for hosts in the two.example.com domain";
378378
```
379379

380-
(Promises within the same bundle are evaluated top to bottom, so vars promises further down in a bundle can overwrite previous values of a variable. See [**normal ordering**][Normal ordering] for more information).
380+
(Promises within the same bundle are evaluated top to bottom, so vars promises further down in a bundle can overwrite previous values of a variable. See [policy evaluation][Policy evaluation] for more information).
381381

382382
## Defining variables in foreign bundles
383383

resources/faq/manual-execution.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,4 @@ This command will run `cf-agent` with the additional class `patch_and_reboot` on
102102
classes it is using must be resolvable during pre-evaluation as the full
103103
evaluation is only allowed when the classes are found to be defined.
104104

105-
**See also:** [How is "recently seen" determined][Components#lastseenexpireafter], [`cf-runagent`][cf-runagent], [pre-evaluation][Normal ordering#agent pre-evaluation step]
105+
**See also:** [How is "recently seen" determined][Components#lastseenexpireafter], [`cf-runagent`][cf-runagent], [pre-evaluation][Policy evaluation#agent pre-evaluation step]

0 commit comments

Comments
 (0)