forget: explain oldest snapshot special case in command help

This commit is contained in:
Michael Eischer 2024-05-25 15:10:21 +02:00
parent 80132e71d8
commit 2c7ebf4c7f
1 changed files with 3 additions and 0 deletions

View File

@ -21,6 +21,9 @@ var cmdForget = &cobra.Command{
The "forget" command removes snapshots according to a policy. All snapshots are The "forget" command removes snapshots according to a policy. All snapshots are
first divided into groups according to "--group-by", and after that the policy first divided into groups according to "--group-by", and after that the policy
specified by the "--keep-*" options is applied to each group individually. specified by the "--keep-*" options is applied to each group individually.
If there are not enough snapshots to keep one for each duration related
"--keep-{within-,}*" option, the oldest snapshot in the group is kept
additionally.
Please note that this command really only deletes the snapshot object in the Please note that this command really only deletes the snapshot object in the
repository, which is a reference to data stored there. In order to remove the repository, which is a reference to data stored there. In order to remove the