Add disclaimer to find-owners docs that examples use FIND_OWNERS_GLOB's
Since change Ida22f2ae8 the path expression syntax can be freely
configured. All examples of OWNERS files in the find-owners
documentation assume that FIND_OWNERS_GLOB's are used as path
expressions. Add a note about this to avoid confusion for user of
projects that use the find-owners backend with a different path
expression syntax.
Signed-off-by: Edwin Kempin <[email protected]>
Change-Id: Id00335ca07d74bc9b6b31a669f9160ec882e5da2
diff --git a/resources/Documentation/backend-find-owners.md b/resources/Documentation/backend-find-owners.md
index 21125a9..e50a05e 100644
--- a/resources/Documentation/backend-find-owners.md
+++ b/resources/Documentation/backend-find-owners.md
@@ -52,6 +52,12 @@
[restriction prefix](#restrictionPrefixes)
* a [comment](#comments)
+**NOTE:** By default the `find-owners` backend uses
+[FIND_OWNERS_GLOB's](path-expressions.html) as path expressions, but it's
+possible that a different path expression syntax is
+[configured](config.html#pluginCodeOwnersPathExpressions). All examples on this
+page assume that `FIND_OWNERS_GLOB`'s are used as path expressions.
+
### <a id="fileLevelRules">File-level rules
File-level rules apply to the entire `OWNERS` file and should not be repeated.
