Spaces in filenames do not need escapes #406

Closed
opened 2021-04-01 10:57:29 +00:00 by pocal · 2 comments

What I'm trying to do and why

Backup a directory with a space in its name

Steps to reproduce (if a bug)

Include (sanitized) borgmatic configuration files if applicable.

Actual behavior (if a bug)

Include (sanitized) --verbosity 2 output if applicable.

Expected behavior (if a bug)

This works, but I didn´t expect it to.

Other notes / implementation ideas

This is a documentation bug. I initially escaped the space (using ´\´) which gave an error. The docs say that globs and tildes are expanded, which can be misunderstood
to mean that Shell escapes are required when they aren´t. The docs should make
this clear.

Environment

borgmatic version: [version here]

Use sudo borgmatic --version or sudo pip show borgmatic | grep ^Version

borgmatic installation method: [e.g., Debian package, Docker container, etc.]

Borg version: [version here]

Use sudo borg --version

Python version: [version here]

Use python3 --version

Database version (if applicable): [version here]

Use psql --version or mysql --version on client and server.

operating system and version: [OS here]

#### What I'm trying to do and why Backup a directory with a space in its name #### Steps to reproduce (if a bug) Include (sanitized) borgmatic configuration files if applicable. #### Actual behavior (if a bug) Include (sanitized) `--verbosity 2` output if applicable. #### Expected behavior (if a bug) This works, but I didn´t expect it to. #### Other notes / implementation ideas This is a documentation bug. I initially escaped the space (using ´\´) which gave an error. The docs say that globs and tildes are expanded, which can be misunderstood to mean that Shell escapes are required when they aren´t. The docs should make this clear. #### Environment **borgmatic version:** [version here] Use `sudo borgmatic --version` or `sudo pip show borgmatic | grep ^Version` **borgmatic installation method:** [e.g., Debian package, Docker container, etc.] **Borg version:** [version here] Use `sudo borg --version` **Python version:** [version here] Use `python3 --version` **Database version (if applicable):** [version here] Use `psql --version` or `mysql --version` on client and server. **operating system and version:** [OS here]

Stumbled upon this at first as well, would be nice to add a hint to the docs or an example in the generated borgmatic config.

Stumbled upon this at first as well, would be nice to add a hint to the docs or an example in the generated borgmatic config.
Owner

Thank you both for mentioning this. It's good to hear about "minor" docs issues like this that are causing problems for folks. This should be clarified now in the generated configuration file in master, and I've updated the examples as well! (Should be deployed shortly.)

Thank you both for mentioning this. It's good to hear about "minor" docs issues like this that are causing problems for folks. This should be clarified now in the generated configuration file in `master`, and I've updated the examples as well! (Should be deployed shortly.)
Sign in to join this conversation.
No Milestone
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#406
No description provided.