documentation: rephrase retention policy

pull/447/head
Axel Burri 2021-11-06 13:21:41 +01:00
parent cb38b7efa4
commit ed814aed5a
1 changed files with 12 additions and 9 deletions

View File

@ -487,21 +487,24 @@ sources for all (!) known candidates on the filesystem.
RETENTION POLICY RETENTION POLICY
---------------- ----------------
btrbk uses separate retention policies for snapshots and backups, Retention policies are defined individually for snapshots, backups and
which are defined by the 'snapshot_preserve_min', 'snapshot_preserve', archives (summarized as "backups" in the following text), using a
'target_preserve_min', 'target_preserve', 'preserve_day_of_week' and combination of:
'preserve_hour_of_day' configuration options.
Within this section, any statement about "backups" is always valid for **_preserve_min* all|latest|no|<number>{h,d,w,m,y}::
backups as well as snapshots, referring to 'target_preserve' or Amount of time (duration) in which all backups are preserved.
'snapshot_preserve' respectively.
**_preserve* no|<retention_policy>::
Schedule (single points in time) for which individual backups are
preserved.
Note that if "preserve_min" is set to ``all'' (the default), any
setting of "preserve" obviously has no effect.
The format for '<retention_policy>' is: The format for '<retention_policy>' is:
[<hourly>h] [<daily>d] [<weekly>w] [<monthly>m] [<yearly>y] [<hourly>h] [<daily>d] [<weekly>w] [<monthly>m] [<yearly>y]
With the following semantics:
*hourly*:: *hourly*::
Defines how many hours back hourly backups should be Defines how many hours back hourly backups should be
preserved. The first backup of an hour is considered an hourly preserved. The first backup of an hour is considered an hourly