Browse Source

Documentation clarifications (#791).

Dan Helfman 1 year ago
parent
commit
8b9abc6cf8
2 changed files with 12 additions and 8 deletions
  1. 8 5
      borgmatic/config/schema.yaml
  2. 4 3
      docs/how-to/extract-a-backup.md

+ 8 - 5
borgmatic/config/schema.yaml

@@ -216,7 +216,7 @@ properties:
             Store configuration files used to create a backup in the backup
             itself. Defaults to true. Changing this to false prevents "borgmatic
             bootstrap" from extracting configuration files from the backup.
-        example: true
+        example: false
     source_directories_must_exist:
         type: boolean
         description: |
@@ -287,14 +287,17 @@ properties:
     retry_wait:
         type: integer
         description: |
-            Wait time between retries (in seconds) to allow transient issues to
-            pass. Increases after each retry as a form of backoff. Defaults to 0
-            (no wait).
+            Wait time between retries (in seconds) to allow transient issues
+            to pass. Increases after each retry by that same wait time as a
+            form of backoff. Defaults to 0 (no wait).
         example: 10
     temporary_directory:
         type: string
         description: |
-            Directory where temporary files are stored. Defaults to $TMPDIR.
+            Directory where temporary Borg files are stored. Defaults to
+            $TMPDIR. See "Resource Usage" at
+            https://borgbackup.readthedocs.io/en/stable/usage/general.html for
+            details.
         example: /path/to/tmpdir
     ssh_command:
         type: string

+ 4 - 3
docs/how-to/extract-a-backup.md

@@ -149,9 +149,10 @@ borgmatic umount --mount-point /mnt
 
 <span class="minilink minilink-addedin">New in version 1.7.15</span> borgmatic
 automatically stores all the configuration files used to create an archive
-inside the archive itself. This is useful in cases where you've lost a
-configuration file or you want to see what configurations were used to create a
-particular archive.
+inside the archive itself. They are stored in the archive using their full
+paths from the machine being backed up. This is useful in cases where you've
+lost a configuration file or you want to see what configurations were used to
+create a particular archive.
 
 To extract the configuration files from an archive, use the `config bootstrap`
 action. For example: