Browse Source

update docs for create -C default change

Marian Beermann 8 years ago
parent
commit
332f7898bc
3 changed files with 17 additions and 13 deletions
  1. 12 8
      docs/faq.rst
  2. 4 4
      docs/quickstart.rst
  3. 1 1
      docs/usage.rst

+ 12 - 8
docs/faq.rst

@@ -108,19 +108,23 @@ Are there other known limitations?
   An easy workaround is to create multiple archives with less items each.
   An easy workaround is to create multiple archives with less items each.
   See also the :ref:`archive_limitation` and :issue:`1452`.
   See also the :ref:`archive_limitation` and :issue:`1452`.
 
 
-Why is my backup bigger than with attic? Why doesn't |project_name| do compression by default?
-----------------------------------------------------------------------------------------------
+Why is my backup bigger than with attic?
+----------------------------------------
 
 
 Attic was rather unflexible when it comes to compression, it always
 Attic was rather unflexible when it comes to compression, it always
 compressed using zlib level 6 (no way to switch compression off or
 compressed using zlib level 6 (no way to switch compression off or
 adjust the level or algorithm).
 adjust the level or algorithm).
 
 
-|project_name| offers a lot of different compression algorithms and
-levels. Which of them is the best for you pretty much depends on your
-use case, your data, your hardware -- so you need to do an informed
-decision about whether you want to use compression, which algorithm
-and which level you want to use. This is why compression defaults to
-none.
+The default in Borg is lz4, which is fast enough to not use significant CPU time
+in most cases, but can only achieve modest compression. It still compresses
+easily compressed data fairly well.
+
+zlib compression with all levels (1-9) as well as LZMA (1-6) are available
+as well, for cases where they are worth it.
+
+Which choice is the best option depends on a number of factors, like
+bandwidth to the repository, how well the data compresses, available CPU
+power and so on.
 
 
 If a backup stops mid-way, does the already-backed-up data stay there?
 If a backup stops mid-way, does the already-backed-up data stay there?
 ----------------------------------------------------------------------
 ----------------------------------------------------------------------

+ 4 - 4
docs/quickstart.rst

@@ -118,12 +118,12 @@ sudoers(5), or try ``sudo BORG_PASSPHRASE='yourphrase' borg`` syntax.
 Backup compression
 Backup compression
 ------------------
 ------------------
 
 
-Default is no compression, but we support different methods with high speed
-or high compression:
+The default is lz4 (very fast, but low compression ratio), but other methods are
+supported for different situations.
 
 
-If you have a fast repo storage and you want some compression: ::
+If you have a fast repo storage and you want minimum CPU usage, no compression::
 
 
-    $ borg create --compression lz4 /path/to/repo::arch ~
+    $ borg create --compression none /path/to/repo::arch ~
 
 
 If you have a less fast repo storage and you want a bit more compression (N=0..9,
 If you have a less fast repo storage and you want a bit more compression (N=0..9,
 0 means no compression, 9 means high compression): ::
 0 means no compression, 9 means high compression): ::

+ 1 - 1
docs/usage.rst

@@ -70,7 +70,7 @@ Examples
         --exclude 'sh:/home/*/.thumbnails'
         --exclude 'sh:/home/*/.thumbnails'
 
 
     # Backup the root filesystem into an archive named "root-YYYY-MM-DD"
     # Backup the root filesystem into an archive named "root-YYYY-MM-DD"
-    # use zlib compression (good, but slow) - default is no compression
+    # use zlib compression (good, but slow) - default is lz4 (fast, low compression ratio)
     $ borg create -C zlib,6 /path/to/repo::root-{now:%Y-%m-%d} / --one-file-system
     $ borg create -C zlib,6 /path/to/repo::root-{now:%Y-%m-%d} / --one-file-system
 
 
     # Backup a remote host locally ("pull" style) using sshfs
     # Backup a remote host locally ("pull" style) using sshfs