mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-01 12:45:34 +00:00
Code Issues Releases Wiki Activity

Merge pull request #7489 from ThomasWaldmann/option-x-help-master

Browse source 
improve --one-file-system help /docs
This commit is contained in:
TW 2023-04-02 21:58:18 +02:00 committed by GitHub
commit 6b02c05f2b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/borg/archiver/create_cmd.py
View file

@ -635,13 +635,13 @@ def build_parser_create(self, subparsers, common_parser, mid_common_parser):
The ``-x`` or ``--one-file-system`` option excludes directories, that are mountpoints (and everything in them).
It detects mountpoints by comparing the device number from the output of ``stat()`` of the directory and its
parent directory. Specifically, it excludes directories for which ``stat()`` 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 ``--one-file-system``, 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.
from the device number of their parent.
In general: be aware that there are directories with device number different from their parent, which the kernel
does not consider a mountpoint and also the other way around.
Linux examples for this 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).
macOS examples are the apfs mounts of a typical macOS installation.
Therefore, when using ``--one-file-system``, you should double-check that the backup works as intended.
.. _list_item_flags:
@ -819,7 +819,8 @@ def build_parser_create(self, subparsers, common_parser, mid_common_parser):
"--one-file-system",
dest="one_file_system",
action="store_true",
help="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.",
help="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 description below.",
)
fs_group.add_argument(
"--numeric-ids",