Merge pull request #5590 from ThomasWaldmann/rel1115

release 1.1.15
borgbackup · Dec 25, 2020 · 9b37666 · 9b37666
2 parents ebd59ab + 6916d1b
commit 9b37666
Show file tree

Hide file tree

Showing 38 changed files with 198 additions and 130 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -217,8 +217,8 @@ The best check that everything is ok is to run a dry-run extraction::
 Changelog
 =========
 
-Version 1.1.15 (not released yet)
----------------------------------
+Version 1.1.15 (2020-12-25)
+---------------------------
 
 Compatibility notes:
 
@@ -247,13 +247,19 @@ Compatibility notes:
 
 Fixes:
 
-- use --timestamp for {utcnow} and {now} if given, #5189
-- create: fix --dry-run and --stats coexistence, #5415
+- extract:
+
+  - improve exception handling when setting xattrs, #5092.
+  - emit a warning message giving the path, xattr key and error message.
+  - continue trying to restore other xattrs and bsdflags of the same file
+    after an exception with xattr-setting happened.
 - export-tar:
 
   - set tar format to GNU_FORMAT explicitly, #5274
   - fix memory leak with ssh: remote repository, #5568
   - fix potential memory leak with ssh: remote repository with partial extraction
+- create: fix --dry-run and --stats coexistence, #5415
+- use --timestamp for {utcnow} and {now} if given, #5189
 
 New features:
 
@@ -268,6 +274,7 @@ Other changes:
 - set cython language_level in some files to fix warnings
 - allow EIO with warning when trying to hardlink
 - PropDict: fail early if internal_dict is not a dict
+- update shell completions
 - tests / CI
 
   - add a test for the hashindex corruption bug, #5531 #4829
@@ -293,6 +300,7 @@ Other changes:
   - new compression algorithm policy, #1633 #5505
   - faq: add a hint on sleeping computer, #5301
   - note requirements for full disk access on macOS Catalina, #5303
+  - fix/improve description of borg upgrade hardlink usage, #5518
 - modernize 1.1 code:
 
   - drop code/workarounds only needed to support Python 3.4

diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BENCHMARK-CRUD 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-BENCHMARK-CRUD 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .

diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BENCHMARK 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-BENCHMARK 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-benchmark \- benchmark command
 .

diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BREAK-LOCK 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-BREAK-LOCK 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 .

diff --git a/docs/man/borg-change-passphrase.1 b/docs/man/borg-change-passphrase.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CHANGE-PASSPHRASE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-CHANGE-PASSPHRASE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-change-passphrase \- Change repository key file passphrase
 .

diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CHECK 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-CHECK 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-check \- Check repository consistency
 .

diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-COMMON 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-COMMON 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-common \- Common options of Borg commands
 .

diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-COMPRESSION 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-COMPRESSION 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-compression \- Details regarding compression
 .

diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CONFIG 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-CONFIG 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-config \- get, set, and delete values in a repository or cache config file
 .

diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CREATE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-CREATE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-create \- Create new archive
 .
@@ -117,6 +117,7 @@ the state after creation. Also, the \fB\-\-stats\fP and \fB\-\-dry\-run\fP optio
 exclusive because the data is not actually compressed and deduplicated during a dry run.
 .sp
 See the output of the "borg help patterns" command for more help on exclude patterns.
+.sp
 See the output of the "borg help placeholders" command for more help on placeholders.
 .SH OPTIONS
 .sp
@@ -156,6 +157,15 @@ do not load/update the file metadata cache used to detect unchanged files
 .TP
 .BI \-\-stdin\-name \ NAME
 use NAME in archive for stdin data (default: "stdin")
+.TP
+.BI \-\-stdin\-user \ USER
+set user USER in archive for stdin data (default: \(aqroot\(aq)
+.TP
+.BI \-\-stdin\-group \ GROUP
+set group GROUP in archive for stdin data (default: \(aqroot\(aq)
+.TP
+.BI \-\-stdin\-mode \ M
+set mode to M in archive for stdin data (default: 0660)
 .UNINDENT
 .SS Exclusion options
 .INDENT 0.0
@@ -188,7 +198,7 @@ exclude files flagged NODUMP
 .INDENT 0.0
 .TP
 .B \-x\fP,\fB  \-\-one\-file\-system
-stay in the same file system and do not store mount points of other file systems
+stay in the same file system and do not store mount points of other file systems.  This might behave different from your expectations, see the docs.
 .TP
 .B \-\-numeric\-owner
 only store numeric user and group identifiers
@@ -320,6 +330,17 @@ all of its contents will be omitted from the backup.  If, however, you wish to
 only include the objects specified by \fB\-\-exclude\-if\-present\fP in your backup,
 and not include any other contents of the containing folder, this can be enabled
 through using the \fB\-\-keep\-exclude\-tags\fP option.
+.sp
+The \fB\-x\fP or \fB\-\-one\-file\-system\fP option excludes directories, that are mountpoints (and everything in them).
+It detects mountpoints by comparing the device number from the output of \fBstat()\fP of the directory and its
+parent directory. Specifically, it excludes directories for which \fBstat()\fP reports a device number different
+from the device number of their parent. Be aware that in Linux (and possibly elsewhere) there are directories
+with device number different from their parent, which the kernel does not consider a mountpoint and also the
+other way around. Examples are bind mounts (possibly same device number, but always a mountpoint) and ALL
+subvolumes of a btrfs (different device number from parent but not necessarily a mountpoint). Therefore when
+using \fB\-\-one\-file\-system\fP, one should make doubly sure that the backup works as intended especially when using
+btrfs. This is even more important, if the btrfs layout was created by someone else, e.g. a distribution
+installer.
 .SS Item flags
 .sp
 \fB\-\-list\fP outputs a list of all files, directories and other

diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-DELETE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-DELETE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-delete \- Delete an existing repository or archives
 .

diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-DIFF 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-DIFF 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-diff \- Diff contents of two archives
 .

diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-EXPORT-TAR 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-EXPORT-TAR 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-export-tar \- Export archive contents as a tarball
 .

diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-EXTRACT 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-EXTRACT 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-extract \- Extract archive contents
 .

diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-INFO 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-INFO 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-info \- Show archive details such as disk space used
 .

diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-INIT 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-INIT 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-init \- Initialize an empty repository
 .

diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-key-change-passphrase \- Change repository key file passphrase
 .

diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-EXPORT 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-KEY-EXPORT 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-key-export \- Export the repository key for backup
 .

diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-IMPORT 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-KEY-IMPORT 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-key-import \- Import the repository key from backup
 .

diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
 .

diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-KEY 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-key \- Manage a keyfile or repokey of a repository
 .

diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-LIST 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-LIST 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-list \- List archive or repository contents
 .
@@ -119,6 +119,13 @@ lrwxrwxrwx root   root          0 Fri, 2015\-03\-27 20:24:26 bin/bzcmp \-> bzdif
 \-rwxr\-xr\-x root   root       2140 Fri, 2015\-03\-27 20:24:22 bin/bzdiff
 \&...
 
+$ borg list /path/to/repo::root\-2016\-02\-15 \-\-pattern "\- bin/ba*"
+drwxr\-xr\-x root   root          0 Mon, 2016\-02\-15 17:44:27 .
+drwxrwxr\-x root   root          0 Mon, 2016\-02\-15 19:04:49 bin
+lrwxrwxrwx root   root          0 Fri, 2015\-03\-27 20:24:26 bin/bzcmp \-> bzdiff
+\-rwxr\-xr\-x root   root       2140 Fri, 2015\-03\-27 20:24:22 bin/bzdiff
+\&...
+
 $ borg list /path/to/repo::archiveA \-\-format="{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}"
 drwxrwxr\-x user   user          0 Sun, 2015\-02\-01 11:00:00 .
 drwxrwxr\-x user   user          0 Sun, 2015\-02\-01 11:00:00 code

diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-MOUNT 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-MOUNT 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .

diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-PATTERNS 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-PATTERNS 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-patterns \- Details regarding patterns
 .
@@ -168,8 +168,10 @@ $ cat >exclude.txt <<EOF
 /home/*/junk
 *.tmp
 fm:aa:something/*
-re:^/home/[^/]\e.tmp/
-sh:/home/*/.thumbnails
+re:^home/[^/]\e.tmp/
+sh:home/*/.thumbnails
+ # Example with spaces, no need to escape as it is processed by borg
+some file with spaces.txt
 EOF
 $ borg create \-\-exclude\-from exclude.txt backup /
 .ft P

diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-PLACEHOLDERS 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-PLACEHOLDERS 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-placeholders \- Details regarding placeholders
 .

diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-PRUNE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-PRUNE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-prune \- Prune repository archives according to specified rules
 .

diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-RECREATE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-RECREATE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-recreate \- Re-create archives
 .

diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-RENAME 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-RENAME 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-rename \- Rename an existing archive
 .

diff --git a/docs/man/borg-serve.1 b/docs/man/borg-serve.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-SERVE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-SERVE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-serve \- Start in server mode. This command is usually not used manually.
 .

diff --git a/docs/man/borg-umount.1 b/docs/man/borg-umount.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-UMOUNT 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-UMOUNT 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-umount \- un-mount the FUSE filesystem
 .

diff --git a/docs/man/borg-upgrade.1 b/docs/man/borg-upgrade.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-UPGRADE 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-UPGRADE 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-upgrade \- upgrade a repository from a previous version
 .

diff --git a/docs/man/borg-with-lock.1 b/docs/man/borg-with-lock.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-WITH-LOCK 1 "2020-10-06" "" "borg backup tool"
+.TH BORG-WITH-LOCK 1 "2020-12-24" "" "borg backup tool"
 .SH NAME
 borg-with-lock \- run a user specified command with the repository lock held
 .