Преглед на файлове

Merge pull request #3286 from ThomasWaldmann/doc-updates

doc updates
TW преди 7 години
родител
ревизия
915b9ae302
променени са 3 файла, в които са добавени 18 реда и са изтрити 4 реда
  1. 2 2
      README.rst
  2. 1 2
      docs/installation.rst
  3. 15 0
      src/borg/archiver.py

+ 2 - 2
README.rst

@@ -78,8 +78,8 @@ Main features
     * Mac OS X
     * Mac OS X
     * FreeBSD
     * FreeBSD
     * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet)
     * 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**
 **Free and Open Source Software**
   * security and functionality can be audited independently
   * security and functionality can be audited independently

+ 1 - 2
docs/installation.rst

@@ -261,8 +261,7 @@ Cygwin
 ++++++
 ++++++
 
 
 .. note::
 .. 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
 .. todo:: Add zeromq, use python 3.5 or 3.6
 
 

+ 15 - 0
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
         (O, C and D, respectively), then the Number of files (N) processed so far, followed by
         the currently processed path.
         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 patterns" command for more help on exclude patterns.
         See the output of the "borg help placeholders" command for more help on placeholders.
         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.
         This command deletes an archive from the repository or the complete repository.
         Disk space is reclaimed accordingly. If you delete the complete repository, the
         Disk space is reclaimed accordingly. If you delete the complete repository, the
         local cache for it (if any) is also deleted.
         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,
         subparser = subparsers.add_parser('delete', parents=[common_parser], add_help=False,
                                           description=self.do_delete.__doc__,
                                           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
         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
         keep the last N archives under the assumption that you do not create more than one
         backup archive in the same second).
         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,
         subparser = subparsers.add_parser('prune', parents=[common_parser], add_help=False,
                                           description=self.do_prune.__doc__,
                                           description=self.do_prune.__doc__,