From 79b8f73c7144e98fe86b137ef9cdbff0ba69fd1d Mon Sep 17 00:00:00 2001 From: Bastian Triller Date: Thu, 1 Aug 2024 14:19:03 +0200 Subject: [PATCH] Fix formatting Fix some lists, headings and typos. (cherry picked from commit 68d0361dfa5afc60080653d1d33a483c2ebf6d67) --- examples/example-snippets/user-management.markdown | 2 +- examples/tutorials/write-cfengine-policy.markdown | 2 +- examples/tutorials/writing-and-serving-policy.markdown | 1 - reference/components/cf-agent.markdown | 1 + reference/language-concepts/normal-ordering.markdown | 1 + reference/masterfiles-policy-framework.markdown | 2 +- reference/promise-types/commands.markdown | 2 +- 7 files changed, 6 insertions(+), 5 deletions(-) diff --git a/examples/example-snippets/user-management.markdown b/examples/example-snippets/user-management.markdown index 3f3464040..0e7e5efef 100644 --- a/examples/example-snippets/user-management.markdown +++ b/examples/example-snippets/user-management.markdown @@ -138,7 +138,7 @@ drwxr-xr-x 5 root root 4096 Dec 22 16:37 .. From the above output we can see that the local users `jack` and `jill` are present, and that they both have home directories. -Now lets activate the example policy and insepect the result. +Now lets activate the example policy and inspect the result. ```console root@debian-jessie:/core/examples# cf-agent -KIf ./local_users_absent.cf diff --git a/examples/tutorials/write-cfengine-policy.markdown b/examples/tutorials/write-cfengine-policy.markdown index 522ca0874..8c8169cc1 100644 --- a/examples/tutorials/write-cfengine-policy.markdown +++ b/examples/tutorials/write-cfengine-policy.markdown @@ -97,7 +97,7 @@ Let's save this policy in `/tmp/my-policy.cf`. You can now run this policy either in Distributed (client-server) System or in a Stand Alone system. The next two sections will cover each of the options. -## Option#1: Running the policy on a stand alone system +### Option#1: Running the policy on a stand alone system Since CFEngine is fully distributed we can run policies locally. This can come in handy as the result of a run is instant, especially during the design phase diff --git a/examples/tutorials/writing-and-serving-policy.markdown b/examples/tutorials/writing-and-serving-policy.markdown index da278537b..c40ff2073 100644 --- a/examples/tutorials/writing-and-serving-policy.markdown +++ b/examples/tutorials/writing-and-serving-policy.markdown @@ -50,7 +50,6 @@ Writing, deploying, and using CFEngine `promises` will generally follow these si 2. Create a bundle and promise in the file (see ["Hello world" policy example][Examples and tutorials#"Hello world" policy example]). 3. Save the file on the policy server somewhere under `/var/cfengine/masterfiles` (can be under a sub-directory). 4. Let CFEngine know about the `promise` on the `policy server`, generally in the file `/var/cfengine/masterfiles/promises.cf`, or a file elsewhere but referred to in `promises.cf`. - * Optional: it is also possible to call a bundle manually, using `cf-agent`. 5. Verify the `policy file` was deployed and successfully run. diff --git a/reference/components/cf-agent.markdown b/reference/components/cf-agent.markdown index 16f2306e1..291b8a9c9 100644 --- a/reference/components/cf-agent.markdown +++ b/reference/components/cf-agent.markdown @@ -1106,6 +1106,7 @@ The following classes are excluded from logging: * `any` * `from_cfexecd` * Life cycle (`Lcycle_0`, `GMT_Lcycle_3`) + ### secureinput **Description:** The `secureinput` menu option policy checks whether diff --git a/reference/language-concepts/normal-ordering.markdown b/reference/language-concepts/normal-ordering.markdown index 9fea7ae42..444d32f25 100644 --- a/reference/language-concepts/normal-ordering.markdown +++ b/reference/language-concepts/normal-ordering.markdown @@ -77,6 +77,7 @@ evaluation perspective as bundles placed in files included in body common control inputs will be evaluated before bundles from file control inputs. The following steps are executed per-bundle for each file parsed, in this order: + 1. if it's a common bundle, evaluate **vars** promises 2. if it's a common bundle, evaluate **classes** promises 3. evaluate **vars** promises diff --git a/reference/masterfiles-policy-framework.markdown b/reference/masterfiles-policy-framework.markdown index 9fbc1a43b..84871eb13 100644 --- a/reference/masterfiles-policy-framework.markdown +++ b/reference/masterfiles-policy-framework.markdown @@ -5,7 +5,7 @@ published: true sorting: 90 --- -The Masterfiles Policy Framework or MPF also commonly reffered to as simply +The Masterfiles Policy Framework or MPF also commonly referred to as simply masterfiles is the policy framework that ships with CFEngine. [%CFEngine_include_markdown(../../masterfiles/MPF.md)%] diff --git a/reference/promise-types/commands.markdown b/reference/promise-types/commands.markdown index a1f6dfee7..eb343f22a 100644 --- a/reference/promise-types/commands.markdown +++ b/reference/promise-types/commands.markdown @@ -43,7 +43,7 @@ commands: ``` When referring to executables the full path to the executable must be used. -When reffereing to executables whose paths contain spaces, you should quote +When referring to executables whose paths contain spaces, you should quote the entire program string separately so that CFEngine knows the name of the executable file. For example: