Document that for system groups and external groups UUID must be used for skipGroup
Specified group names are resolved through the group index but the group
index only contains Gerrit internal groups. Hence if names of system
groups or external groups are used they cannot be resolved and the
skipGroup setting has no effect.
Change-Id: I586270aaf24eca4bdae663d060a23716f0839095
Signed-off-by: Edwin Kempin <ekempin@google.com>
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index 95c6775..e1cf169 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -307,7 +307,27 @@
Multiple values are supported.
Default: nobody is allowed to skip the rules (empty).
- NOTE: When skipGroup isn't defined, all the other skip settings are ignored.
+NOTE: When skipGroup isn't defined, all the other skip settings are ignored.
+
+NOTE: For [system groups](../../../Documentation/access-control.html#system_groups)
+and external groups (e.g.
+[LDAP groups](../../../Documentation/access-control.html#ldap_groups)) the use
+of UUIDs is required. This is because group names are resolved through the
+group index and the group index only contains Gerrit internal groups.
+
+Example for system group:
+
+```
+ [plugin "@PLUGIN@"]
+ skipGroup = global:Registered-Users
+```
+
+Example for external group:
+
+```
+ [plugin "@PLUGIN@"]
+ skipGroup = ldap:Foo
+```
plugin.@PLUGIN@.skipRef
: Ref name, pattern or regexp of the branch to skip.
