Browse Source

Fix: run typos to fix various typos in source code.

Merge pull request #65 from diivi/fix/run-typos
Dan Helfman 2 years ago
parent
commit
1ad43ad4b5

+ 3 - 3
NEWS

@@ -397,7 +397,7 @@
    configuration schema descriptions.
    configuration schema descriptions.
 
 
 1.5.6
 1.5.6
- * #292: Allow before_backup and similiar hooks to exit with a soft failure without altering the
+ * #292: Allow before_backup and similar hooks to exit with a soft failure without altering the
    monitoring status on Healthchecks or other providers. Support this by waiting to ping monitoring
    monitoring status on Healthchecks or other providers. Support this by waiting to ping monitoring
    services with a "start" status until after before_* hooks finish. Failures in before_* hooks
    services with a "start" status until after before_* hooks finish. Failures in before_* hooks
    still trigger a monitoring "fail" status.
    still trigger a monitoring "fail" status.
@@ -466,7 +466,7 @@
  * For "list" and "info" actions, show repository names even at verbosity 0.
  * For "list" and "info" actions, show repository names even at verbosity 0.
 
 
 1.4.22
 1.4.22
- * #276, #285: Disable colored output when "--json" flag is used, so as to produce valid JSON ouput.
+ * #276, #285: Disable colored output when "--json" flag is used, so as to produce valid JSON output.
  * After a backup of a database dump in directory format, properly remove the dump directory.
  * After a backup of a database dump in directory format, properly remove the dump directory.
  * In "borgmatic --help", don't expand $HOME in listing of default "--config" paths.
  * In "borgmatic --help", don't expand $HOME in listing of default "--config" paths.
 
 
@@ -838,7 +838,7 @@
  * #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
  * #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
    editor swap files, etc.
    editor swap files, etc.
  * #81: Document user-defined hooks run before/after backup, or on error.
  * #81: Document user-defined hooks run before/after backup, or on error.
- * Add code style guidelines to the documention.
+ * Add code style guidelines to the documentation.
 
 
 1.2.0
 1.2.0
  * #61: Support for Borg --list option via borgmatic command-line to list all archives.
  * #61: Support for Borg --list option via borgmatic command-line to list all archives.

+ 1 - 1
borgmatic/borg/prune.py

@@ -9,7 +9,7 @@ logger = logging.getLogger(__name__)
 
 
 def make_prune_flags(storage_config, retention_config, local_borg_version):
 def make_prune_flags(storage_config, retention_config, local_borg_version):
     '''
     '''
-    Given a retention config dict mapping from option name to value, tranform it into an sequence of
+    Given a retention config dict mapping from option name to value, transform it into an sequence of
     command-line flags.
     command-line flags.
 
 
     For example, given a retention config of:
     For example, given a retention config of:

+ 1 - 1
borgmatic/commands/arguments.py

@@ -293,7 +293,7 @@ def make_parsers():
     )
     )
     transfer_group.add_argument(
     transfer_group.add_argument(
         '--upgrader',
         '--upgrader',
-        help='Upgrader type used to convert the transfered data, e.g. "From12To20" to upgrade data from Borg 1.2 to 2.0 format, defaults to no conversion',
+        help='Upgrader type used to convert the transferred data, e.g. "From12To20" to upgrade data from Borg 1.2 to 2.0 format, defaults to no conversion',
     )
     )
     transfer_group.add_argument(
     transfer_group.add_argument(
         '--progress',
         '--progress',

+ 1 - 1
borgmatic/config/convert.py

@@ -43,7 +43,7 @@ def convert_legacy_parsed_config(source_config, source_excludes, schema):
         ]
         ]
     )
     )
 
 
-    # Split space-seperated values into actual lists, make "repository" into a list, and merge in
+    # Split space-separated values into actual lists, make "repository" into a list, and merge in
     # excludes.
     # excludes.
     location = destination_config['location']
     location = destination_config['location']
     location['source_directories'] = source_config.location['source_directories'].split(' ')
     location['source_directories'] = source_config.location['source_directories'].split(' ')

+ 2 - 2
borgmatic/config/schema.yaml

@@ -6,7 +6,7 @@ properties:
     constants:
     constants:
         type: object
         type: object
         description: |
         description: |
-            Constants to use in the configuration file. All occurences of the
+            Constants to use in the configuration file. All occurrences of the
             constant name within culy braces will be replaced with the value.
             constant name within culy braces will be replaced with the value.
             For example, if you have a constant named "hostname" with the value
             For example, if you have a constant named "hostname" with the value
             "myhostname", then the string "{hostname}" will be replaced with
             "myhostname", then the string "{hostname}" will be replaced with
@@ -930,7 +930,7 @@ properties:
                             type: string
                             type: string
                             enum: ['sql']
                             enum: ['sql']
                             description: |
                             description: |
-                                Database dump output format. Currenly only "sql"
+                                Database dump output format. Currently only "sql"
                                 is supported. Defaults to "sql" for a single
                                 is supported. Defaults to "sql" for a single
                                 database. Or, when database name is "all" and
                                 database. Or, when database name is "all" and
                                 format is blank, dumps all databases to a single
                                 format is blank, dumps all databases to a single

+ 1 - 1
borgmatic/logger.py

@@ -68,7 +68,7 @@ class Multi_stream_handler(logging.Handler):
 
 
     def emit(self, record):
     def emit(self, record):
         '''
         '''
-        Dispatch the log record to the approriate stream handler for the record's log level.
+        Dispatch the log record to the appropriate stream handler for the record's log level.
         '''
         '''
         self.log_level_to_handler[record.levelno].emit(record)
         self.log_level_to_handler[record.levelno].emit(record)
 
 

+ 1 - 1
docs/_includes/components/toc.css

@@ -94,7 +94,7 @@
 	display: block;
 	display: block;
 }
 }
 
 
-/* Footer catgory navigation */
+/* Footer category navigation */
 .elv-cat-list-active {
 .elv-cat-list-active {
 	font-weight: 600;
 	font-weight: 600;
 }
 }

+ 2 - 2
docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server.md

@@ -116,8 +116,8 @@ There are some caveats you should be aware of with this feature.
  * You'll generally want to put a soft failure command in the `before_backup`
  * You'll generally want to put a soft failure command in the `before_backup`
    hook, so as to gate whether the backup action occurs. While a soft failure is
    hook, so as to gate whether the backup action occurs. While a soft failure is
    also supported in the `after_backup` hook, returning a soft failure there
    also supported in the `after_backup` hook, returning a soft failure there
-   won't prevent any actions from occuring, because they've already occurred!
-   Similiarly, you can return a soft failure from an `on_error` hook, but at
+   won't prevent any actions from occurring, because they've already occurred!
+   Similarly, you can return a soft failure from an `on_error` hook, but at
    that point it's too late to prevent the error.
    that point it's too late to prevent the error.
  * Returning a soft failure does prevent further commands in the same hook from
  * Returning a soft failure does prevent further commands in the same hook from
    executing. So, like a standard error, it is an "early out". Unlike a standard
    executing. So, like a standard error, it is an "early out". Unlike a standard

+ 2 - 2
docs/how-to/develop-on-borgmatic.md

@@ -100,10 +100,10 @@ the following deviations from it:
  * For strings, prefer single quotes over double quotes.
  * For strings, prefer single quotes over double quotes.
  * Limit all lines to a maximum of 100 characters.
  * Limit all lines to a maximum of 100 characters.
  * Use trailing commas within multiline values or argument lists.
  * Use trailing commas within multiline values or argument lists.
- * For multiline constructs, put opening and closing delimeters on lines
+ * For multiline constructs, put opening and closing delimiters on lines
    separate from their contents.
    separate from their contents.
  * Within multiline constructs, use standard four-space indentation. Don't align
  * Within multiline constructs, use standard four-space indentation. Don't align
-   indentation with an opening delimeter.
+   indentation with an opening delimiter.
 
 
 borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
 borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
 formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
 formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and

+ 1 - 1
docs/how-to/inspect-your-backups.md

@@ -111,7 +111,7 @@ By default, borgmatic logs to a local syslog-compatible daemon if one is
 present and borgmatic is running in a non-interactive console. Where those
 present and borgmatic is running in a non-interactive console. Where those
 logs show up depends on your particular system. If you're using systemd, try
 logs show up depends on your particular system. If you're using systemd, try
 running `journalctl -xe`. Otherwise, try viewing `/var/log/syslog` or
 running `journalctl -xe`. Otherwise, try viewing `/var/log/syslog` or
-similiar.
+similar.
 
 
 You can customize the log level used for syslog logging with the
 You can customize the log level used for syslog logging with the
 `--syslog-verbosity` flag, and this is independent from the console logging
 `--syslog-verbosity` flag, and this is independent from the console logging

+ 1 - 1
docs/how-to/set-up-backups.md

@@ -157,7 +157,7 @@ variable or set the `BORG_PASSPHRASE` environment variable. See the
 section](https://borgbackup.readthedocs.io/en/stable/quickstart.html#repository-encryption)
 section](https://borgbackup.readthedocs.io/en/stable/quickstart.html#repository-encryption)
 of the Borg Quick Start for more info.
 of the Borg Quick Start for more info.
 
 
-Alternatively, you can specify the passphrase programatically by setting
+Alternatively, you can specify the passphrase programmatically by setting
 either the borgmatic `encryption_passcommand` configuration variable or the
 either the borgmatic `encryption_passcommand` configuration variable or the
 `BORG_PASSCOMMAND` environment variable. See the [Borg Security
 `BORG_PASSCOMMAND` environment variable. See the [Borg Security
 FAQ](http://borgbackup.readthedocs.io/en/stable/faq.html#how-can-i-specify-the-encryption-passphrase-programmatically)
 FAQ](http://borgbackup.readthedocs.io/en/stable/faq.html#how-can-i-specify-the-encryption-passphrase-programmatically)

+ 1 - 1
tests/integration/config/test_validate.py

@@ -8,7 +8,7 @@ from flexmock import flexmock
 from borgmatic.config import validate as module
 from borgmatic.config import validate as module
 
 
 
 
-def test_schema_filename_returns_plausable_path():
+def test_schema_filename_returns_plausible_path():
     schema_path = module.schema_filename()
     schema_path = module.schema_filename()
 
 
     assert schema_path.endswith('/schema.yaml')
     assert schema_path.endswith('/schema.yaml')