Improve documentation on commentlink.match regular expression

Bug: Issue 412
Change-Id: I2e7a7e0cc3d971d5f157be7e2f8899644d53c9de
This commit is contained in:
Matthew Webber
2015-10-14 15:54:06 +01:00
committed by David Pursehouse
parent 92119baa67
commit cd7d2bfa20

View File

@@ -970,6 +970,11 @@ upper and lower case character for each position must be used. For
example, to match the string `bug` in a case insensitive way the match
pattern `[bB][uU][gG]` needs to be used.
+
The regular expression pattern is applied to the HTML form of the message
in question, which means it needs to assume the data has been escaped.
So `"` needs to be matched as `&amp;quot;`, `<` as `&amp;lt;`, and `'` as
`&amp;#39;`.
+
A common pattern to match is `bug\\s+(\\d+)`.
[[commentlink.name.link]]commentlink.<name>.link::