mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-01 04:37:34 +00:00
Code Issues Releases Wiki Activity

improve docs about --stats, fixes #3260

Browse source 
(cherry picked from commit dc68e8d1f0)
This commit is contained in:
Thomas Waldmann 2017-11-05 19:13:15 +01:00
parent baf9c65250
commit ae09b1a5bc
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/borg/archiver.py
View file

@ -2859,6 +2859,11 @@ def define_archive_filters_group(subparser, *, sort_by=True, first_last=True):
(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.
@ -3153,6 +3158,11 @@ def define_archive_filters_group(subparser, *, sort_by=True, first_last=True):
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__,
@ -3377,6 +3387,11 @@ def define_archive_filters_group(subparser, *, sort_by=True, first_last=True):
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__,