From a58d17650066721942f652d4846eaf870ac8eb48 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Wed, 3 Dec 2025 18:33:00 +0100 Subject: [PATCH] docs: clarify that parameter tuning applies to all commands --- ...parameters.rst => 047_tuning_parameters.rst} | 17 +++++++++-------- doc/index.rst | 2 +- 2 files changed, 10 insertions(+), 9 deletions(-) rename doc/{047_tuning_backup_parameters.rst => 047_tuning_parameters.rst} (92%) diff --git a/doc/047_tuning_backup_parameters.rst b/doc/047_tuning_parameters.rst similarity index 92% rename from doc/047_tuning_backup_parameters.rst rename to doc/047_tuning_parameters.rst index f1b89a7eb..eba958211 100644 --- a/doc/047_tuning_backup_parameters.rst +++ b/doc/047_tuning_parameters.rst @@ -9,14 +9,14 @@ ^ for subsubsections " for paragraphs -######################## -Tuning Backup Parameters -######################## +################# +Tuning Parameters +################# -Restic offers a few parameters that allow tuning the backup. The default values should -work well in general although specific use cases can benefit from different non-default -values. As the restic commands evolve over time, the optimal value for each parameter -can also change across restic versions. +Restic offers a few parameters that allow tuning the backup and other operations. +The default values should work well in general although specific use cases can +benefit from different non-default values. As the restic commands evolve over +time, the optimal value for each parameter can also change across restic versions. Disabling Backup Progress Estimation @@ -99,7 +99,8 @@ Swift and some Google Drive Team accounts, where there are hard limits on the to number of files. Larger pack sizes can also improve the backup speed for a repository stored on a local HDD. This can be achieved by either using the ``--pack-size`` option or defining the ``$RESTIC_PACK_SIZE`` environment variable, using an integer value for the -pack size in MiB. Restic currently defaults to a 16 MiB pack size. +pack size in MiB. Restic currently defaults to a 16 MiB pack size. Note that this +setting should be specified for each restic command that modifies the repository. The side effect of increasing the pack size is requiring more disk space for temporary pack files created before uploading. The space must be available in the system default temp diff --git a/doc/index.rst b/doc/index.rst index 8b72dcf58..ecfdabaa8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -9,7 +9,7 @@ Restic Documentation 030_preparing_a_new_repo 040_backup 045_working_with_repos - 047_tuning_backup_parameters + 047_tuning_parameters 050_restore 060_forget 070_encryption