Browse Source

Clarify that spaces in path names should not be backslashed in path names (#406).

Dan Helfman 4 years ago
parent
commit
9016f4be43
4 changed files with 10 additions and 6 deletions
  1. 1 0
      NEWS
  2. 1 1
      README.md
  3. 6 3
      borgmatic/config/schema.yaml
  4. 2 2
      docs/how-to/set-up-backups.md

+ 1 - 0
NEWS

@@ -1,5 +1,6 @@
 1.5.14.dev0
  * #398: Clarify canonical home of borgmatic in documentation.
+ * #406: Clarify that spaces in path names should not be backslashed in path names.
  * Fix build so as not to attempt to build and push documentation for a non-master branch.
  * "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13.
 

+ 1 - 1
README.md

@@ -86,7 +86,7 @@ reference guides</a>.
 
 ## Hosting providers
 
-Need somewhere to store your encrypted offsite backups? The following hosting
+Need somewhere to store your encrypted off-site backups? The following hosting
 providers include specific support for Borg/borgmatic. Using these links and
 services helps support borgmatic development and hosting. (These are referral
 links, but without any tracking scripts or cookies.)

+ 6 - 3
borgmatic/config/schema.yaml

@@ -15,11 +15,12 @@ map:
                     - type: str
                 desc: |
                     List of source directories to backup (required). Globs and
-                    tildes are expanded.
+                    tildes are expanded. Do not backslash spaces in path names.
                 example:
                     - /home
                     - /etc
                     - /var/log/syslog*
+                    - /home/user/path with spaces
             repositories:
                 required: true
                 seq:
@@ -123,12 +124,14 @@ map:
                     - type: str
                 desc: |
                     Any paths matching these patterns are excluded from backups.
-                    Globs and tildes are expanded. See the output of "borg help
-                    patterns" for more details.
+                    Globs and tildes are expanded. Do not backslash spaces in
+                    path names. See the output of "borg help patterns" for more
+                    details.
                 example:
                     - '*.pyc'
                     - /home/*/.cache
                     - /etc/ssl
+                    - /home/user/path with spaces
             exclude_from:
                 seq:
                     - type: str

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

@@ -68,7 +68,7 @@ sudo pip3 install --upgrade borgmatic
 
 The main downside of a global install is that borgmatic is less cleanly
 separated from the rest of your Python software, and there's the theoretical
-possibility of libary conflicts. But if you're okay with that, for instance
+possibility of library conflicts. But if you're okay with that, for instance
 on a relatively dedicated system, then a global install can work out fine.
 
 
@@ -93,7 +93,7 @@ installing borgmatic:
 
 ## Hosting providers
 
-Need somewhere to store your encrypted offsite backups? The following hosting
+Need somewhere to store your encrypted off-site backups? The following hosting
 providers include specific support for Borg/borgmatic. Using these links and
 services helps support borgmatic development and hosting. (These are referral
 links, but without any tracking scripts or cookies.)