commit cd7d2bfa208d66c1eb0eb204fbc1fd509f41755c
author Matthew Webber <matthew@unsolvable.org> Wed Oct 14 15:54:06 2015 +0100
committer David Pursehouse <david.pursehouse@sonymobile.com> Fri Jan 08 04:54:16 2016 +0000
tree 59c7936643e75647f3566ed1f42b5c6e902a32db
parent 92119baa678b36a3bfd314b6b8be97908c40cb0e

Improve documentation on commentlink.match regular expression

Bug: Issue 412
Change-Id: I2e7a7e0cc3d971d5f157be7e2f8899644d53c9de

Documentation/config-gerrit.txt

diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt
index f6aec76..e65861a 100644
--- a/Documentation/config-gerrit.txt
+++ b/Documentation/config-gerrit.txt
@@ -970,6 +970,11 @@
 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::