Skip to content

Commit be7bdb6

Browse files
committed
Fix some minor issues
* Remove some trailing garbage * Add and update some formatting * Fix title for is_type()
1 parent f17695b commit be7bdb6

22 files changed

+63
-71
lines changed

getting-started/installation/general-installation/installation-community.markdown

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,19 @@ sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_p
7676
**Newer 64-bit DEB based distributions: (Ubuntu/Debian)**
7777

7878
```command
79-
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-debian7.deb`
79+
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-debian7.deb
8080
```
8181

8282
**Older 64-bit DEB based distributions: (Ubuntu/Debian)** (not recommended for policy server)
8383

8484
```command
85-
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-debian4.deb`
85+
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-debian4.deb
8686
```
8787

8888
**32-bit DEB based distributions: (Ubuntu/Debian)** (not recommended for policy server)
8989

9090
```command
91-
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_i386-debian4.deb`
91+
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_i386-debian4.deb
9292
```
9393

9494
**Note:** You might get a message like this: "Policy is not found in /var/cfengine/inputs, not starting CFEngine." Do not worry;
@@ -105,7 +105,11 @@ Run the bootstrap command:
105105
sudo /var/cfengine/bin/cf-agent --bootstrap <IP address of policy server>
106106
```
107107

108-
**Example: $ sudo /var/cfengine/bin/cf-agent --bootstrap 192.168.1.12**
108+
**Example:**
109+
110+
```command
111+
sudo /var/cfengine/bin/cf-agent --bootstrap 192.168.1.12
112+
```
109113

110114
Upon successful completion, a confirmation message appears: "Bootstrap to '192.168.1.12' completed successfully!"
111115

@@ -132,6 +136,10 @@ the Policy Server. Run the same commands that you ran in Step 3.
132136
sudo /var/cfengine/bin/cf-agent --bootstrap <IP address of policy server>
133137
```
134138

135-
**Example: $ sudo /var/cfengine/bin/cf-agent --bootstrap 192.168.1.12**
139+
**Example:**
140+
141+
```command
142+
sudo /var/cfengine/bin/cf-agent --bootstrap 192.168.1.12
143+
```
136144

137145
The CFEngine installation process is complete.

reference/components/cf-monitord.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ available as [special variables][special variables] (e.g.
1313
[`$(mon.av_cpu)`][mon#mon.av_cpu]) to `cf-agent`, which may use them to inform
1414
policy decisions.
1515

16-
`cf-monitord` keeps the promises made in `common`and `monitor` bundles, and is
17-
affected by `common` and `monitor` control bodies.
16+
`cf-monitord` keeps the promises made in `common` and `monitor` bundles and is
17+
affected by `common` and `monitor` control bodies.
1818

1919
**Notes:**
2020

21-
* `cf-monitord` always considers the class ```monitor``` to be defined.
21+
* `cf-monitord` always considers the class `monitor` to be defined.
2222

2323
## Command reference
2424

@@ -115,9 +115,9 @@ Slots with a higher number are used for custom measurement promises in
115115
CFEngine Enterprise.
116116

117117
These values collected and analyzed by `cf-monitord` are transformed
118-
into agent variables in the `$(mon.`name`)` context.
118+
into agent variables in the `$(mon.name)` context.
119119

120-
Note: There is no way for force a refresh of the monitored data.
120+
**Note:** There is no way for force a refresh of the monitored data.
121121

122122
## Data storage
123123

reference/functions/accumulated.markdown

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ published: true
99
**Description:** Convert an accumulated amount of time into a system representation.
1010

1111
The `accumulated` function measures total accumulated runtime. Arguments
12-
are applied additively, so that accumulated(0,0,2,27,90,0) means "2
12+
are applied additively, so that `accumulated(0,0,2,27,90,0)` means "2
1313
days, 27 hours and 90 minutes of runtime" ". However, you are strongly
1414
encouraged to keep your usage of `accumulated` sensible and readable;
15-
for example, accumulated(0,0,0,48,0,0) or accumulated(0,0,0,0,90,0).
15+
for example, `accumulated(0,0,0,48,0,0)` or `accumulated(0,0,0,0,90,0)`.
1616

1717

1818
**Arguments:**
@@ -78,9 +78,4 @@ body process_count anyprocs
7878
In the example we look for processes that have accumulated between 2 and
7979
20 minutes of total run time.
8080

81-
**See also:**
82-
83-
* Related functions
84-
* [`ago()`][ago]
85-
* [`now()`][now]
86-
* [`irange()`][irange]
81+
**See also:** `ago()`, `now()`, `irange()`

reference/functions/ago.markdown

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ published: true
99
**Description:** Convert a time relative to now to an integer system representation.
1010

1111
The `ago` function measures time relative to now. Arguments are applied
12-
in order, so that ago(0,18,55,27,0,0) means "18 months, 55 days, and 27
12+
in order, so that `ago(0,18,55,27,0,0)` means "18 months, 55 days, and 27
1313
hours ago". However, you are strongly encouraged to keep your usage of
14-
`ago` sensible and readable, e.g., ago(0,0,120,0,0,0) or
15-
ago(0,0,0,72,0,0).
14+
`ago` sensible and readable, e.g., `ago(0,0,120,0,0,0)` or
15+
`ago(0,0,0,72,0,0)`.
1616

1717
**Arguments:**
1818

@@ -50,9 +50,4 @@ Output:
5050

5151
[%CFEngine_include_snippet(ago.cf, #\+begin_src\s+example_output\s*, .*end_src)%]
5252

53-
**See also:**
54-
55-
* Related functions
56-
* [`now()`][now]
57-
* [`accumulated()`][accumulated]
58-
* [`irange()`][irange]
53+
**See also:** `now()`, `accumulated()`, `irange()`.

reference/functions/canonifyuniquely.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ published: true
1010

1111
This function turns arbitrary text into class data, appending the
1212
SHA-1 hash for uniqueness. It is exactly equivalent to
13-
`concat(canonify($(string)), "_", hash($(string),"sha1");` for a given
13+
`concat(canonify($(string)), "_", hash($(string),"sha1"));` for a given
1414
`$(string)` but is much more convenient to write and remember.
1515

1616
A common use case is when you need unique array keys for each file in
@@ -30,4 +30,4 @@ commands:
3030
if => canonifyuniquely("start_$(component)");
3131
```
3232

33-
**See also:** [canonify()][canonify]).
33+
**See also:** `canonify()`.

reference/functions/data_expand.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ Output:
3636

3737
[%CFEngine_include_snippet(data_expand.cf, #\+begin_src\s+example_output\s*, .*end_src)%]
3838

39-
**Notes:**
40-
4139
**History:** Was introduced in version 3.7.0 (2015). The [collecting functions][Functions#collecting functions] behavior was added in 3.9.
4240

4341
**See also:** [`readcsv()`][readcsv], [`readjson()`][readjson], [`readyaml()`][readyaml], [`mergedata()`][mergedata], [`readenvfile()`][readenvfile], [`classfiltercsv()`][classfiltercsv], [about collecting functions][Functions#collecting functions], and `data` documentation.

reference/functions/dirname.markdown

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ Output:
2121

2222
[%CFEngine_include_snippet(dirname.cf, #\+begin_src\s+example_output\s*, .*end_src)%]
2323

24-
**Notes:**
25-
2624
**History:** Was introduced in 3.3.0, Nova 2.2.0 (2011)
2725

28-
**See also:** [`lastnode()`][lastnode], [`filestat()`][filestat],
29-
[`splitstring()`][splitstring].
26+
**See also:** `lastnode()`, `filestat()`, `splitstring()`.

reference/functions/execresult.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ CFEngine's control. Thus using a shell is both a performance hog and a
1717
potential security issue.
1818

1919
The optional `output` argument allows you to select which output will be
20-
included, betweeen `stdout`, `stderr`, or `both`. The default is `both`.
20+
included, betweeen `stdout`, `stderr` or `both`. The default is `both`.
2121

2222
[%CFEngine_function_attributes(command, shell, output)%]
2323

@@ -46,7 +46,7 @@ highly undesirable if the command is expensive. Consider using
4646
`commands` promises instead, which have locking and are not evaluated
4747
by `cf-promises`.
4848

49-
**See also:** [`returnszero()`][returnszero], [`execresult_as_data()`][execresult_as_data].
49+
**See also:** `returnszero()`, `execresult_as_data()`.
5050

5151
**History:**
5252

reference/functions/findfiles.markdown

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ deep.
2727
This function, used together with the `bundlesmatching` function,
2828
allows you to do dynamic inputs and a dynamic bundle call chain.
2929

30-
**History:**
31-
- Brace expression (i.e., `{foo,bar}`) and negative bracket expressions (i.e., `[!abc]`) were introduced in 3.24.
32-
3330
**Example:**
3431

3532
[%CFEngine_include_snippet(findfiles.cf, #\+begin_src cfengine3, .*end_src)%]
@@ -38,4 +35,8 @@ Output:
3835

3936
[%CFEngine_include_snippet(findfiles.cf, #\+begin_src\s+example_output\s*, .*end_src)%]
4037

41-
**See also:** [`bundlesmatching()`][bundlesmatching], [`findfiles_up()`][findfiles_up].
38+
**History:**
39+
40+
- Brace expression (i.e., `{foo,bar}`) and negative bracket expressions (i.e., `[!abc]`) were introduced in 3.24.
41+
42+
**See also:** `bundlesmatching()`, `findfiles_up()`.

reference/functions/findfiles_up.markdown

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ deep.
3232
* `[!a-z]` matches any letter not from `a` to `z`.
3333
* `{foo,bar}` matches `foo` or `bar`.
3434

35-
**History:**
36-
- Brace expression (i.e., `{foo,bar}`) and negative bracket expressions (i.e., `[!abc]`) were introduced in 3.24.
37-
3835
[%CFEngine_function_attributes(path, glob, level)%]
3936

4037
**Example:**
@@ -45,6 +42,9 @@ Output:
4542

4643
[%CFEngine_include_snippet(findfiles_up.cf, #\+begin_src\s+example_output\s*, .*end_src)%]
4744

48-
**History:** Introduced in 3.18.
45+
**History:**
46+
47+
- Introduced in 3.18.
48+
- Brace expression (i.e., `{foo,bar}`) and negative bracket expressions (i.e., `[!abc]`) were introduced in 3.24.
4949

50-
**See also:** [`findfiles()`][findfiles].
50+
**See also:** `findfiles()`.

0 commit comments

Comments
 (0)