Merge branch 'main' into reduce-path-validation-memory-consumption

docs/_includes/snippet/command-line/sample.md

@@ -0,0 +1,5 @@
+Here's the command-line help for this action in the [most recent version of
+borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/releases).
+If you're using an older version, some of these flags may not work, and you
+should instead run the action with `--help` to see the flags specific to your
+borgmatic version.

docs/_includes/snippet/configuration/sample.md

@@ -0,0 +1,6 @@
+Here's an example configuration with all of the available options for this
+feature in the [most recent version of
+borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/releases).
+If you're using an older version, some of these options may not work, and you
+should instead [generate a sample configuration file specific to your borgmatic
+version](https://torsion.org/borgmatic/how-to/set-up-backups/#configuration).

docs/reference/command-line/actions/borg.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/borg.txt %}
 ```

docs/reference/command-line/actions/break-lock.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/break-lock.txt %}
 ```

docs/reference/command-line/actions/check.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/check.txt %}
 ```

docs/reference/command-line/actions/compact.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/compact.txt %}
 ```

docs/reference/command-line/actions/config-bootstrap.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/config-bootstrap.txt %}
 ```

docs/reference/command-line/actions/config-generate.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/config-generate.txt %}
 ```

docs/reference/command-line/actions/config-validate.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/config-validate.txt %}
 ```

docs/reference/command-line/actions/config.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/config.txt %}
 ```

docs/reference/command-line/actions/create.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/create.txt %}
 ```

docs/reference/command-line/actions/delete.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/delete.txt %}
 ```

docs/reference/command-line/actions/export-tar.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/export-tar.txt %}
 ```

docs/reference/command-line/actions/extract.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/extract.txt %}
 ```

docs/reference/command-line/actions/info.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/info.txt %}
 ```

docs/reference/command-line/actions/key-change-passphrase.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/key-change-passphrase.txt %}
 ```

docs/reference/command-line/actions/key-export.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/key-export.txt %}
 ```

docs/reference/command-line/actions/key-import.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/key-import.txt %}
 ```

docs/reference/command-line/actions/list.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/list.txt %}
 ```

docs/reference/command-line/actions/mount.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/mount.txt %}
 ```

docs/reference/command-line/actions/prune.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/prune.txt %}
 ```

docs/reference/command-line/actions/recreate.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/recreate.txt %}
 ```

docs/reference/command-line/actions/repo-create.md

@@ -4,6 +4,9 @@ eleventyNavigation:
   key: repo-create
   parent: 🎬 Actions
 ---
+
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/repo-create.txt %}
 ```

docs/reference/command-line/actions/repo-delete.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/repo-delete.txt %}
 ```

docs/reference/command-line/actions/repo-info.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/repo-info.txt %}
 ```

docs/reference/command-line/actions/repo-list.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/repo-list.txt %}
 ```

docs/reference/command-line/actions/restore.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/restore.txt %}
 ```

docs/reference/command-line/actions/transfer.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/transfer.txt %}
 ```

docs/reference/command-line/actions/umount.md

@@ -5,6 +5,8 @@ eleventyNavigation:
   parent: 🎬 Actions
 ---
 
+{% include snippet/command-line/sample.md %}
+
 ```
 {% include borgmatic/command-line/umount.txt %}
 ```

docs/reference/configuration/command-hooks.md

@@ -237,6 +237,8 @@ There are some caveats you should be aware of with this feature.
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/commands.yaml %}
 ```

docs/reference/configuration/data-sources/btrfs.md

@@ -114,6 +114,8 @@ subvolume, which is necessary for the borgmatic Btrfs hook to work.
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/btrfs.yaml %}
 ```

docs/reference/configuration/data-sources/lvm.md

@@ -124,6 +124,8 @@ work. See the comments in the sample systemd service file for details.
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/lvm.yaml %}
 ```

docs/reference/configuration/data-sources/mariadb.md

@@ -18,6 +18,8 @@ mariadb_databases:
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/mariadb_databases.yaml %}
 ```

docs/reference/configuration/data-sources/mongodb.md

@@ -16,6 +16,8 @@ mongodb_databases:
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/mongodb_databases.yaml %}
 ```

docs/reference/configuration/data-sources/mysql.md

@@ -16,6 +16,8 @@ mysql_databases:
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/mysql_databases.yaml %}
 ```

docs/reference/configuration/data-sources/postgresql.md

@@ -16,6 +16,8 @@ postgresql_databases:
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/postgresql_databases.yaml %}
 ```

docs/reference/configuration/data-sources/sqlite.md

@@ -17,6 +17,8 @@ sqlite_databases:
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/sqlite_databases.yaml %}
 ```

docs/reference/configuration/data-sources/zfs.md

@@ -113,6 +113,8 @@ the sample systemd service file for details.
 
 ## Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/zfs.yaml %}
 ```

docs/reference/configuration/monitoring/apprise.md

@@ -110,6 +110,8 @@ details.
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/apprise.yaml %}
 ```

docs/reference/configuration/monitoring/healthchecks.md

@@ -53,6 +53,8 @@ or it doesn't hear from borgmatic for a certain period of time.
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/healthchecks.yaml %}
 ```

docs/reference/configuration/monitoring/ntfy.md

@@ -52,9 +52,11 @@ ntfy:
 
 ### Full configuration
 
-Here's an example configuration with all the available options,
-including [priorities](https://ntfy.sh/docs/publish/#message-priority) and
-[tags](https://ntfy.sh/docs/publish/#tags-emojis):
+{% include snippet/configuration/sample.md %}
+
+The options here include
+[priorities](https://ntfy.sh/docs/publish/#message-priority) and
+[tags](https://ntfy.sh/docs/publish/#tags-emojis).
 
 ```yaml
 {% include borgmatic/ntfy.yaml %}

docs/reference/configuration/monitoring/pushover.md

@@ -57,6 +57,8 @@ pushover:
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/pushover.yaml %}
 ```

docs/reference/configuration/monitoring/uptime-kuma.md

@@ -61,6 +61,8 @@ Resend Notification every X times = 1
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/uptime_kuma.yaml %}
 ```

docs/reference/configuration/monitoring/zabbix.md

@@ -65,6 +65,8 @@ the "Visual name".
 
 ### Full configuration
 
+{% include snippet/configuration/sample.md %}
+
 ```yaml
 {% include borgmatic/zabbix.yaml %}
 ```