Remove weasel words like "easily" and "simply".

This commit is contained in:
Dan Helfman 2018-12-25 22:03:34 -08:00
parent fd46efb193
commit 09d521661f
8 changed files with 21 additions and 20 deletions

2
NEWS
View file

@ -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.

View file

@ -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

View file

@ -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 ()

View file

@ -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')

View file

@ -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

View file

@ -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

View file

@ -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)

View file

@ -1,7 +1,7 @@
from setuptools import setup, find_packages
VERSION = '1.2.14'
VERSION = '1.2.15.dev0'
setup(