From c3004c609060012a91ce14cc0742b7cc620dfe17 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Sun, 25 Jun 2023 22:49:36 -0700 Subject: [PATCH] Some brief documentation on running only checks (#364). --- docs/how-to/backup-your-databases.md | 5 +++-- docs/how-to/deal-with-very-large-backups.md | 17 +++++++++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/how-to/backup-your-databases.md b/docs/how-to/backup-your-databases.md index fea3f350..bf2c7b68 100644 --- a/docs/how-to/backup-your-databases.md +++ b/docs/how-to/backup-your-databases.md @@ -189,8 +189,9 @@ system. would like to backup databases only and not source directories, you can omit `source_directories` entirely. -In older versions of borgmatic, instead specify an empty `source_directories` -value, as it is a mandatory option prior to version 1.7.1: +Prior to version 1.7.1 In older +versions of borgmatic, instead specify an empty `source_directories` value, as +it is a mandatory option there: ```yaml location: diff --git a/docs/how-to/deal-with-very-large-backups.md b/docs/how-to/deal-with-very-large-backups.md index 5beb9f24..d6142619 100644 --- a/docs/how-to/deal-with-very-large-backups.md +++ b/docs/how-to/deal-with-very-large-backups.md @@ -137,6 +137,23 @@ If you want to temporarily ignore your configured frequencies, you can invoke `borgmatic check --force` to run checks unconditionally. +### Running only checks + +New in version 1.7.1 If you +would like to only run consistency checks without creating backups (for +instance with the `check` action on the command-line), you can omit +the `source_directories` option entirely. + +Prior to version 1.7.1 In older +versions of borgmatic, instead specify an empty `source_directories` value, as +it is a mandatory option there: + +```yaml +location: + source_directories: [] +``` + + ### Disabling checks If that's still too slow, you can disable consistency checks entirely,