From dc68e8d1f06f4a749559fbf8fbb6847a8078c5e3 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 5 Nov 2017 19:13:15 +0100 Subject: [PATCH] improve docs about --stats, fixes #3260 --- src/borg/archiver.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 1df9326db..ede6b3517 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -2667,6 +2667,11 @@ class Archiver: (O, C and D, respectively), then the Number of files (N) processed so far, followed by the currently processed path. + When using ``--stats``, you will get some statistics about how much data was + added - the "This Archive" deduplicated size there is most interesting as that is + how much your repository will grow. + Please note that the "All archives" stats refer to the state after creation. + See the output of the "borg help patterns" command for more help on exclude patterns. See the output of the "borg help placeholders" command for more help on placeholders. @@ -2961,6 +2966,11 @@ class Archiver: This command deletes an archive from the repository or the complete repository. Disk space is reclaimed accordingly. If you delete the complete repository, the local cache for it (if any) is also deleted. + + When using ``--stats``, you will get some statistics about how much data was + deleted - the "Deleted data" deduplicated size there is most interesting as + that is how much your repository will shrink. + Please note that the "All archives" stats refer to the state after deletion. """) subparser = subparsers.add_parser('delete', parents=[common_parser], add_help=False, description=self.do_delete.__doc__, @@ -3185,6 +3195,11 @@ class Archiver: 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). + + When using ``--stats``, you will get some statistics about how much data was + deleted - the "Deleted data" deduplicated size there is most interesting as + that is how much your repository will shrink. + Please note that the "All archives" stats refer to the state after pruning. """) subparser = subparsers.add_parser('prune', parents=[common_parser], add_help=False, description=self.do_prune.__doc__,