Merge "Documenting when different regexp libraries are used" into stable

This commit is contained in:
Shawn Pearce 2011-05-19 12:21:42 -07:00 committed by Android Code Review
commit 7ee84a14ca
4 changed files with 35 additions and 12 deletions

View File

@ -156,6 +156,10 @@ by prefixing the reference name with `\^`. For example
`\^refs/heads/[a-z]\{1,8\}` matches all lower case branch names
between 1 and 8 characters long. Within a regular expression `.`
is a wildcard matching any character, but may be escaped as `\.`.
The link:http://www.brics.dk/automaton/[dk.brics.automaton library]
is used for evaluation of regular expression access control
rules. See the library documentation for details on this
particular regular expression flavor.
References can have the current user name automatically included,
creating dynamic access controls that change to match the currently

View File

@ -115,7 +115,9 @@ List of permitted OpenID providers. A user may only authenticate
with an OpenID that matches this list. Only used if `auth.type`
was set to OpenID (the default).
+
Patterns may be either a regular expression (start with `^` and
Patterns may be either a
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
Java regular expression (java.util.regex)] (start with `^` and
end with `$`) or be a simple prefix (any other string).
+
By default, the list contains two values, `http://` and `https://`,
@ -131,7 +133,9 @@ granted to the `Anonymous Users` and `Registered Users` groups,
the user account must only have OpenIDs which match at least one
pattern from this list.
+
Patterns may be either a regular expression (start with `^` and
Patterns may be either a
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
Java regular expression (java.util.regex)] (start with `^` and
end with `$`) or be a simple prefix (any other string).
+
By default, the list contains two values, `http://` and `https://`,
@ -1855,10 +1859,12 @@ Several trakingid entries can have the same footer tag.
[[trackingid.name.match]]trackingid.<name>.match::
+
A regular expression used to match the external tracking id part of the
footer line. The match can result in several entries in the DB.
If grouping is used in the regex the first group will be interpreted
as the tracking id. Tracking ids > 20 char will be ignored.
A link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
Java regular expression (java.util.regex)] used to match the
external tracking id part of the footer line. The match can
result in several entries in the DB. If grouping is used in the
regex the first group will be interpreted as the tracking id.
Tracking ids > 20 char will be ignored.
+
The configuration file parser eats one level of backslashes, so the
character class `\s` requires `\\s` in the configuration file. The

View File

@ -34,8 +34,10 @@ In order to use permissions beyond those granted to the
`Anonymous Users` and `Registered Users` groups, an account
must only have OpenIDs which match at least one pattern from the
`auth.trustedOpenID` list in `gerrit.config`. Patterns may be
either a regular expression (must start with `^` and end with `$`)
or be a simple prefix (any other string).
either a
link:http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html[standard
Java regular expression (java.util.regex)] (must start with `^`
and end with `$`) or be a simple prefix (any other string).
Out of the box Gerrit is configured to trust two patterns, which
will match any OpenID provider on the Internet:

View File

@ -101,7 +101,10 @@ Changes where 'SHA1' is one of the patch sets of the change.
project:'PROJECT'::
+
Changes occuring in 'PROJECT'. If 'PROJECT' starts with `^` it
matches project names by regular expression.
matches project names by regular expression. The
link:http://www.brics.dk/automaton/[dk.brics.automaton
library] is used for evaluation of such patterns.
[[branch]]
branch:'BRANCH'::
@ -114,7 +117,9 @@ for 'branch:refs/heads/master' is the same as searching for
'ref:refs/heads/refs/heads/master'.
+
If 'BRANCH' starts with `^` it matches branch names by regular
expression patterns.
expression patterns. The
link:http://www.brics.dk/automaton/[dk.brics.automaton
library] is used for evaluation of such patterns.
[[topic]]
topic:'TOPIC'::
@ -124,7 +129,9 @@ often combined with 'branch:' and 'project:' operators to select
all related changes in a series.
+
If 'TOPIC' starts with `^` it matches topic names by regular
expression patterns.
expression patterns. The
link:http://www.brics.dk/automaton/[dk.brics.automaton
library] is used for evaluation of such patterns.
[[ref]]
ref:'REF'::
@ -134,7 +141,9 @@ name. Since 'REF' is absolute from the top of the repository it
must start with 'refs/'.
+
If 'REF' starts with `^` it matches reference names by regular
expression patterns.
expression patterns. The
link:http://www.brics.dk/automaton/[dk.brics.automaton
library] is used for evaluation of such patterns.
[[tr,bug]]
tr:'ID', bug:'ID'::
@ -164,6 +173,8 @@ file:^'REGEX'::
Matches any change where REGEX matches a file that was affected
by the change. The regular expression pattern must start with
`^`. For example, to match all XML files use `file:^.*\.xml$`.
The link:http://www.brics.dk/automaton/[dk.brics.automaton
library] is used for the evaluation of such patterns.
+
The `^` required at the beginning of the regular expression not only
denotes a regular expression, but it also has the usual meaning of