summaryrefslogtreecommitdiffstats
path: root/docs/usage
diff options
context:
space:
mode:
authorChen Yufei <cyfdecyf@gmail.com>2022-01-20 09:04:15 +0800
committerGitHub <noreply@github.com>2022-01-20 02:04:15 +0100
commit7e746e10e7f5236400e9a10674392b6bd138bbd3 (patch)
treee2d200ff5c39802e00c00f3f66796868a9fba57e /docs/usage
parent45ef118aa69c69c3e0bc15b6796a4e998a529473 (diff)
docs: excluded parent dir's metadata can't restore. (#6062)
docs: if parent dir is not extracted, we do not have its metadata
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/extract.rst.inc6
-rw-r--r--docs/usage/help.rst.inc6
2 files changed, 11 insertions, 1 deletions
diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc
index 76e3e70b2..474dbe7d3 100644
--- a/docs/usage/extract.rst.inc
+++ b/docs/usage/extract.rst.inc
@@ -118,4 +118,8 @@ pass over the archive metadata.
.. note::
Currently, extract always writes into the current working directory ("."),
- so make sure you ``cd`` to the right place before calling ``borg extract``. \ No newline at end of file
+ so make sure you ``cd`` to the right place before calling ``borg extract``.
+
+ When parent directories are not extracted (because of using file/directory selection
+ or any other reason), borg can not restore parent directories' metadata, e.g. owner,
+ group, permission, etc.
diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc
index c636b7c03..a77816458 100644
--- a/docs/usage/help.rst.inc
+++ b/docs/usage/help.rst.inc
@@ -167,6 +167,12 @@ Examples::
a directory, it won't recurse into it and won't discover any potential matches for
include rules below that directory.
+ .. note::
+
+ It's possible that a sub-directory/file is matched while parent directories are not.
+ In that case, parent directories are not backed up thus their user, group, permission,
+ etc. can not be restored.
+
Note that the default pattern style for ``--pattern`` and ``--patterns-from`` is
shell style (`sh:`), so those patterns behave similar to rsync include/exclude
patterns. The pattern style can be set via the `P` prefix.