mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-23 16:26:29 +00:00
Code Issues Releases Wiki Activity

docs: clarify pp pattern type

Browse source 
Fixes: #5300

This incorporates the comments from `patterns.py` into the documentation
to clarify the difference between `pp` and `pf`.
This commit is contained in:
Tommy Nguyen 2021-08-07 07:38:04 -04:00
parent 79db0b0815
commit 7639465ad4
No known key found for this signature in database
GPG key ID: 8E347123F020B734
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/usage/help.rst.inc
View file

@ -69,12 +69,15 @@ Regular expressions, selector `re:`
the re module <https://docs.python.org/3/library/re.html>`_.
Path prefix, selector `pp:`
This pattern style is useful to match whole sub-directories. The pattern
`pp:root/somedir` matches `root/somedir` and everything therein. A leading
path separator is always removed.
This pattern style matches either the whole path or an initial segment
of the path up to but not including a path separator. For consistency
with the `fn:` and `sh:` patterns, a path separator is added to the
end of the path before matching. For example, `pp:root/somedir`
matches `root/somedir` and everything therein. A leading path
separator is always removed. A trailing slash makes no difference.
Path full-match, selector `pf:`
This pattern style is (only) useful to match full paths.
This pattern style is (only) useful to match full (exact) paths.
This is kind of a pseudo pattern as it can not have any variable or
unspecified parts - the full path must be given. `pf:root/file.ext` matches
`root/file.ext` only. A leading path separator is always removed.