From 6306797238857fb1066aa465ecdca42661599a27 Mon Sep 17 00:00:00 2001 From: "Leo R. Lundgren" Date: Sun, 8 Jan 2023 20:05:46 +0100 Subject: [PATCH] doc: Clarify text about tuning backups for small files --- cmd/restic/cmd_backup.go | 2 +- doc/047_tuning_backup_parameters.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/restic/cmd_backup.go b/cmd/restic/cmd_backup.go index c2c973c7d..d29f3b371 100644 --- a/cmd/restic/cmd_backup.go +++ b/cmd/restic/cmd_backup.go @@ -123,7 +123,7 @@ func init() { f.BoolVar(&backupOptions.Stdin, "stdin", false, "read backup from stdin") f.StringVar(&backupOptions.StdinFilename, "stdin-filename", "stdin", "`filename` to use when reading from stdin") f.Var(&backupOptions.Tags, "tag", "add `tags` for the new snapshot in the format `tag[,tag,...]` (can be specified multiple times)") - f.UintVar(&backupOptions.ReadConcurrency, "read-concurrency", 0, "read `n` files concurrently. (default: $RESTIC_READ_CONCURRENCY or 2)") + f.UintVar(&backupOptions.ReadConcurrency, "read-concurrency", 0, "read `n` files concurrently (default: $RESTIC_READ_CONCURRENCY or 2)") f.StringVarP(&backupOptions.Host, "host", "H", "", "set the `hostname` for the snapshot manually. To prevent an expensive rescan use the \"parent\" flag") f.StringVar(&backupOptions.Host, "hostname", "", "set the `hostname` for the snapshot manually") err := f.MarkDeprecated("hostname", "use --host") diff --git a/doc/047_tuning_backup_parameters.rst b/doc/047_tuning_backup_parameters.rst index 0de846e88..d348b17ec 100644 --- a/doc/047_tuning_backup_parameters.rst +++ b/doc/047_tuning_backup_parameters.rst @@ -54,10 +54,10 @@ variable ``RESTIC_COMPRESSION``. File Read Concurrency ===================== -When backing up fast storage like NVME disks, it can be beneficial to increase the read -concurrency. This can increase the overall performance of the backup operation by reading -more files in parallel. You can specify the concurrency of file reads with the -``RESTIC_READ_CONCURRENCY`` environment variable or the ``--read-concurrency`` flag for +When backing up files from fast storage like NVMe disks, it can be beneficial to increase +the read concurrency. This can increase the overall performance of the backup operation +by reading more files in parallel. You can specify the concurrency of file reads with the +``RESTIC_READ_CONCURRENCY`` environment variable or the ``--read-concurrency`` option of the ``backup`` command.