opendev/gerrit
Code Issues Proposed changes

Add note regarding unsupported HTML matching comment link format

Browse Source 
This style of commentlink has never been supported in PolyGerrit, and
there is no plan to support it. With this change, this style of link is
noted as such in the docs.

Change-Id: Ife8a088c0a2b6008f73a70e2e11bd4a79fe406b9
This commit is contained in:
Wyatt Allen
2017-11-09 10:46:59 -08:00
parent fcf5777a4f
commit 2d711112a1
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/config-gerrit.txt
View File

@@ -1380,10 +1380,13 @@ 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;`.
Between the GWT UI and PolyGerrit, the commentlink.name.match regular
expressions are applied differently. Whereas in the GWT UI the
expressions are applied to the formatted and escaped HTML result, the
PolyGerrit UI applies them only to the raw, unformatted and unescaped
text form. PolyGerrit does not support regex matching against HTML.
Comment link patterns that are written in this style should be updated
to match text formats.
+
A common pattern to match is `bug\\s+(\\d+)`.