Fix documentation comma grammar issues.
This commit is contained in:
parent
0ad7b4f408
commit
309f67e860
8 changed files with 18 additions and 18 deletions
|
@ -16,4 +16,4 @@ each.
|
||||||
If you find a security vulnerability, please [file a
|
If you find a security vulnerability, please [file a
|
||||||
ticket](https://torsion.org/borgmatic/#issues) or [send email
|
ticket](https://torsion.org/borgmatic/#issues) or [send email
|
||||||
directly](mailto:witten@torsion.org) as appropriate. You should expect to hear
|
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.
|
||||||
|
|
|
@ -17,7 +17,7 @@ feature](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
You can specify `before_backup` hooks to perform preparation steps before
|
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:
|
afterwards. Here's an example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
|
@ -189,7 +189,7 @@ check_repositories:
|
||||||
- path/of/repository_to_check.borg
|
- 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:
|
run particular checks via the command-line. For instance:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -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
|
Each pull request triggers a continuous integration build which runs the test
|
||||||
suite. You can view these builds on
|
suite. You can view these builds on
|
||||||
[build.torsion.org](https://build.torsion.org/borgmatic-collective/borgmatic), and they're
|
[build.torsion.org](https://build.torsion.org/borgmatic-collective/borgmatic),
|
||||||
also linked from the commits list on each pull request.
|
and they're also linked from the commits list on each pull request.
|
||||||
|
|
||||||
## Documentation development
|
## Documentation development
|
||||||
|
|
||||||
|
|
|
@ -153,7 +153,7 @@ in newer versions of borgmatic.
|
||||||
Once you have multiple different configuration files, you might want to share
|
Once you have multiple different configuration files, you might want to share
|
||||||
common configuration options across these files with having to copy and paste
|
common configuration options across these files with having to copy and paste
|
||||||
them. To achieve this, you can put fragments of common configuration options
|
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.
|
configuration files.
|
||||||
|
|
||||||
Let's say that you want to include common consistency check configuration across all
|
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
|
borgmatic create --override remote_path=/usr/local/bin/borg1
|
||||||
```
|
```
|
||||||
|
|
||||||
What this does is load your configuration files, and for each one, disregard
|
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
|
the configured value for the `remote_path` option and use the value of
|
||||||
`/usr/local/bin/borg1` instead.
|
`/usr/local/bin/borg1` instead.
|
||||||
|
|
||||||
You can even override nested values or multiple values at once. For instance:
|
You can even override nested values or multiple values at once. For instance:
|
||||||
|
|
|
@ -106,7 +106,7 @@ on_error:
|
||||||
```
|
```
|
||||||
|
|
||||||
In this example, when the error occurs, borgmatic interpolates runtime values
|
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:
|
the repository. Here's the full set of supported variables you can use here:
|
||||||
|
|
||||||
* `configuration_filename`: borgmatic configuration filename in which the
|
* `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)
|
occurred without running a command)
|
||||||
|
|
||||||
Note that borgmatic runs the `on_error` hooks only for `create`, `prune`,
|
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
|
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
|
`before_everything` or `after_everything` hook. For more about hooks, see the
|
||||||
[borgmatic hooks
|
[borgmatic hooks
|
||||||
|
@ -150,7 +150,7 @@ hooks</a> run, borgmatic lets Healthchecks know that it has started if any of
|
||||||
the `create`, `prune`, `compact`, or `check` actions are run.
|
the `create`, `prune`, `compact`, or `check` actions are run.
|
||||||
|
|
||||||
Then, if the actions complete successfully, borgmatic notifies Healthchecks of
|
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
|
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
|
in the Healthchecks UI, although be aware that Healthchecks currently has a
|
||||||
10-kilobyte limit for the logs in each ping.
|
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
|
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
|
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
|
### Latest backups
|
||||||
|
|
|
@ -59,11 +59,11 @@ borgmatic's path.
|
||||||
|
|
||||||
### Global install option
|
### Global install option
|
||||||
|
|
||||||
If you try the user site installation above, and have problems making
|
If you try the user site installation above and have problems making borgmatic
|
||||||
borgmatic commands runnable on your system `PATH`, an alternate approach is to
|
commands runnable on your system `PATH`, an alternate approach is to install
|
||||||
install borgmatic globally.
|
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`:
|
commands are on the default system `PATH`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -229,7 +229,7 @@ sudo borgmatic rcreate --encryption repokey-aes-ocb
|
||||||
certain platforms like ARM64.)
|
certain platforms like ARM64.)
|
||||||
|
|
||||||
This uses the borgmatic configuration file you created above to determine
|
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 passphrase specified there if one is provided. Read about [Borg
|
||||||
encryption
|
encryption
|
||||||
modes](https://borgbackup.readthedocs.io/en/stable/usage/init.html#encryption-mode-tldr)
|
modes](https://borgbackup.readthedocs.io/en/stable/usage/init.html#encryption-mode-tldr)
|
||||||
|
|
|
@ -63,7 +63,7 @@ and, if desired, replace your original configuration file with it.
|
||||||
### Upgrading from borgmatic 1.0.x
|
### Upgrading from borgmatic 1.0.x
|
||||||
|
|
||||||
borgmatic changed its configuration file format in version 1.1.0 from
|
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
|
to express lists of values. To upgrade your existing configuration, first
|
||||||
upgrade to the last version of borgmatic to support converting configuration:
|
upgrade to the last version of borgmatic to support converting configuration:
|
||||||
borgmatic 1.7.14.
|
borgmatic 1.7.14.
|
||||||
|
|
Loading…
Reference in a new issue