From dc68e8d1f06f4a749559fbf8fbb6847a8078c5e3 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 5 Nov 2017 19:13:15 +0100 Subject: [PATCH 1/2] 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 @@ 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. @@ -2961,6 +2966,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__, @@ -3185,6 +3195,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__, From 61d6c58241c08af2d1e51752eff5c184630af015 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 5 Nov 2017 19:24:49 +0100 Subject: [PATCH 2/2] update / rephrase cygwin / WSL status, fixes #3174 --- README.rst | 4 ++-- docs/installation.rst | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 6762017fb..46e9266b1 100644 --- a/README.rst +++ b/README.rst @@ -78,8 +78,8 @@ Main features * Mac OS X * FreeBSD * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet) - * Cygwin (not supported, no binaries yet) - * Linux Subsystem of Windows 10 (not supported) + * Cygwin (experimental, no binaries yet) + * Linux Subsystem of Windows 10 (experimental) **Free and Open Source Software** * security and functionality can be audited independently diff --git a/docs/installation.rst b/docs/installation.rst index edea1b240..68f89113b 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -261,8 +261,7 @@ Cygwin ++++++ .. note:: - Running under Cygwin is experimental and has only been tested with Cygwin - (x86-64) v2.5.2. Remote repositories are known broken, local repositories should work. + Running under Cygwin is experimental and has not been tested much yet. .. todo:: Add zeromq, use python 3.5 or 3.6