Skip to content

Commit 7aa3c07

Browse files
author
Sebastian Wagner
committed
Merge remote-tracking branch 'upstream/schacht/fix-typos-in-documentation' into develop
2 parents 78aeb7b + 3bb91e5 commit 7aa3c07

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/user/bots.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2527,11 +2527,11 @@ The following operators may be used to match events:
25272527

25282528
* `:exists` and `:notexists` match if a given key exists, for example:
25292529

2530-
```if :exists source.fqdn { ... }```
2530+
``if :exists source.fqdn { ... }``
25312531

25322532
* `==` and `!=` match for equality of strings and numbers, for example:
25332533

2534-
```if feed.name != 'acme-security' || feed.accuracy == 100 { ... }```
2534+
``if feed.name != 'acme-security' || feed.accuracy == 100 { ... }``
25352535

25362536
* `:contains` matches on substrings.
25372537

@@ -2541,18 +2541,18 @@ The following operators may be used to match events:
25412541

25422542
* `<<` matches if an IP address is contained in the specified network range:
25432543

2544-
```if source.ip << '10.0.0.0/8' { ... }```
2544+
``if source.ip << '10.0.0.0/8' { ... }``
25452545

25462546
* Values to match against can also be specified as list, in which case any one of the values will result in a match:
25472547

2548-
```if source.ip == ['8.8.8.8', '8.8.4.4'] { ... }```
2548+
``if source.ip == ['8.8.8.8', '8.8.4.4'] { ... }``
25492549

25502550
In this case, the event will match if it contains a key `source.ip` with
25512551
either value `8.8.8.8` or `8.8.4.4`.
25522552

25532553
With inequality operators, the behavior is the same, so it matches if any expression does not match:
25542554

2555-
```if source.ip != ['8.8.8.8', '8.8.4.4'] { ... }```
2555+
``if source.ip != ['8.8.8.8', '8.8.4.4'] { ... }``
25562556

25572557
Events with values like `8.8.8.8` or `8.8.4.4` will match, as they are always unequal to the other value.
25582558
The result is *not* that the field must be unequal to all given values.
@@ -2567,27 +2567,27 @@ in the sieve file will be forwarded to the next bot in the pipeline, unless the
25672567

25682568
* `add` adds a key value pair to the event. This action only applies if the key is not yet defined in the event. If the key is already defined, the action is ignored. Example:
25692569

2570-
```add comment = 'hello, world'```
2570+
``add comment = 'hello, world'``
25712571

25722572
* `add!` same as above, but will force overwrite the key in the event.
25732573

25742574
* `update` modifies an existing value for a key. Only applies if the key is already defined. If the key is not defined in the event, this action is ignored. Example:
25752575

2576-
```update feed.accuracy = 50```
2576+
``update feed.accuracy = 50``
25772577

25782578
* `remove` removes a key/value from the event. Action is ignored if the key is not defined in the event. Example:
25792579

2580-
```remove extra.comments```
2580+
``remove extra.comments``
25812581

25822582
* `keep` sends the message to the next bot in the pipeline (same as the default behaviour), and stops sieve file processing.
25832583

2584-
```keep```
2584+
``keep``
25852585

25862586
* `path` sets the path (named queue) the message should be sent to (implicitly
25872587
or with the command `keep`. The named queue needs to configured in the
25882588
pipeline, see the User Guide for more information.
25892589

2590-
```path 'named-queue'```
2590+
``path 'named-queue'``
25912591

25922592
* `drop` marks the event to be dropped. The event will not be forwarded to the next bot in the pipeline. The sieve file processing is interrupted upon
25932593
reaching this action. No other actions may be specified besides the `drop` action within `{` and `}`.

0 commit comments

Comments
 (0)