Soumik_Dutta
/
borgmatic
forked from borgmatic-collective/borgmatic
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Replace "sequence" with "list" in docs for consistency.

This commit is contained in:
Dan Helfman 2023-04-12 10:30:23 -07:00
parent ea9213cb03
commit 08843d51d9
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/how-to/make-per-application-backups.md
View File

@ -285,7 +285,7 @@ included sections—without any merging occurring for them.
<span class="minilink minilink-addedin">New in version 1.7.12</span> That's <span class="minilink minilink-addedin">New in version 1.7.12</span> That's
where the `!retain` tag comes in. Whenever you're merging an included file where the `!retain` tag comes in. Whenever you're merging an included file
into your configuration file, you can optionally add the `!retain` tag to into your configuration file, you can optionally add the `!retain` tag to
particular local mappings or sequences to retain the local values and ignore particular local mappings or lists to retain the local values and ignore
included values. included values.
For instance, start with this configuration file containing the `!retain` tag For instance, start with this configuration file containing the `!retain` tag
@ -318,14 +318,13 @@ Once this include gets merged in, the resulting configuration will have a
`keep_daily` value of `5` and nothing else in the `retention` section. That's `keep_daily` value of `5` and nothing else in the `retention` section. That's
because the `!retain` tag says to retain the local version of `retention` and because the `!retain` tag says to retain the local version of `retention` and
ignore any values coming in from the include. But because the `repositories` ignore any values coming in from the include. But because the `repositories`
sequence doesn't have a `!retain` tag, that sequence still gets merged list doesn't have a `!retain` tag, it still gets merged together to contain
together to contain both `common.borg` and `repo.borg`. both `common.borg` and `repo.borg`.
The `!retain` tag can only be placed on mapping and sequence nodes, and it The `!retain` tag can only be placed on mappings and lists, and it goes right
goes right after the name of the option (and its colon) on the same line. The after the name of the option (and its colon) on the same line. The effects of
effects of `!retain` are recursive, meaning that if you place a `!retain` tag `!retain` are recursive, meaning that if you place a `!retain` tag on a
on a top-level mapping, even deeply nested values within it will not be top-level mapping, even deeply nested values within it will not be merged.
merged.
Additionally, the `!retain` tag only works in a configuration file that also Additionally, the `!retain` tag only works in a configuration file that also
performs a merge include with `<<: !include`. It doesn't make sense within, performs a merge include with `<<: !include`. It doesn't make sense within,