Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#6231: Clarify where paths are relative to #7737

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

jefft
Copy link

@jefft jefft commented Jul 25, 2023

A documentation patch for #6231 clarifying where include/excludes are relative to. I changed the example to have two directories, to illustrate that the first (not second) directory is used.

Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

docs/usage/help.rst.inc Outdated Show resolved Hide resolved
docs/usage/help.rst.inc Outdated Show resolved Hide resolved
Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

docs/usage/help.rst.inc Outdated Show resolved Hide resolved
docs/usage/help.rst.inc Outdated Show resolved Hide resolved
Comment on lines +29 to +31
The recursion root is also named ``PATH`` in Borg commands like `borg create`
that do a file discovery, so do not confuse the root with the ``PATH``
argument of e.g. `borg extract`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think this sentence is confusing. I'd vote for just deleting it, as I can't see how someone would confuse a recursion root with a path they want to extract. Or maybe just

Suggested change
The recursion root is also named ``PATH`` in Borg commands like `borg create`
that do a file discovery, so do not confuse the root with the ``PATH``
argument of e.g. `borg extract`.
The recursion root is named ``PATH`` in Borg commands like `borg create`
that do file discovery.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants