From 7639465ad472d3dc6a48f3190ec71dd81d9d4e92 Mon Sep 17 00:00:00 2001 From: Tommy Nguyen Date: Sat, 7 Aug 2021 07:38:04 -0400 Subject: [PATCH] docs: clarify pp pattern type Fixes: #5300 This incorporates the comments from `patterns.py` into the documentation to clarify the difference between `pp` and `pf`. --- docs/usage/help.rst.inc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc index f2389c559..c636b7c03 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -69,12 +69,15 @@ Regular expressions, selector `re:` the re module `_. 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.