Browse Source

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

tags/1.2.15
Dan Helfman 5 months ago
parent
commit
09d521661f

+ 2
- 0
NEWS View File

@@ -1,3 +1,5 @@
1
+1.2.15.dev0
2
+
1 3
 1.2.14
2 4
  * #103: When generating sample configuration with generate-borgmatic-config, document the defaults
3 5
    for each option.

+ 8
- 9
README.md View File

@@ -94,7 +94,7 @@ If that command is not found, then it may be installed in a location that's
94 94
 not in your system `PATH`. Try looking in `/usr/local/bin/`.
95 95
 
96 96
 This generates a sample configuration file at /etc/borgmatic/config.yaml (by
97
-default). You should edit the file to suit your needs, as the values are just
97
+default). You should edit the file to suit your needs, as the values are
98 98
 representative. All fields are optional except where indicated, so feel free
99 99
 to ignore anything you don't need.
100 100
 
@@ -156,8 +156,7 @@ key-based SSH access to the desired user account on the remote host.
156 156
 
157 157
 ### Backups
158 158
 
159
-You can run borgmatic and start a backup simply by invoking it without
160
-arguments:
159
+You can run borgmatic and start a backup by invoking it without arguments:
161 160
 
162 161
 ```bash
163 162
 borgmatic
@@ -292,7 +291,7 @@ See `borgmatic --help` for more information.
292 291
 ### Hooks
293 292
 
294 293
 If you find yourself performing prepraration tasks before your backup runs, or
295
-cleanup work afterwards, borgmatic hooks may be of interest. They're simply
294
+cleanup work afterwards, borgmatic hooks may be of interest. Hooks are
296 295
 shell commands that borgmatic executes for you at various points, and they're
297 296
 configured in the `hooks` section of your configuration file.
298 297
 
@@ -323,7 +322,7 @@ following:
323 322
 sudo pip3 install --upgrade borgmatic
324 323
 ```
325 324
 
326
-However, see below about special cases.
325
+See below about special cases.
327 326
 
328 327
 
329 328
 ### Upgrading from borgmatic 1.0.x
@@ -334,7 +333,7 @@ to express lists of values. To upgrade your existing configuration, first
334 333
 upgrade to the new version of borgmatic.
335 334
 
336 335
 As of version 1.1.0, borgmatic no longer supports Python 2. If you were
337
-already running borgmatic with Python 3, then you can simply upgrade borgmatic
336
+already running borgmatic with Python 3, then you can upgrade borgmatic
338 337
 in-place:
339 338
 
340 339
 ```bash
@@ -375,8 +374,8 @@ command](https://borgbackup.readthedocs.io/en/stable/usage.html#borg-upgrade)
375 374
 for more information. Then, follow the instructions above about setting up
376 375
 your borgmatic configuration files.
377 376
 
378
-If you were already using Borg with atticmatic, then you can easily upgrade
379
-from atticmatic to borgmatic. Simply run the following commands:
377
+If you were already using Borg with atticmatic, then you can upgrade
378
+from atticmatic to borgmatic by running the following commands:
380 379
 
381 380
 ```bash
382 381
 sudo pip3 uninstall atticmatic
@@ -444,7 +443,7 @@ git clone ssh://git@projects.torsion.org:3022/witten/borgmatic.git
444 443
 
445 444
 Then, install borgmatic
446 445
 "[editable](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)"
447
-so that you can easily run borgmatic commands while you're hacking on them to
446
+so that you can run borgmatic commands while you're hacking on them to
448 447
 make sure your changes work.
449 448
 
450 449
 ```bash

+ 2
- 2
borgmatic/borg/extract.py View File

@@ -8,8 +8,8 @@ logger = logging.getLogger(__name__)
8 8
 
9 9
 def extract_last_archive_dry_run(repository, lock_wait=None, local_path='borg', remote_path=None):
10 10
     '''
11
-    Perform an extraction dry-run of just the most recent archive. If there are no archives, skip
12
-    the dry-run.
11
+    Perform an extraction dry-run of the most recent archive. If there are no archives, skip the
12
+    dry-run.
13 13
     '''
14 14
     remote_path_flags = ('--remote-path', remote_path) if remote_path else ()
15 15
     lock_wait_flags = ('--lock-wait', str(lock_wait)) if lock_wait else ()

+ 1
- 1
borgmatic/commands/generate_config.py View File

@@ -36,7 +36,7 @@ def main():  # pragma: no cover
36 36
 
37 37
         print('Generated a sample configuration file at {}.'.format(args.destination_filename))
38 38
         print()
39
-        print('Please edit the file to suit your needs. The values are just representative.')
39
+        print('Please edit the file to suit your needs. The values are representative.')
40 40
         print('All fields are optional except where indicated.')
41 41
         print()
42 42
         print('If you ever need help: https://torsion.org/borgmatic/#issues')

+ 4
- 4
borgmatic/config/collect.py View File

@@ -20,10 +20,10 @@ def get_default_config_paths():
20 20
 
21 21
 def collect_config_filenames(config_paths):
22 22
     '''
23
-    Given a sequence of config paths, both filenames and directories, resolve that to just an
24
-    iterable of files. Accomplish this by listing any given directories looking for contained config
25
-    files (ending with the ".yaml" extension). This is non-recursive, so any directories within the
26
-    given directories are ignored.
23
+    Given a sequence of config paths, both filenames and directories, resolve that to an iterable
24
+    of files. Accomplish this by listing any given directories looking for contained config files
25
+    (ending with the ".yaml" extension). This is non-recursive, so any directories within the given
26
+    directories are ignored.
27 27
 
28 28
     Return paths even if they don't exist on disk, so the user can find out about missing
29 29
     configuration paths. However, skip a default config path if it's missing, so the user doesn't

+ 2
- 2
borgmatic/config/schema.yaml View File

@@ -161,7 +161,7 @@ map:
161 161
             ssh_command:
162 162
                 type: scalar
163 163
                 desc: |
164
-                    Command to use instead of just "ssh". This can be used to specify ssh options.
164
+                    Command to use instead of "ssh". This can be used to specify ssh options.
165 165
                     Defaults to not set.
166 166
                 example: ssh -i /path/to/private/key
167 167
             umask:
@@ -243,7 +243,7 @@ map:
243 243
                     "extract". Defaults to "repository" and "archives". Set to "disabled" to disable
244 244
                     all consistency checks. "repository" checks the consistency of the repository,
245 245
                     "archive" checks all of the archives, and "extract" does an extraction dry-run
246
-                    of just the most recent archive.
246
+                    of the most recent archive.
247 247
                 example:
248 248
                     - repository
249 249
                     - archives

+ 1
- 1
borgmatic/config/validate.py View File

@@ -93,7 +93,7 @@ def parse_configuration(config_filename, schema_filename):
93 93
         raise Validation_error(config_filename, (str(error),))
94 94
 
95 95
     # pykwalify gets angry if the example field is not a string. So rather than bend to its will,
96
-    # simply remove all examples before passing the schema to pykwalify.
96
+    # remove all examples before passing the schema to pykwalify.
97 97
     for section_name, section_schema in schema['map'].items():
98 98
         for field_name, field_schema in section_schema['map'].items():
99 99
             field_schema.pop('example', None)

+ 1
- 1
setup.py View File

@@ -1,7 +1,7 @@
1 1
 from setuptools import setup, find_packages
2 2
 
3 3
 
4
-VERSION = '1.2.14'
4
+VERSION = '1.2.15.dev0'
5 5
 
6 6
 
7 7
 setup(

Loading…
Cancel
Save