From 90d75651e6243891542ee62cf75009e989a769f3 Mon Sep 17 00:00:00 2001 From: "Leo R. Lundgren" Date: Thu, 8 Oct 2020 17:59:26 +0200 Subject: [PATCH] backup: Improve wording for --one-file-system description --- cmd/restic/cmd_backup.go | 2 +- doc/040_backup.rst | 2 +- doc/manual_rest.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/restic/cmd_backup.go b/cmd/restic/cmd_backup.go index a6b25834c..afe213732 100644 --- a/cmd/restic/cmd_backup.go +++ b/cmd/restic/cmd_backup.go @@ -109,7 +109,7 @@ func init() { f.StringArrayVar(&backupOptions.InsensitiveExcludes, "iexclude", nil, "same as --exclude `pattern` but ignores the casing of filenames") f.StringArrayVar(&backupOptions.ExcludeFiles, "exclude-file", nil, "read exclude patterns from a `file` (can be specified multiple times)") f.StringArrayVar(&backupOptions.InsensitiveExcludeFiles, "iexclude-file", nil, "same as --exclude-file but ignores casing of `file`names in patterns") - f.BoolVarP(&backupOptions.ExcludeOtherFS, "one-file-system", "x", false, "exclude other file systems") + f.BoolVarP(&backupOptions.ExcludeOtherFS, "one-file-system", "x", false, "exclude other file systems, don't cross filesystem boundaries and subvolumes") f.StringArrayVar(&backupOptions.ExcludeIfPresent, "exclude-if-present", nil, "takes `filename[:header]`, exclude contents of directories containing filename (except filename itself) if header of that file is as provided (can be specified multiple times)") f.BoolVar(&backupOptions.ExcludeCaches, "exclude-caches", false, `excludes cache directories that are marked with a CACHEDIR.TAG file. See https://bford.info/cachedir/ for the Cache Directory Tagging Standard`) f.StringVar(&backupOptions.ExcludeLargerThan, "exclude-larger-than", "", "max `size` of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)") diff --git a/doc/040_backup.rst b/doc/040_backup.rst index d339d5078..3573c05f2 100644 --- a/doc/040_backup.rst +++ b/doc/040_backup.rst @@ -275,7 +275,7 @@ On most Unixy shells, you can either quote or use backslashes. For example: By specifying the option ``--one-file-system`` you can instruct restic to only backup files from the file systems the initially specified files or directories reside on. In other words, it will prevent restic from crossing -filesystem boundaries when performing a backup. +filesystem boundaries and subvolumes when performing a backup. For example, if you backup ``/`` with this option and you have external media mounted under ``/media/usb`` then restic will not back up ``/media/usb`` diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 0f2ff5e06..45ad8d980 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -105,7 +105,7 @@ command: --iexclude pattern same as --exclude pattern but ignores the casing of filenames --iexclude-file file same as --exclude-file but ignores casing of filenames in patterns --ignore-inode ignore inode number changes when checking for modified files - -x, --one-file-system exclude other file systems + -x, --one-file-system exclude other file systems, don't cross filesystem boundaries and subvolumes --parent snapshot use this parent snapshot (default: last snapshot in the repo that has the same target files/directories) --stdin read backup from stdin --stdin-filename filename filename to use when reading from stdin (default "stdin")