mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 16:55:36 +00:00
Code Issues Releases Wiki Activity

Merge pull request #3286 from ThomasWaldmann/doc-updates

Browse source 
doc updates
This commit is contained in:
TW 2017-11-05 22:16:26 +01:00 committed by GitHub
commit 915b9ae302
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.rst
View file

@ -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

3
docs/installation.rst
View file

@ -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

15
src/borg/archiver.py
View file

@ -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__,