From 09d521661f97e046c0e4c088fc45d6717be4185f Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Tue, 25 Dec 2018 22:03:34 -0800 Subject: [PATCH] Remove weasel words like "easily" and "simply". --- NEWS | 2 ++ README.md | 17 ++++++++--------- borgmatic/borg/extract.py | 4 ++-- borgmatic/commands/generate_config.py | 2 +- borgmatic/config/collect.py | 8 ++++---- borgmatic/config/schema.yaml | 4 ++-- borgmatic/config/validate.py | 2 +- setup.py | 2 +- 8 files changed, 21 insertions(+), 20 deletions(-) diff --git a/NEWS b/NEWS index c8b52cd6..30801a8e 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,5 @@ +1.2.15.dev0 + 1.2.14 * #103: When generating sample configuration with generate-borgmatic-config, document the defaults for each option. diff --git a/README.md b/README.md index 3cad8f83..c25a9e82 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ If that command is not found, then it may be installed in a location that's not in your system `PATH`. Try looking in `/usr/local/bin/`. This generates a sample configuration file at /etc/borgmatic/config.yaml (by -default). You should edit the file to suit your needs, as the values are just +default). You should edit the file to suit your needs, as the values are representative. All fields are optional except where indicated, so feel free to ignore anything you don't need. @@ -156,8 +156,7 @@ key-based SSH access to the desired user account on the remote host. ### Backups -You can run borgmatic and start a backup simply by invoking it without -arguments: +You can run borgmatic and start a backup by invoking it without arguments: ```bash borgmatic @@ -292,7 +291,7 @@ See `borgmatic --help` for more information. ### Hooks If you find yourself performing prepraration tasks before your backup runs, or -cleanup work afterwards, borgmatic hooks may be of interest. They're simply +cleanup work afterwards, borgmatic hooks may be of interest. Hooks are shell commands that borgmatic executes for you at various points, and they're configured in the `hooks` section of your configuration file. @@ -323,7 +322,7 @@ following: sudo pip3 install --upgrade borgmatic ``` -However, see below about special cases. +See below about special cases. ### Upgrading from borgmatic 1.0.x @@ -334,7 +333,7 @@ to express lists of values. To upgrade your existing configuration, first upgrade to the new version of borgmatic. As of version 1.1.0, borgmatic no longer supports Python 2. If you were -already running borgmatic with Python 3, then you can simply upgrade borgmatic +already running borgmatic with Python 3, then you can upgrade borgmatic in-place: ```bash @@ -375,8 +374,8 @@ command](https://borgbackup.readthedocs.io/en/stable/usage.html#borg-upgrade) for more information. Then, follow the instructions above about setting up your borgmatic configuration files. -If you were already using Borg with atticmatic, then you can easily upgrade -from atticmatic to borgmatic. Simply run the following commands: +If you were already using Borg with atticmatic, then you can upgrade +from atticmatic to borgmatic by running the following commands: ```bash sudo pip3 uninstall atticmatic @@ -444,7 +443,7 @@ git clone ssh://git@projects.torsion.org:3022/witten/borgmatic.git Then, install borgmatic "[editable](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)" -so that you can easily run borgmatic commands while you're hacking on them to +so that you can run borgmatic commands while you're hacking on them to make sure your changes work. ```bash diff --git a/borgmatic/borg/extract.py b/borgmatic/borg/extract.py index 960bda57..e5ebd542 100644 --- a/borgmatic/borg/extract.py +++ b/borgmatic/borg/extract.py @@ -8,8 +8,8 @@ logger = logging.getLogger(__name__) def extract_last_archive_dry_run(repository, lock_wait=None, local_path='borg', remote_path=None): ''' - Perform an extraction dry-run of just the most recent archive. If there are no archives, skip - the dry-run. + Perform an extraction dry-run of the most recent archive. If there are no archives, skip the + dry-run. ''' remote_path_flags = ('--remote-path', remote_path) if remote_path else () lock_wait_flags = ('--lock-wait', str(lock_wait)) if lock_wait else () diff --git a/borgmatic/commands/generate_config.py b/borgmatic/commands/generate_config.py index d91a19b9..6e08fccb 100644 --- a/borgmatic/commands/generate_config.py +++ b/borgmatic/commands/generate_config.py @@ -36,7 +36,7 @@ def main(): # pragma: no cover print('Generated a sample configuration file at {}.'.format(args.destination_filename)) print() - print('Please edit the file to suit your needs. The values are just representative.') + print('Please edit the file to suit your needs. The values are representative.') print('All fields are optional except where indicated.') print() print('If you ever need help: https://torsion.org/borgmatic/#issues') diff --git a/borgmatic/config/collect.py b/borgmatic/config/collect.py index e29de726..5107d367 100644 --- a/borgmatic/config/collect.py +++ b/borgmatic/config/collect.py @@ -20,10 +20,10 @@ def get_default_config_paths(): def collect_config_filenames(config_paths): ''' - Given a sequence of config paths, both filenames and directories, resolve that to just an - iterable of files. Accomplish this by listing any given directories looking for contained config - files (ending with the ".yaml" extension). This is non-recursive, so any directories within the - given directories are ignored. + Given a sequence of config paths, both filenames and directories, resolve that to an iterable + of files. Accomplish this by listing any given directories looking for contained config files + (ending with the ".yaml" extension). This is non-recursive, so any directories within the given + directories are ignored. Return paths even if they don't exist on disk, so the user can find out about missing configuration paths. However, skip a default config path if it's missing, so the user doesn't diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index a3f2f686..c5d4cec9 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -161,7 +161,7 @@ map: ssh_command: type: scalar desc: | - Command to use instead of just "ssh". This can be used to specify ssh options. + Command to use instead of "ssh". This can be used to specify ssh options. Defaults to not set. example: ssh -i /path/to/private/key umask: @@ -243,7 +243,7 @@ map: "extract". Defaults to "repository" and "archives". Set to "disabled" to disable all consistency checks. "repository" checks the consistency of the repository, "archive" checks all of the archives, and "extract" does an extraction dry-run - of just the most recent archive. + of the most recent archive. example: - repository - archives diff --git a/borgmatic/config/validate.py b/borgmatic/config/validate.py index 5c0b32ba..231e1511 100644 --- a/borgmatic/config/validate.py +++ b/borgmatic/config/validate.py @@ -93,7 +93,7 @@ def parse_configuration(config_filename, schema_filename): raise Validation_error(config_filename, (str(error),)) # pykwalify gets angry if the example field is not a string. So rather than bend to its will, - # simply remove all examples before passing the schema to pykwalify. + # remove all examples before passing the schema to pykwalify. for section_name, section_schema in schema['map'].items(): for field_name, field_schema in section_schema['map'].items(): field_schema.pop('example', None) diff --git a/setup.py b/setup.py index bf7d499a..6490636a 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,7 @@ from setuptools import setup, find_packages -VERSION = '1.2.14' +VERSION = '1.2.15.dev0' setup(