Merge pull request #1410 from ThomasWaldmann/doc-tweaks

docs: remove borg list example, be more specific about compression heuristics
This commit is contained in:
enkore 2016-07-31 23:21:15 +02:00 committed by GitHub
commit 3079b6451e
2 changed files with 2 additions and 12 deletions

View File

@ -367,17 +367,6 @@ Examples
-rw-rw-r-- user user 1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.ext
...
# see what is changed between archives, based on file modification time, size and file path
$ borg list /path/to/repo::archiveA --list-format="{mtime:%s}{TAB}{size}{TAB}{path}{LF}" |sort -n > /tmp/list.archiveA
$ borg list /path/to/repo::archiveB --list-format="{mtime:%s}{TAB}{size}{TAB}{path}{LF}" |sort -n > /tmp/list.archiveB
$ diff -y /tmp/list.archiveA /tmp/list.archiveB
1422781200 0 . 1422781200 0 .
1422781200 0 code 1422781200 0 code
1422781200 0 code/myproject 1422781200 0 code/myproject
1422781200 1416192 code/myproject/file.ext | 1454664653 1416192 code/myproject/file.ext
...
.. include:: usage/diff.rst.inc

View File

@ -1541,7 +1541,8 @@ class Archiver:
type=CompressionSpec, default=dict(name='none'), metavar='COMPRESSION',
help='select compression algorithm (and level):\n'
'none == no compression (default),\n'
'auto,C[,L] == built-in heuristic decides between none or C[,L] - with C[,L]\n'
'auto,C[,L] == built-in heuristic (try with lz4 whether the data is\n'
' compressible) decides between none or C[,L] - with C[,L]\n'
' being any valid compression algorithm (and optional level),\n'
'lz4 == lz4,\n'
'zlib == zlib (default level 6),\n'