From 309f67e8605c1138915916515388ddd1a9b47802 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Tue, 18 Jul 2023 23:27:45 -0700 Subject: [PATCH] Fix documentation comma grammar issues. --- docs/SECURITY.md | 2 +- .../add-preparation-and-cleanup-steps-to-backups.md | 2 +- docs/how-to/deal-with-very-large-backups.md | 2 +- docs/how-to/develop-on-borgmatic.md | 4 ++-- docs/how-to/make-per-application-backups.md | 6 +++--- docs/how-to/monitor-your-backups.md | 8 ++++---- docs/how-to/set-up-backups.md | 10 +++++----- docs/how-to/upgrade.md | 2 +- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 81a633e..b5f28b5 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -16,4 +16,4 @@ each. If you find a security vulnerability, please [file a ticket](https://torsion.org/borgmatic/#issues) or [send email directly](mailto:witten@torsion.org) as appropriate. You should expect to hear -back within a few days at most, and generally sooner. +back within a few days at most and generally sooner. diff --git a/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md b/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md index 37806f2..b34c4c9 100644 --- a/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md +++ b/docs/how-to/add-preparation-and-cleanup-steps-to-backups.md @@ -17,7 +17,7 @@ feature](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/) instead. You can specify `before_backup` hooks to perform preparation steps before -running backups, and specify `after_backup` hooks to perform cleanup steps +running backups and specify `after_backup` hooks to perform cleanup steps afterwards. Here's an example: ```yaml diff --git a/docs/how-to/deal-with-very-large-backups.md b/docs/how-to/deal-with-very-large-backups.md index 96064c1..c724581 100644 --- a/docs/how-to/deal-with-very-large-backups.md +++ b/docs/how-to/deal-with-very-large-backups.md @@ -189,7 +189,7 @@ check_repositories: - path/of/repository_to_check.borg ``` -Finally, you can override your configuration file's consistency checks, and +Finally, you can override your configuration file's consistency checks and run particular checks via the command-line. For instance: ```bash diff --git a/docs/how-to/develop-on-borgmatic.md b/docs/how-to/develop-on-borgmatic.md index bd219bb..c6a5adb 100644 --- a/docs/how-to/develop-on-borgmatic.md +++ b/docs/how-to/develop-on-borgmatic.md @@ -149,8 +149,8 @@ See the Black, Flake8, and isort documentation for more information. Each pull request triggers a continuous integration build which runs the test suite. You can view these builds on -[build.torsion.org](https://build.torsion.org/borgmatic-collective/borgmatic), and they're -also linked from the commits list on each pull request. +[build.torsion.org](https://build.torsion.org/borgmatic-collective/borgmatic), +and they're also linked from the commits list on each pull request. ## Documentation development diff --git a/docs/how-to/make-per-application-backups.md b/docs/how-to/make-per-application-backups.md index 60e0b22..8e4d706 100644 --- a/docs/how-to/make-per-application-backups.md +++ b/docs/how-to/make-per-application-backups.md @@ -153,7 +153,7 @@ in newer versions of borgmatic. Once you have multiple different configuration files, you might want to share common configuration options across these files with having to copy and paste them. To achieve this, you can put fragments of common configuration options -into a file, and then include or inline that file into one or more borgmatic +into a file and then include or inline that file into one or more borgmatic configuration files. Let's say that you want to include common consistency check configuration across all @@ -442,8 +442,8 @@ command-line via the `--override` flag. Here's an example: borgmatic create --override remote_path=/usr/local/bin/borg1 ``` -What this does is load your configuration files, and for each one, disregard -the configured value for the `remote_path` option, and use the value of +What this does is load your configuration files and for each one, disregard +the configured value for the `remote_path` option and use the value of `/usr/local/bin/borg1` instead. You can even override nested values or multiple values at once. For instance: diff --git a/docs/how-to/monitor-your-backups.md b/docs/how-to/monitor-your-backups.md index 2be61c6..7967c8a 100644 --- a/docs/how-to/monitor-your-backups.md +++ b/docs/how-to/monitor-your-backups.md @@ -106,7 +106,7 @@ on_error: ``` In this example, when the error occurs, borgmatic interpolates runtime values -into the hook command: the borgmatic configuration filename, and the path of +into the hook command: the borgmatic configuration filename and the path of the repository. Here's the full set of supported variables you can use here: * `configuration_filename`: borgmatic configuration filename in which the @@ -118,7 +118,7 @@ the repository. Here's the full set of supported variables you can use here: occurred without running a command) Note that borgmatic runs the `on_error` hooks only for `create`, `prune`, -`compact`, or `check` actions or hooks in which an error occurs, and not other +`compact`, or `check` actions/hooks in which an error occurs and not other actions. borgmatic does not run `on_error` hooks if an error occurs within a `before_everything` or `after_everything` hook. For more about hooks, see the [borgmatic hooks @@ -150,7 +150,7 @@ hooks run, borgmatic lets Healthchecks know that it has started if any of the `create`, `prune`, `compact`, or `check` actions are run. Then, if the actions complete successfully, borgmatic notifies Healthchecks of -the success after the `after_backup` hooks run, and includes borgmatic logs in +the success after the `after_backup` hooks run and includes borgmatic logs in the payload data sent to Healthchecks. This means that borgmatic logs show up in the Healthchecks UI, although be aware that Healthchecks currently has a 10-kilobyte limit for the logs in each ping. @@ -336,7 +336,7 @@ output formatted as JSON. Note that when you specify the `--json` flag, Borg's other non-JSON output is suppressed so as not to interfere with the captured JSON. Also note that JSON -output only shows up at the console, and not in syslog. +output only shows up at the console and not in syslog. ### Latest backups diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index 0797153..45fa944 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -59,11 +59,11 @@ borgmatic's path. ### Global install option -If you try the user site installation above, and have problems making -borgmatic commands runnable on your system `PATH`, an alternate approach is to -install borgmatic globally. +If you try the user site installation above and have problems making borgmatic +commands runnable on your system `PATH`, an alternate approach is to install +borgmatic globally. -The following uninstalls borgmatic, and then reinstalls it such that borgmatic +The following uninstalls borgmatic and then reinstalls it such that borgmatic commands are on the default system `PATH`: ```bash @@ -229,7 +229,7 @@ sudo borgmatic rcreate --encryption repokey-aes-ocb certain platforms like ARM64.) This uses the borgmatic configuration file you created above to determine -which local or remote repository to create, and encrypts it with the +which local or remote repository to create and encrypts it with the encryption passphrase specified there if one is provided. Read about [Borg encryption modes](https://borgbackup.readthedocs.io/en/stable/usage/init.html#encryption-mode-tldr) diff --git a/docs/how-to/upgrade.md b/docs/how-to/upgrade.md index 87e92ac..ff9f109 100644 --- a/docs/how-to/upgrade.md +++ b/docs/how-to/upgrade.md @@ -63,7 +63,7 @@ and, if desired, replace your original configuration file with it. ### Upgrading from borgmatic 1.0.x borgmatic changed its configuration file format in version 1.1.0 from -INI-style to YAML. This better supports validation, and has a more natural way +INI-style to YAML. This better supports validation and has a more natural way to express lists of values. To upgrade your existing configuration, first upgrade to the last version of borgmatic to support converting configuration: borgmatic 1.7.14.