From 47103f904745e87ffc1bdf500ae06a49553edb7b Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 18 Apr 2016 22:38:20 +0200 Subject: [PATCH] prune: reorder help text, important -> easy -> more difficult also rephrase slightly, hopefully more clear now. --- borg/archiver.py | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/borg/archiver.py b/borg/archiver.py index c26468978..bc05471ff 100644 --- a/borg/archiver.py +++ b/borg/archiver.py @@ -1591,13 +1591,10 @@ def build_parser(self, args=None, prog=None): any of the specified retention options. This command is normally used by automated backup scripts wanting to keep a certain number of historic backups. - As an example, "-d 7" means to keep the latest backup on each day, up to 7 - most recent days with backups (days without backups do not count). - The rules are applied from secondly to yearly, and backups selected by previous - rules do not count towards those of later rules. The time that each backup - completes is used for pruning purposes. Dates and times are interpreted in - the local timezone, and weeks go from Monday to Sunday. Specifying a - negative number of archives to keep means that there is no limit. + If a prefix is set with -P, then only archives that start with the prefix are + considered for deletion and only those archives count towards the totals + specified by the rules. + Otherwise, *all* archives in the repository are candidates for deletion! The "--keep-within" option takes an argument of the form "", where char is "H", "d", "w", "m", "y". For example, "--keep-within 2d" means @@ -1605,14 +1602,18 @@ def build_parser(self, args=None, prog=None): "1m" is taken to mean "31d". The archives kept with this option do not count towards the totals specified by any other options. + A good procedure is to thin out more and more the older your backups get. + As an example, "--keep-daily 7" means to keep the latest backup on each day, + up to 7 most recent days with backups (days without backups do not count). + The rules are applied from secondly to yearly, and backups selected by previous + rules do not count towards those of later rules. The time that each backup + completes is used for pruning purposes. Dates and times are interpreted in + the local timezone, and weeks go from Monday to Sunday. Specifying a + negative number of archives to keep means that there is no limit. + The "--keep-last N" option is doing the same as "--keep-secondly N" (and it will keep the last N archives under the assumption that you do not create more than one backup archive in the same second). - - If a prefix is set with -P, then only archives that start with the prefix are - considered for deletion and only those archives count towards the totals - specified by the rules. - Otherwise, *all* archives in the repository are candidates for deletion! """) subparser = subparsers.add_parser('prune', parents=[common_parser], add_help=False, description=self.do_prune.__doc__,