From f54d566edcaf1b9f13d7596b26c45a3dfdf5b40a Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Tue, 1 Oct 2024 13:37:31 -0700 Subject: [PATCH] Fixes to make the inclusive language linter happy. --- borgmatic/config/schema.yaml | 4 ++-- docs/_includes/layouts/base.njk | 1 + docs/how-to/backup-your-databases.md | 18 ++++++++--------- docs/how-to/deal-with-very-large-backups.md | 22 ++++++++++----------- docs/how-to/develop-on-borgmatic.md | 2 +- docs/how-to/monitor-your-backups.md | 6 +++--- docs/how-to/run-arbitrary-borg-commands.md | 2 +- docs/how-to/set-up-backups.md | 2 +- scripts/dev-docs | 2 +- 9 files changed, 30 insertions(+), 29 deletions(-) diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index 6412b2b8d..847ca6f56 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -1881,8 +1881,8 @@ properties: Allows setting custom labels for the logging stream. At least one label is required. "__hostname" gets replaced by the machine hostname automatically. "__config" gets replaced - by just the name of the configuration file. "__config_path" - gets replaced by the full path of the configuration file. + by the name of the configuration file. "__config_path" gets + replaced by the full path of the configuration file. example: app: "borgmatic" config: "__config" diff --git a/docs/_includes/layouts/base.njk b/docs/_includes/layouts/base.njk index dbb19d999..1119e27bc 100644 --- a/docs/_includes/layouts/base.njk +++ b/docs/_includes/layouts/base.njk @@ -3,6 +3,7 @@ + {{ subtitle + ' - ' if subtitle}}{{ title }} {%- set css %} diff --git a/docs/how-to/backup-your-databases.md b/docs/how-to/backup-your-databases.md index 5520fc1ed..a042347c8 100644 --- a/docs/how-to/backup-your-databases.md +++ b/docs/how-to/backup-your-databases.md @@ -211,8 +211,8 @@ Normally, borgmatic dumps a database by running a database dump command (e.g. connects to your containerized database via the given `hostname` and `port`. But if you don't have any database dump commands installed on your host and you'd rather use the commands inside your database container itself, borgmatic -supports that too. Just configure borgmatic to `exec` into your container to -run the dump command. +supports that too. For that, configure borgmatic to `exec` into your container +to run the dump command. For instance, if using Docker and PostgreSQL, something like this might work: @@ -459,9 +459,9 @@ special files (and symlinks to them) that Borg may get stuck on. Even so, there are still potential edge cases in which applications on your system create new special files *after* borgmatic constructs its exclude list, resulting in Borg hangs. If that occurs, you can resort to manually excluding -those files. And if you explicitly set the `read-special` option to `true`, +those files. And if you explicitly set the `read_special` option to `true`, borgmatic will opt you out of the auto-exclude feature entirely, but will -still instruct Borg to consume special files—you will just be on your own to +still instruct Borg to consume special files—and you will be on your own to exclude them. Prior to version 1.7.3Special files were not auto-excluded, and you were responsible for excluding them yourself. Common directories to exclude are `/dev` and `/run`, @@ -472,8 +472,8 @@ meant Borg wouldn't cross filesystem boundaries when looking for files to backup. When borgmatic was running in a container, this often required a work-around to explicitly add each mounted backup volume to `source_directories` instead of relying on Borg to include them implicitly via -a parent directory. However, as of borgmatic 1.8.15, `one_file_system` is no -longer auto-enabled and such work-arounds aren't necessary. +a parent directory. But as of borgmatic 1.8.15, `one_file_system` is no longer +auto-enabled and such work-arounds aren't necessary. ### Manual restoration @@ -513,9 +513,9 @@ With PostgreSQL, MariaDB, and MySQL, if you're getting authentication errors when borgmatic tries to connect to your database, a natural reaction is to increase your borgmatic verbosity with `--verbosity 2` and go looking in the logs. You'll notice though that your database password does not show up in the -logs. This is likely not the cause of the authentication problem unless you -mistyped your password, however; borgmatic passes your password to the -database via an environment variable that does not appear in the logs. +logs. But this is likely not the cause of the authentication problem unless +you mistyped your password; borgmatic passes your password to the database via +an environment variable that does not appear in the logs. The cause of an authentication error is often on the database side—in the configuration of which users are allowed to connect and how they are diff --git a/docs/how-to/deal-with-very-large-backups.md b/docs/how-to/deal-with-very-large-backups.md index 53fe06985..047ad28c8 100644 --- a/docs/how-to/deal-with-very-large-backups.md +++ b/docs/how-to/deal-with-very-large-backups.md @@ -108,8 +108,8 @@ for more information. The various consistency checks all have trade-offs around speed and thoroughness, but most of them don't even look at your original source files—arguably one important way to ensure your backups contain the files -you'll want to restore in the case of catastrophe (or just an accidentally -deleted file). Because if something goes wrong with your source files, most +you'll want to restore in the case of catastrophe (or an accidentally deleted +file). Because if something goes wrong with your source files, most consistency checks will still pass with flying colors and you won't discover there's a problem until you go to restore. @@ -119,10 +119,10 @@ check comes in. This check actually compares your source file counts and data against those in the latest archive, potentially catching problems like incorrect excludes, inadvertent deletes, files changed by malware, etc. -However, because an exhaustive comparison of all source files against the -latest archive might be too slow, the spot check supports *sampling* a -percentage of your source files for the comparison, ensuring they fall within -configured tolerances. +But because an exhaustive comparison of all source files against the latest +archive might be too slow, the spot check supports *sampling* a percentage of +your source files for the comparison, ensuring they fall within configured +tolerances. Here's how it works. Start by installing the `xxhash` OS package if you don't already have it, so the spot check can run the `xxh64sum` command and @@ -266,11 +266,11 @@ checks: Each day of the week is specified in the current locale (system language/country settings). `weekend` and `weekday` are also accepted. -Just like with `frequency`, borgmatic only makes a best effort to run checks -on the given day of the week. For instance, if you run `borgmatic check` -daily, then every day borgmatic will have an opportunity to determine whether -your checks are configured to run on that day. If they are, then the checks -run. If not, they are skipped. +As with `frequency`, borgmatic only makes a best effort to run checks on the +given day of the week. For instance, if you run `borgmatic check` daily, then +every day borgmatic will have an opportunity to determine whether your checks +are configured to run on that day. If they are, then the checks run. If not, +they are skipped. For instance, with the above configuration, if borgmatic is run on a Saturday, the `repository` check will run. But on a Monday? The repository check will diff --git a/docs/how-to/develop-on-borgmatic.md b/docs/how-to/develop-on-borgmatic.md index 57aca4109..218895432 100644 --- a/docs/how-to/develop-on-borgmatic.md +++ b/docs/how-to/develop-on-borgmatic.md @@ -9,7 +9,7 @@ eleventyNavigation: To get set up to develop on borgmatic, first [`install pipx`](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#installation) -to make managing your borgmatic environment easy without impacting other +to make managing your borgmatic environment easier without impacting other Python applications on your system. Then, clone borgmatic via HTTPS or SSH: diff --git a/docs/how-to/monitor-your-backups.md b/docs/how-to/monitor-your-backups.md index 803117280..e96c4040a 100644 --- a/docs/how-to/monitor-your-backups.md +++ b/docs/how-to/monitor-your-backups.md @@ -509,9 +509,9 @@ details. ## Uptime Kuma hook New in version 1.8.13 [Uptime -Kuma](https://uptime.kuma.pet) is an easy-to-use, self-hosted monitoring tool -and can provide a Push monitor type to accept HTTP `GET` requests from a -service instead of contacting it directly. +Kuma](https://uptime.kuma.pet) is a self-hosted monitoring tool and can +provide a Push monitor type to accept HTTP `GET` requests from a service +instead of contacting it directly. Uptime Kuma allows you to see a history of monitor states and can in turn alert via ntfy, Gotify, Matrix, Apprise, Email, and many more. diff --git a/docs/how-to/run-arbitrary-borg-commands.md b/docs/how-to/run-arbitrary-borg-commands.md index 95bee0282..20dfa6541 100644 --- a/docs/how-to/run-arbitrary-borg-commands.md +++ b/docs/how-to/run-arbitrary-borg-commands.md @@ -92,7 +92,7 @@ string instead of trying to resolve it from borgmatic's shell where it's not yet set. Or if you don't need borgmatic to resolve an archive name like `latest`, you -can just do: +can do: ```bash borgmatic borg list ::your-actual-archive-name diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index b9f0eec02..706a6774f 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -15,7 +15,7 @@ version 1.1. borgmatic does not install Borg automatically so as to avoid conflicts with existing Borg installations. Then, [install pipx](https://pypa.github.io/pipx/installation/) as the root -user (with `sudo`) to make installing borgmatic easy without impacting other +user (with `sudo`) to make installing borgmatic easier without impacting other Python applications on your system. If you have trouble installing pipx with pip, then you can install a system package instead. E.g. on Ubuntu or Debian, run: diff --git a/scripts/dev-docs b/scripts/dev-docs index 866ae0e9f..7443802ce 100755 --- a/scripts/dev-docs +++ b/scripts/dev-docs @@ -8,4 +8,4 @@ if [ -e "$USER_PODMAN_SOCKET_PATH" ]; then export DOCKER_HOST="unix://$USER_PODMAN_SOCKET_PATH" fi -docker-compose --file docs/docker-compose.yaml up --build --force-recreate +BUILDKIT_PROGRESS=plain docker-compose --file docs/docker-compose.yaml up --build --force-recreate