From 065be1d9d4feb4236712394f63a0c5d18ab624cb Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Thu, 20 Apr 2023 14:28:04 -0700 Subject: [PATCH] More inclusive language. --- SECURITY.md | 4 ++-- borgmatic/borg/rlist.py | 4 ++-- borgmatic/config/generate.py | 2 +- borgmatic/config/schema.yaml | 4 ++-- docs/how-to/backup-your-databases.md | 12 ++++++------ docs/how-to/inspect-your-backups.md | 2 +- docs/how-to/make-per-application-backups.md | 8 ++++---- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index d82b6f3..64c3d3b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -7,8 +7,8 @@ permalink: security-policy/index.html While we want to hear about security vulnerabilities in all versions of borgmatic, security fixes are only made to the most recently released version. -It's simply not practical for our small volunteer effort to maintain multiple -release branches and put out separate security patches for each. +It's not practical for our small volunteer effort to maintain multiple release +branches and put out separate security patches for each. ## Reporting a vulnerability diff --git a/borgmatic/borg/rlist.py b/borgmatic/borg/rlist.py index c051a9a..7f46870 100644 --- a/borgmatic/borg/rlist.py +++ b/borgmatic/borg/rlist.py @@ -17,8 +17,8 @@ def resolve_archive_name( ): ''' Given a local or remote repository path, an archive name, a storage config dict, a local Borg - path, and a remote Borg path, simply return the archive name. But if the archive name is - "latest", then instead introspect the repository for the latest archive and return its name. + path, and a remote Borg path, return the archive name. But if the archive name is "latest", + then instead introspect the repository for the latest archive and return its name. Raise ValueError if "latest" is given but there are no archives in the repository. ''' diff --git a/borgmatic/config/generate.py b/borgmatic/config/generate.py index d486f23..081186e 100644 --- a/borgmatic/config/generate.py +++ b/borgmatic/config/generate.py @@ -260,7 +260,7 @@ def merge_source_configuration_into_destination(destination_config, source_confi ) continue - # This is some sort of scalar. Simply set it into the destination. + # This is some sort of scalar. Set it into the destination. destination_config[field_name] = source_config[field_name] return destination_config diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index c4fd313..0cf02b2 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -60,7 +60,7 @@ properties: or port. If systemd service is used, then add local repository paths in the systemd service file to the ReadWritePaths list. Prior to borgmatic 1.7.10, repositories - was just a list of plain path strings. + was a list of plain path strings. example: - path: ssh://user@backupserver/./sourcehostname.borg label: backupserver @@ -1216,7 +1216,7 @@ properties: type: string description: | Healthchecks ping URL or UUID to notify when a - backup begins, ends, errors or just to send logs. + backup begins, ends, errors, or to send only logs. example: https://hc-ping.com/your-uuid-here verify_tls: type: boolean diff --git a/docs/how-to/backup-your-databases.md b/docs/how-to/backup-your-databases.md index db93c07..0a770d6 100644 --- a/docs/how-to/backup-your-databases.md +++ b/docs/how-to/backup-your-databases.md @@ -139,8 +139,8 @@ hooks: ### Containers If your database is running within a container and borgmatic is too, no -problem—simply configure borgmatic to connect to the container's name on its -exposed port. For instance: +problem—configure borgmatic to connect to the container's name on its exposed +port. For instance: ```yaml hooks: @@ -179,7 +179,7 @@ hooks: password: trustsome1 ``` -Of course, alter the ports in these examples to suit your particular database +You can alter the ports in these examples to suit your particular database system. @@ -397,9 +397,9 @@ dumps with any database system. With PostgreSQL and MySQL/MariaDB, 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 however 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 +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. The cause of an authentication error is often on the database side—in the diff --git a/docs/how-to/inspect-your-backups.md b/docs/how-to/inspect-your-backups.md index 73020ed..e89d23f 100644 --- a/docs/how-to/inspect-your-backups.md +++ b/docs/how-to/inspect-your-backups.md @@ -169,7 +169,7 @@ brackets. For instance, the default log format is: `[{asctime}] {levelname}: {message}`. This means each log message is recorded as the log time (in square brackets), a logging level name, a colon, and the actual log message. -So if you just want each log message to get logged *without* a timestamp or a +So if you only want each log message to get logged *without* a timestamp or a logging level name: ```bash diff --git a/docs/how-to/make-per-application-backups.md b/docs/how-to/make-per-application-backups.md index 9ee93f4..f2ddf01 100644 --- a/docs/how-to/make-per-application-backups.md +++ b/docs/how-to/make-per-application-backups.md @@ -86,8 +86,8 @@ uses the `archive_name_format` option to automatically limit which archives get used for actions operating on multiple archives. This prevents, for instance, duplicate archives from showing up in `rlist` or `info` results—even if the same repository appears in multiple borgmatic configuration files. To -take advantage of this feature, simply use a different `archive_name_format` -in each configuration file. +take advantage of this feature, use a different `archive_name_format` in each +configuration file. Under the hood, borgmatic accomplishes this by substituting globs for certain ephemeral data placeholders in your `archive_name_format`—and using the result @@ -108,8 +108,8 @@ archives used for actions like `rlist`, `info`, `prune`, `check`, etc. The end result is that when borgmatic runs the actions for a particular application-specific configuration file, it only operates on the archives -created for that application. Of course, this doesn't apply to actions like -`compact` that operate on an entire repository. +created for that application. But this doesn't apply to actions like `compact` +that operate on an entire repository. If this behavior isn't quite smart enough for your needs, you can use the `match_archives` option to override the pattern that borgmatic uses for