Skip to content

Commit

Permalink
Document behavior of checkCount
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
hahnjo committed Jul 21, 2019
1 parent 482eeef commit 8f7bafe
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ delete:
begin: "begin"
end: "end"
search: "remove"
checkCount: 1

replace:
-
Expand All @@ -30,6 +31,7 @@ replace:
end: "end"
search: "pattern"
replace: "substitution"
checkCount: 1

append: "last line"
```
Expand All @@ -41,6 +43,9 @@ If `begin` or `end` is omitted, the context begins in the first line or ends at
`begin` and `end` do not match the same substring, ie. `end` can only match from the position where the match of `begin` ended.
However, if `begin` and `end` still match at the same line the context will not be enabled.

`checkCount` is also optional and denotes how often a delete or replace is expected to be applied.
If the expectation does not hold, DynConf will print an error and not apply the recipe.

`file` names the configuration file that should be produced.
The unmodified input is taken from (in this order):
1. An updated configuration file installed by the distribution's package manager.
Expand Down

0 comments on commit 8f7bafe

Please sign in to comment.