Merge pull request #3289 from ThomasWaldmann/doc-updates-1.1

doc updates 1.1

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)
+    * Cygwin (experimental, no binaries yet)
-    * Linux Subsystem of Windows 10 (not supported)
+    * Linux Subsystem of Windows 10 (experimental)
 
 **Free and Open Source Software**
   * security and functionality can be audited independently

docs/installation.rst

@@ -250,8 +250,7 @@ Cygwin
 ++++++
 
 .. note::
-    Running under Cygwin is experimental and has only been tested with Cygwin
+    Running under Cygwin is experimental and has not been tested much yet.
-    (x86-64) v2.5.2. Remote repositories are known broken, local repositories should work.
 
 Use the Cygwin installer to install the dependencies::
 

docs/misc/create_chunker-params.txt

@@ -7,6 +7,7 @@ CHUNK_MIN_EXP and CHUNK_MAX_EXP give the exponent N of the 2^N minimum and
 maximum chunk size. Required: CHUNK_MIN_EXP < CHUNK_MAX_EXP.
 
 Defaults: 19 (2^19 == 512KiB) minimum, 23 (2^23 == 8MiB) maximum.
+Currently it is not supported to give more than 23 as maximum.
 
 HASH_MASK_BITS is the number of least-significant bits of the rolling hash
 that need to be zero to trigger a chunk cut.

src/borg/archiver.py

@@ -2859,6 +2859,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.
 
@@ -2878,9 +2883,6 @@ class Archiver:
         and not include any other contents of the containing folder, this can be enabled
         through using the ``--keep-exclude-tags`` option.
 
-        Borg respects the nodump flag. Files flagged nodump will be marked as excluded (x)
-        in ``--list`` output.
-
         Item flags
         ++++++++++
 
@@ -3153,6 +3155,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__,
@@ -3377,6 +3384,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__,
@@ -3484,13 +3496,13 @@ class Archiver:
 
             borg delete borg
 
-        Unless ``--inplace`` is specified, the upgrade process first
+        Unless ``--inplace`` is specified, the upgrade process first creates a backup
-        creates a backup copy of the repository, in
+        copy of the repository, in REPOSITORY.before-upgrade-DATETIME, using hardlinks.
-        REPOSITORY.before-upgrade-DATETIME, using hardlinks. This takes
+        This requires that the repository and its parent directory reside on same
-        longer than in place upgrades, but is much safer and gives
+        filesystem so the hardlink copy can work.
-        progress information (as opposed to ``cp -al``). Once you are
+        This takes longer than in place upgrades, but is much safer and gives
-        satisfied with the conversion, you can safely destroy the
+        progress information (as opposed to ``cp -al``). Once you are satisfied
-        backup copy.
+        with the conversion, you can safely destroy the backup copy.
 
         WARNING: Running the upgrade in place will make the current
         copy unusable with older version, with no way of going back