Marian Harbach | ebeb154 | 2019-12-13 10:42:46 +0100 | [diff] [blame] | 1 | :linkattrs: |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 2 | = Gerrit Code Review - Searching Changes |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 3 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 4 | == Default Searches |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 5 | |
| 6 | Most basic searches can be viewed by clicking on a link along the top |
| 7 | menu bar. The link will prefill the search box with a common search |
David Pursehouse | daf6dfc | 2018-03-21 16:12:50 +0900 | [diff] [blame] | 8 | query, execute it, and present the results. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 9 | |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 10 | [options="header"] |
Leopold Schabel | d0c3863 | 2022-09-19 14:36:51 +0200 | [diff] [blame] | 11 | |======================================================= |
| 12 | |Description | Default Query |
| 13 | |Changes > Open | status:open '(or is:open)' |
| 14 | |Changes > Merged | status:merged |
| 15 | |Changes > Abandoned | status:abandoned |
| 16 | |Your > Watched Changes | is:watched is:open |
| 17 | |Your > Starred Changes | is:starred |
| 18 | |Your > Draft Comments | has:draft |
| 19 | |Your > Edits | has:edit |
| 20 | |Your > All Visible Changes | is:visible |
| 21 | |Open changes in Foo | status:open project:Foo |
| 22 | |======================================================= |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 23 | |
Shawn O. Pearce | 757df06 | 2012-11-30 11:20:37 -0800 | [diff] [blame] | 24 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 25 | == Basic Change Search |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 26 | |
| 27 | Similar to many popular search engines on the web, just enter some |
| 28 | text and let Gerrit figure out the meaning: |
| 29 | |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 30 | [options="header"] |
| 31 | |============================================================= |
| 32 | |Description | Examples |
Sven Selberg | 45ca178 | 2023-01-09 08:32:27 +0000 | [diff] [blame] | 33 | |Change Id | 15183 |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 34 | |Full or abbreviated Change-Id | Ic0ff33 |
| 35 | |Full or abbreviated commit SHA-1 | d81b32ef |
| 36 | |Email address | user@example.com |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 37 | |============================================================= |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 38 | |
Sven Selberg | 45ca178 | 2023-01-09 08:32:27 +0000 | [diff] [blame] | 39 | For change searches (i.e. those using a change number, Change-Id, or commit |
Han-Wen Nienhuys | 37a1cab | 2021-04-01 12:46:00 +0200 | [diff] [blame] | 40 | SHA-1), if the search results in a single change that change will be |
David Pursehouse | bffb8c2 | 2018-03-22 11:56:26 +0900 | [diff] [blame] | 41 | presented instead of a list. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 42 | |
David Pursehouse | 36236ca | 2018-04-19 16:17:14 +0200 | [diff] [blame] | 43 | For more predictable results, use explicit search operators as described |
| 44 | in the following section. |
| 45 | |
Youssef Elghareeb | 843f218 | 2023-01-19 12:29:08 +0100 | [diff] [blame] | 46 | [IMPORTANT] |
| 47 | -- |
| 48 | The change search API is backed by a secondary index and might sometimes return |
| 49 | stale results if the re-indexing operation failed for a change update. |
| 50 | |
| 51 | Please also note that changes are not re-indexed if the project configuration |
| 52 | is updated with newly added or modified |
| 53 | link:config-submit-requirements.html[submit requirements]. |
| 54 | -- |
| 55 | |
| 56 | |
Edwin Kempin | 1f55622 | 2015-04-22 13:24:39 +0200 | [diff] [blame] | 57 | [[search-operators]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 58 | == Search Operators |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 59 | |
| 60 | Operators act as restrictions on the search. As more operators |
| 61 | are added to the same query string, they further restrict the |
monica.dionisio | 7dfa0d2 | 2010-08-27 11:46:33 -0300 | [diff] [blame] | 62 | returned results. Search can also be performed by typing only a |
Dave Borowitz | 4c27b10 | 2014-03-25 12:38:37 -0700 | [diff] [blame] | 63 | text with no operator, which will match against a variety of fields. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 64 | |
Youssef Elghareeb | ab292f0 | 2021-11-18 15:36:54 +0100 | [diff] [blame] | 65 | Characters in operator values can be escaped by enclosing the value with |
| 66 | double quotes and escaping characters with a backslash. For example |
| 67 | `message:"This \"is\" fixing a bug"`. |
| 68 | |
Shawn O. Pearce | 51e058f6 | 2010-07-19 10:30:37 -0700 | [diff] [blame] | 69 | [[age]] |
| 70 | age:'AGE':: |
| 71 | + |
| 72 | Amount of time that has expired since the change was last updated |
| 73 | with a review comment or new patch set. The age must be specified |
Patrick Hiesel | d34b6ac | 2019-07-15 08:54:58 +0200 | [diff] [blame] | 74 | to include a unit suffix, for example `-age:2d`: |
Shawn O. Pearce | 51e058f6 | 2010-07-19 10:30:37 -0700 | [diff] [blame] | 75 | + |
| 76 | * s, sec, second, seconds |
| 77 | * m, min, minute, minutes |
| 78 | * h, hr, hour, hours |
| 79 | * d, day, days |
| 80 | * w, week, weeks (`1 week` is treated as `7 days`) |
| 81 | * mon, month, months (`1 month` is treated as `30 days`) |
| 82 | * y, year, years (`1 year` is treated as `365 days`) |
| 83 | |
Patrick Hiesel | d34b6ac | 2019-07-15 08:54:58 +0200 | [diff] [blame] | 84 | `age` can be used both forward and backward looking: `age:2d` |
| 85 | means 'everything older than 2 days' while `-age:2d` means |
| 86 | 'everything with an age of at most 2 days'. |
| 87 | |
Joerg Zieren | 82b6f4f | 2020-03-24 14:41:20 +0100 | [diff] [blame] | 88 | [[attention]] |
| 89 | attention:'USER':: |
| 90 | + |
| 91 | Changes whose attention set includes the given user. |
| 92 | |
Dave Borowitz | a0af7fe | 2014-02-11 16:43:36 -0800 | [diff] [blame] | 93 | [[before_until]] |
Edwin Kempin | 074c9c4 | 2014-03-14 14:22:33 +0100 | [diff] [blame] | 94 | before:'TIME'/until:'TIME':: |
Dave Borowitz | a0af7fe | 2014-02-11 16:43:36 -0800 | [diff] [blame] | 95 | + |
Dave Borowitz | 62c9a2c | 2014-02-24 08:20:45 -0800 | [diff] [blame] | 96 | Changes modified before the given 'TIME', inclusive. Must be in the |
| 97 | format `2006-01-02[ 15:04:05[.890][ -0700]]`; omitting the time defaults |
| 98 | to 00:00:00 and omitting the timezone defaults to UTC. |
Dave Borowitz | a0af7fe | 2014-02-11 16:43:36 -0800 | [diff] [blame] | 99 | |
| 100 | [[after_since]] |
Edwin Kempin | 074c9c4 | 2014-03-14 14:22:33 +0100 | [diff] [blame] | 101 | after:'TIME'/since:'TIME':: |
Dave Borowitz | a0af7fe | 2014-02-11 16:43:36 -0800 | [diff] [blame] | 102 | + |
Dave Borowitz | 62c9a2c | 2014-02-24 08:20:45 -0800 | [diff] [blame] | 103 | Changes modified after the given 'TIME', inclusive. Must be in the |
| 104 | format `2006-01-02[ 15:04:05[.890][ -0700]]`; omitting the time defaults |
| 105 | to 00:00:00 and omitting the timezone defaults to UTC. |
Dave Borowitz | a0af7fe | 2014-02-11 16:43:36 -0800 | [diff] [blame] | 106 | |
Marija Savtchouk | 1f1f398 | 2020-12-08 09:06:41 +0000 | [diff] [blame] | 107 | [[mergedbefore]] |
| 108 | mergedbefore:'TIME':: |
| 109 | + |
| 110 | Changes merged before the given 'TIME'. The matching behaviour is consistent |
| 111 | with `before:'TIME'`. |
| 112 | |
| 113 | [[mergedafter]] |
| 114 | mergedafter:'TIME':: |
| 115 | + |
| 116 | Changes merged after the given 'TIME'. The matching behaviour is consistent |
| 117 | with `after:'TIME'`. |
| 118 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 119 | [[change]] |
| 120 | change:'ID':: |
| 121 | + |
Sven Selberg | 45ca178 | 2023-01-09 08:32:27 +0000 | [diff] [blame] | 122 | Either a change number such as 15183, or a Change-Id from the Change-Id footer. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 123 | |
Edwin Kempin | 10b49dc | 2013-06-28 23:21:10 +0200 | [diff] [blame] | 124 | [[conflicts]] |
| 125 | conflicts:'ID':: |
| 126 | + |
Edwin Kempin | 86e8362 | 2013-07-04 09:47:13 +0200 | [diff] [blame] | 127 | Changes that conflict with change 'ID'. Change 'ID' can be specified |
Sven Selberg | 45ca178 | 2023-01-09 08:32:27 +0000 | [diff] [blame] | 128 | as a change number such as 15183, or a Change-Id from the Change-Id footer. |
Edwin Kempin | 10b49dc | 2013-06-28 23:21:10 +0200 | [diff] [blame] | 129 | |
Martin Fick | 563a3e6 | 2015-04-02 13:37:53 -0600 | [diff] [blame] | 130 | [[destination]] |
Prudhvi Akhil Alahari | 01822da | 2023-07-17 17:00:38 +0530 | [diff] [blame] | 131 | destination:'[name=]NAME[,user=USER|,group=GROUP]':: |
Martin Fick | 563a3e6 | 2015-04-02 13:37:53 -0600 | [diff] [blame] | 132 | + |
Prudhvi Akhil Alahari | 01822da | 2023-07-17 17:00:38 +0530 | [diff] [blame] | 133 | Changes which match the specified USER's or GROUP's destination named 'NAME'. |
| 134 | If 'USER' is unspecified, the current user is used. The named destinations can |
| 135 | be publicly accessible by other users. |
| 136 | The value may be wrapped in double quotes to include spaces. For example, |
| 137 | `destination:"myreviews,group=My Group"` |
Martin Fick | 563a3e6 | 2015-04-02 13:37:53 -0600 | [diff] [blame] | 138 | (see link:user-named-destinations.html[Named Destinations]). |
| 139 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 140 | [[owner]] |
Shawn Pearce | f5c67c1 | 2013-11-25 10:31:13 -0800 | [diff] [blame] | 141 | owner:'USER', o:'USER':: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 142 | + |
Shawn O. Pearce | 068a0d8 | 2012-04-07 14:59:11 -0700 | [diff] [blame] | 143 | Changes originally submitted by 'USER'. The special case of |
| 144 | `owner:self` will find changes owned by the caller. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 145 | |
Martin Fick | bcb5b9b | 2011-01-13 13:16:20 -0700 | [diff] [blame] | 146 | [[ownerin]] |
| 147 | ownerin:'GROUP':: |
| 148 | + |
Edwin Kempin | 28c50a4 | 2018-04-18 10:00:27 +0200 | [diff] [blame] | 149 | Changes originally submitted by a user in 'GROUP'. |
Martin Fick | bcb5b9b | 2011-01-13 13:16:20 -0700 | [diff] [blame] | 150 | |
Patrick Hiesel | ec5d10b | 2021-10-21 10:28:40 +0200 | [diff] [blame] | 151 | [[uploader]] |
| 152 | uploader:'USER':: |
| 153 | + |
| 154 | Changes where the latest patch set was uploaded by 'USER'. |
| 155 | The special case of `uploader:self` will find changes uploaded |
| 156 | by the caller. |
| 157 | |
| 158 | [[uploaderin]] |
| 159 | uploaderin:'GROUP':: |
| 160 | + |
| 161 | Changes where the latest patch set was uploaded by a user in |
| 162 | 'GROUP'. |
| 163 | |
Martin Fick | 5e5a36f | 2015-03-30 12:44:51 -0600 | [diff] [blame] | 164 | [[query]] |
Prudhvi Akhil Alahari | 32d5ba9 | 2023-07-20 22:07:50 +0530 | [diff] [blame] | 165 | query:'[name=]NAME[,user=USER|,group=GROUP]':: |
Martin Fick | 5e5a36f | 2015-03-30 12:44:51 -0600 | [diff] [blame] | 166 | + |
Prudhvi Akhil Alahari | 32d5ba9 | 2023-07-20 22:07:50 +0530 | [diff] [blame] | 167 | Changes which match the specified USER's or GROUP's query named 'NAME'. |
| 168 | If neither 'USER' nor 'GROUP' is specified, the current user is used. |
| 169 | The named queries can be publicly accessible by other users. |
| 170 | The value may be wrapped in double quotes to include spaces. For example, |
| 171 | `query:"myquery,group=My Group"` |
Martin Fick | 5e5a36f | 2015-03-30 12:44:51 -0600 | [diff] [blame] | 172 | (see link:user-named-queries.html[Named Queries]). |
| 173 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 174 | [[reviewer]] |
Shawn Pearce | f5c67c1 | 2013-11-25 10:31:13 -0800 | [diff] [blame] | 175 | reviewer:'USER', r:'USER':: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 176 | + |
Shawn O. Pearce | 068a0d8 | 2012-04-07 14:59:11 -0700 | [diff] [blame] | 177 | Changes that have been, or need to be, reviewed by 'USER'. The |
| 178 | special case of `reviewer:self` will find changes where the caller |
| 179 | has been added as a reviewer. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 180 | |
Dave Borowitz | 49267dd | 2017-02-22 15:55:13 -0500 | [diff] [blame] | 181 | [[cc]] |
| 182 | cc:'USER':: |
| 183 | + |
| 184 | Changes that have the given user CC'ed on them. The special case of `cc:self` |
| 185 | will find changes where the caller has been CC'ed. |
| 186 | |
Patrick Hiesel | a54d25c | 2017-07-13 13:13:27 +0200 | [diff] [blame] | 187 | [[revertof]] |
| 188 | revertof:'ID':: |
| 189 | + |
Sven Selberg | 45ca178 | 2023-01-09 08:32:27 +0000 | [diff] [blame] | 190 | Changes that revert the change specified by the change number. |
Patrick Hiesel | a54d25c | 2017-07-13 13:13:27 +0200 | [diff] [blame] | 191 | |
Gal Paikin | 63f23e3 | 2019-11-13 16:19:51 -0800 | [diff] [blame] | 192 | [[submissionid]] |
| 193 | submissionid:'ID':: |
| 194 | + |
| 195 | Changes that have the specified submission 'ID'. |
| 196 | |
Martin Fick | bcb5b9b | 2011-01-13 13:16:20 -0700 | [diff] [blame] | 197 | [[reviewerin]] |
| 198 | reviewerin:'GROUP':: |
| 199 | + |
Edwin Kempin | 28c50a4 | 2018-04-18 10:00:27 +0200 | [diff] [blame] | 200 | Changes that have been, or need to be, reviewed by a user in 'GROUP'. |
Martin Fick | bcb5b9b | 2011-01-13 13:16:20 -0700 | [diff] [blame] | 201 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 202 | [[commit]] |
Han-Wen Nienhuys | 37a1cab | 2021-04-01 12:46:00 +0200 | [diff] [blame] | 203 | commit:'SHA-1':: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 204 | + |
Han-Wen Nienhuys | 37a1cab | 2021-04-01 12:46:00 +0200 | [diff] [blame] | 205 | Changes where 'SHA-1' is one of the patch sets of the change. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 206 | |
| 207 | [[project]] |
Shawn Pearce | f5c67c1 | 2013-11-25 10:31:13 -0800 | [diff] [blame] | 208 | project:'PROJECT', p:'PROJECT':: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 209 | + |
Edwin Kempin | f1acbb8 | 2011-09-15 12:49:42 +0200 | [diff] [blame] | 210 | Changes occurring in 'PROJECT'. If 'PROJECT' starts with `^` it |
Magnus Bäck | e561183 | 2011-02-02 08:57:15 +0100 | [diff] [blame] | 211 | matches project names by regular expression. The |
| 212 | link:http://www.brics.dk/automaton/[dk.brics.automaton |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 213 | library,role=external,window=_blank] is used for evaluation of such patterns. |
Magnus Bäck | e561183 | 2011-02-02 08:57:15 +0100 | [diff] [blame] | 214 | |
Dave Borowitz | 4aed07b | 2014-03-25 14:17:03 -0700 | [diff] [blame] | 215 | [[projects]] |
| 216 | projects:'PREFIX':: |
| 217 | + |
| 218 | Changes occurring in projects starting with 'PREFIX'. |
| 219 | |
Prudhvi Akhil Alahari | 3593b3e | 2021-02-22 17:24:05 +0530 | [diff] [blame] | 220 | [[parentof]] |
| 221 | parentof:'ID':: |
| 222 | Changes which are parent to the change specified by 'ID'. Change 'ID' can be |
Sven Selberg | 45ca178 | 2023-01-09 08:32:27 +0000 | [diff] [blame] | 223 | specified as a change number such as 15183, or a Change-Id from the 'Change-Id' |
| 224 | footer of the commit message. This operator will return immediate parents |
Prudhvi Akhil Alahari | 3593b3e | 2021-02-22 17:24:05 +0530 | [diff] [blame] | 225 | and will not return grand parents or higher level ancestors of the given change. |
| 226 | |
Edwin Kempin | 7c0eb41 | 2013-06-28 02:05:14 +0200 | [diff] [blame] | 227 | [[parentproject]] |
| 228 | parentproject:'PROJECT':: |
| 229 | + |
| 230 | Changes occurring in 'PROJECT' or in one of the child projects of |
| 231 | 'PROJECT'. |
| 232 | |
Patrick Hiesel | 0d08afc | 2018-07-31 10:33:13 +0200 | [diff] [blame] | 233 | [[repository]] |
Edwin Kempin | c4a10ce | 2018-09-27 09:02:48 +0200 | [diff] [blame] | 234 | repository:'REPOSITORY', repo:'REPOSITORY':: |
Patrick Hiesel | 0d08afc | 2018-07-31 10:33:13 +0200 | [diff] [blame] | 235 | + |
| 236 | Changes occurring in 'REPOSITORY'. If 'REPOSITORY' starts with `^` it |
| 237 | matches repository names by regular expression. The |
| 238 | link:http://www.brics.dk/automaton/[dk.brics.automaton |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 239 | library,role=external,window=_blank] is used for evaluation of such patterns. |
Patrick Hiesel | 0d08afc | 2018-07-31 10:33:13 +0200 | [diff] [blame] | 240 | |
| 241 | [[repositories]] |
Edwin Kempin | c4a10ce | 2018-09-27 09:02:48 +0200 | [diff] [blame] | 242 | repositories:'PREFIX', repos:'PREFIX':: |
Patrick Hiesel | 0d08afc | 2018-07-31 10:33:13 +0200 | [diff] [blame] | 243 | + |
| 244 | Changes occurring in repositories starting with 'PREFIX'. |
| 245 | |
| 246 | [[parentrepository]] |
Edwin Kempin | c4a10ce | 2018-09-27 09:02:48 +0200 | [diff] [blame] | 247 | parentrepository:'REPOSITORY', parentrepo:'REPOSITORY':: |
Patrick Hiesel | 0d08afc | 2018-07-31 10:33:13 +0200 | [diff] [blame] | 248 | + |
| 249 | Changes occurring in 'REPOSITORY' or in one of the child repositories of |
| 250 | 'REPOSITORY'. |
| 251 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 252 | [[branch]] |
| 253 | branch:'BRANCH':: |
| 254 | + |
Edwin Kempin | ad921cd | 2012-03-27 16:00:56 +0200 | [diff] [blame] | 255 | Changes for 'BRANCH'. The branch name is either the short name shown |
| 256 | in the web interface or the full name of the destination branch with |
| 257 | the traditional 'refs/heads/' prefix. |
Shawn O. Pearce | 082ed41 | 2010-08-28 12:38:32 -0700 | [diff] [blame] | 258 | + |
| 259 | If 'BRANCH' starts with `^` it matches branch names by regular |
Magnus Bäck | e561183 | 2011-02-02 08:57:15 +0100 | [diff] [blame] | 260 | expression patterns. The |
| 261 | link:http://www.brics.dk/automaton/[dk.brics.automaton |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 262 | library,role=external,window=_blank] is used for evaluation of such patterns. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 263 | |
Dave Borowitz | c751799 | 2015-06-01 10:00:04 -0700 | [diff] [blame] | 264 | [[intopic]] |
| 265 | intopic:'TOPIC':: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 266 | + |
Stefan Beller | f89a959 | 2015-05-29 11:37:37 -0700 | [diff] [blame] | 267 | Changes whose designated topic contains 'TOPIC', using a full-text search. |
Shawn O. Pearce | 082ed41 | 2010-08-28 12:38:32 -0700 | [diff] [blame] | 268 | + |
| 269 | If 'TOPIC' starts with `^` it matches topic names by regular |
Magnus Bäck | e561183 | 2011-02-02 08:57:15 +0100 | [diff] [blame] | 270 | expression patterns. The |
| 271 | link:http://www.brics.dk/automaton/[dk.brics.automaton |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 272 | library,role=external,window=_blank] is used for evaluation of such patterns. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 273 | |
Dave Borowitz | c751799 | 2015-06-01 10:00:04 -0700 | [diff] [blame] | 274 | [[topic]] |
| 275 | topic:'TOPIC':: |
Stefan Beller | f89a959 | 2015-05-29 11:37:37 -0700 | [diff] [blame] | 276 | + |
| 277 | Changes whose designated topic matches 'TOPIC' exactly. This is |
| 278 | often combined with 'branch:' and 'project:' operators to select |
| 279 | all related changes in a series. |
| 280 | |
Gal Paikin | c3e6ddc | 2021-12-28 12:42:45 +0100 | [diff] [blame] | 281 | [[prefixtopic]] |
| 282 | prefixtopic:'TOPIC':: |
| 283 | + |
| 284 | Changes whose designated topic start with 'TOPIC'. |
| 285 | |
Patrick Hiesel | 279bb47 | 2021-03-05 15:19:47 +0100 | [diff] [blame] | 286 | [[inhashtag]] |
| 287 | inhashtag:'HASHTAG':: |
| 288 | + |
| 289 | Changes where any hashtag contains 'HASHTAG', using a full-text search. |
| 290 | + |
| 291 | If 'HASHTAG' starts with `^` it matches hashtag names by regular |
| 292 | expression patterns. The |
| 293 | link:http://www.brics.dk/automaton/[dk.brics.automaton |
| 294 | library,role=external,window=_blank] is used for evaluation of such patterns. |
| 295 | |
Dave Borowitz | 223f73c | 2018-03-15 10:35:29 -0400 | [diff] [blame] | 296 | [[hashtag]] |
| 297 | hashtag:'HASHTAG':: |
| 298 | + |
David Pursehouse | d2ca2b1 | 2019-03-07 09:52:28 +0900 | [diff] [blame] | 299 | Changes whose link:intro-user.html#hashtags[hashtag] matches 'HASHTAG'. |
| 300 | The match is case-insensitive. |
Dave Borowitz | 223f73c | 2018-03-15 10:35:29 -0400 | [diff] [blame] | 301 | |
Gal Paikin | c3e6ddc | 2021-12-28 12:42:45 +0100 | [diff] [blame] | 302 | [[prefixhashtag]] |
| 303 | prefixhashtag:'HASHTAG':: |
| 304 | + |
| 305 | Changes whose link:intro-user.html#hashtags[hashtag] start with 'HASHTAG'. |
| 306 | The match is case-insensitive. |
| 307 | |
Kaushik Lingarkar | 4a711ed | 2019-11-12 13:53:29 -0800 | [diff] [blame] | 308 | [[cherrypickof]] |
| 309 | cherrypickof:'CHANGE[,PATCHSET]':: |
| 310 | + |
| 311 | Changes which were created using the 'cherry-pick' functionality and |
| 312 | whose source change number matches 'CHANGE' and source patchset number |
| 313 | matches 'PATCHSET'. Note that 'PATCHSET' is optional. For example, a |
| 314 | `cherrypickof:12345` matches all changes which were cherry-picked from |
| 315 | change 12345 and `cherrypickof:12345,2` matches all changes which were |
| 316 | cherry-picked from the 2nd patchset of change 12345. |
| 317 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 318 | [[ref]] |
| 319 | ref:'REF':: |
| 320 | + |
| 321 | Changes where the destination branch is exactly the given 'REF' |
| 322 | name. Since 'REF' is absolute from the top of the repository it |
| 323 | must start with 'refs/'. |
Shawn O. Pearce | 082ed41 | 2010-08-28 12:38:32 -0700 | [diff] [blame] | 324 | + |
| 325 | If 'REF' starts with `^` it matches reference names by regular |
Magnus Bäck | e561183 | 2011-02-02 08:57:15 +0100 | [diff] [blame] | 326 | expression patterns. The |
| 327 | link:http://www.brics.dk/automaton/[dk.brics.automaton |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 328 | library,role=external,window=_blank] is used for evaluation of such patterns. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 329 | |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 330 | [[tr,bug]] |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 331 | tr:'ID', bug:'ID':: |
| 332 | + |
David Pursehouse | 221d4f6 | 2012-06-08 17:38:08 +0900 | [diff] [blame] | 333 | Search for changes whose commit message contains 'ID' and matches |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 334 | one or more of the |
| 335 | link:config-gerrit.html#trackingid[trackingid sections] |
| 336 | in the server's configuration file. This is typically used to |
| 337 | search for changes that fix a bug or defect by the issue tracking |
| 338 | system's issue identifier. |
| 339 | |
| 340 | [[label]] |
| 341 | label:'VALUE':: |
| 342 | + |
| 343 | Matches changes where the approval score 'VALUE' has been set during |
| 344 | a review. See <<labels,labels>> below for more detail on the format |
| 345 | of the argument. |
| 346 | |
monica.dionisio | 70a7ca0 | 2010-08-25 14:46:13 -0300 | [diff] [blame] | 347 | [[message]] |
Thiago Perrotta | 4daf87e | 2023-11-07 16:20:11 +0100 | [diff] [blame] | 348 | message:'MESSAGE'::, m:'MESSAGE'::, description:'MESSAGE'::, d:'MESSAGE':: |
monica.dionisio | 70a7ca0 | 2010-08-25 14:46:13 -0300 | [diff] [blame] | 349 | + |
David Pursehouse | 221d4f6 | 2012-06-08 17:38:08 +0900 | [diff] [blame] | 350 | Changes that match 'MESSAGE' arbitrary string in the commit message body. |
Patrick Hiesel | cef4afe | 2022-02-21 16:18:45 +0100 | [diff] [blame] | 351 | By default full text matching is used, but regular expressions can be |
| 352 | enabled by starting with `^`. |
| 353 | The link:http://www.brics.dk/automaton/[dk.brics.automaton library,role=external,window=_blank] |
Thomas Draebing | 0648b5f | 2022-09-16 09:25:55 +0200 | [diff] [blame] | 354 | is used for the evaluation of such patterns. Note, that searching with |
| 355 | regular expressions is limited to the first 32766 bytes of the |
| 356 | commit message due to limitations in Lucene. |
monica.dionisio | 70a7ca0 | 2010-08-25 14:46:13 -0300 | [diff] [blame] | 357 | |
Edwin Kempin | cf2d109 | 2022-12-16 14:01:49 +0100 | [diff] [blame] | 358 | [[subject]] |
| 359 | subject:'SUBJECT':: |
| 360 | + |
| 361 | Changes that have a commit message where the first line (aka the subject) |
| 362 | matches 'SUBJECT'. The matching is done by full text search over the subject. |
| 363 | |
Edwin Kempin | 115eb6de | 2022-12-16 13:16:03 +0100 | [diff] [blame] | 364 | [[prefixsubject]] |
| 365 | prefixsubject:'PREFIX':: |
| 366 | + |
| 367 | Changes that have a commit message where the first line (aka the subject) |
| 368 | has the prefix 'PREFIX'. |
| 369 | |
Shawn Pearce | 3ffbd1b | 2013-09-13 14:11:07 -0700 | [diff] [blame] | 370 | [[comment]] |
| 371 | comment:'TEXT':: |
| 372 | + |
| 373 | Changes that match 'TEXT' string in any comment left by a reviewer. |
| 374 | |
Dave Borowitz | 64e0b07 | 2013-12-27 11:38:01 -0800 | [diff] [blame] | 375 | [[path]] |
| 376 | path:'PATH':: |
Shawn O. Pearce | 50756b9 | 2010-07-19 17:58:25 -0700 | [diff] [blame] | 377 | + |
Shawn Pearce | f5c67c1 | 2013-11-25 10:31:13 -0800 | [diff] [blame] | 378 | Matches any change touching file at 'PATH'. By default exact path |
| 379 | matching is used, but regular expressions can be enabled by starting |
Paul Fertser | 9914375 | 2021-08-23 10:34:51 +0000 | [diff] [blame] | 380 | with `^`. For example, to match all XML files use `file:"^.*\.xml$"`. |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 381 | The link:http://www.brics.dk/automaton/[dk.brics.automaton library,role=external,window=_blank] |
Shawn Pearce | f5c67c1 | 2013-11-25 10:31:13 -0800 | [diff] [blame] | 382 | is used for the evaluation of such patterns. |
rafael.rabelosilva | aa5bca7 | 2010-08-26 11:04:53 +0200 | [diff] [blame] | 383 | + |
Ben Rohlfs | b2c411c | 2023-03-27 09:46:42 +0200 | [diff] [blame] | 384 | Note that the Gerrit host may not support regular expression search. |
| 385 | You will then see an error dialog when using expressions starting with |
| 386 | `^`. |
| 387 | + |
Karsten Dambekalns | a7f72a2 | 2011-03-25 14:21:59 +0100 | [diff] [blame] | 388 | The `^` required at the beginning of the regular expression not only |
rafael.rabelosilva | aa5bca7 | 2010-08-26 11:04:53 +0200 | [diff] [blame] | 389 | denotes a regular expression, but it also has the usual meaning of |
| 390 | anchoring the match to the start of the string. To match all Java |
| 391 | files, use `file:^.*\.java`. |
| 392 | + |
Edwin Kempin | cdb0e00 | 2011-09-08 14:23:30 +0200 | [diff] [blame] | 393 | The entire regular expression pattern, including the `^` character, |
Hong Xu | f0e245c | 2022-04-30 01:20:30 +0000 | [diff] [blame] | 394 | can be double quoted. For example, to match all XML |
rafael.rabelosilva | aa5bca7 | 2010-08-26 11:04:53 +0200 | [diff] [blame] | 395 | files named like 'name1.xml', 'name2.xml', and 'name3.xml' use |
Edwin Kempin | cdb0e00 | 2011-09-08 14:23:30 +0200 | [diff] [blame] | 396 | `file:"^name[1-3].xml"`. |
Edwin Kempin | a6289ca | 2019-01-29 12:05:09 +0100 | [diff] [blame] | 397 | + |
| 398 | Slash ('/') is used path separator. |
Marco Miller | f6bde27 | 2020-10-30 10:44:18 -0400 | [diff] [blame] | 399 | + |
Sven Selberg | 8218b2b | 2021-08-20 10:55:33 +0200 | [diff] [blame] | 400 | *More examples:* |
| 401 | |
Hong Xu | f0e245c | 2022-04-30 01:20:30 +0000 | [diff] [blame] | 402 | * `-path:^path/.*` - changes that do not modify files from `path/`. |
| 403 | * `path:{^~(path/.*)}` - changes that modify files not from `path/` (but may |
Vitaliy Lotorev | e8f6fc9 | 2020-05-26 19:58:14 +0000 | [diff] [blame] | 404 | contain files from `path/`). |
Shawn O. Pearce | 50756b9 | 2010-07-19 17:58:25 -0700 | [diff] [blame] | 405 | |
Dave Borowitz | 64e0b07 | 2013-12-27 11:38:01 -0800 | [diff] [blame] | 406 | [[file]] |
| 407 | file:'NAME', f:'NAME':: |
| 408 | + |
| 409 | Matches any change touching a file containing the path component |
| 410 | 'NAME'. For example a `file:src` will match changes that modify |
| 411 | files named `gerrit-server/src/main/java/Foo.java`. Name matching |
| 412 | is exact match, `file:Foo.java` finds any change touching a file |
| 413 | named exactly `Foo.java` and does not match `AbstractFoo.java`. |
| 414 | + |
| 415 | Regular expression matching can be enabled by starting the string |
| 416 | with `^`. In this mode `file:` is an alias of `path:` (see above). |
| 417 | |
Dave Borowitz | e939693 | 2019-01-11 11:42:56 -0800 | [diff] [blame] | 418 | [[extension]] |
| 419 | extension:'EXT', ext:'EXT':: |
| 420 | + |
| 421 | Matches any change touching a file with extension 'EXT', case-insensitive. The |
| 422 | extension is defined as the portion of the filename following the final `.`. |
Edwin Kempin | e8079ce | 2019-01-29 12:15:37 +0100 | [diff] [blame] | 423 | Files with no `.` in their name have no extension and can be matched by an |
| 424 | empty string. |
Dave Borowitz | e939693 | 2019-01-11 11:42:56 -0800 | [diff] [blame] | 425 | |
Edwin Kempin | 2b2f389 | 2019-01-25 10:34:07 +0100 | [diff] [blame] | 426 | [[onlyextensions]] |
| 427 | onlyextensions:'EXT_LIST', onlyexts:'EXT_LIST':: |
| 428 | + |
| 429 | Matches any change touching only files with extensions that are listed in |
| 430 | 'EXT_LIST' (comma-separated list). The matching is done case-insensitive. |
| 431 | An extension is defined as the portion of the filename following the final `.`. |
| 432 | Files with no `.` in their name have no extension and can be matched by an |
| 433 | empty string. |
| 434 | |
Edwin Kempin | 0e88d5d | 2019-01-25 15:20:52 +0100 | [diff] [blame] | 435 | [[directory]] |
| 436 | directory:'DIR', dir:'DIR':: |
| 437 | + |
| 438 | Matches any change where the current patch set touches a file in the directory |
| 439 | 'DIR'. The matching is done case-insensitive. 'DIR' can be a full directory |
| 440 | name, a directory prefix or any combination of intermediate directory segments. |
| 441 | E.g. a change that touches a file in the directory 'a/b/c' matches for 'a/b/c', |
| 442 | 'a', 'a/b', 'b', 'b/c' and 'c'. |
| 443 | + |
| 444 | Slash ('/') is used path separator. Leading and trailing slashes are allowed |
| 445 | but are not mandatory. |
Edwin Kempin | 0ae48b3 | 2019-01-29 17:15:09 +0100 | [diff] [blame] | 446 | + |
| 447 | If 'DIR' starts with `^` it matches directories and directory segments by |
| 448 | regular expression. The link:http://www.brics.dk/automaton/[dk.brics.automaton |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 449 | library,role=external,window=_blank] is used for evaluation of such patterns. |
Edwin Kempin | 0e88d5d | 2019-01-25 15:20:52 +0100 | [diff] [blame] | 450 | |
Edwin Kempin | fa2a826d | 2019-05-20 13:33:54 +0200 | [diff] [blame] | 451 | [[footer-operator]] |
Edwin Kempin | f148c79 | 2019-01-28 10:24:13 +0100 | [diff] [blame] | 452 | footer:'FOOTER':: |
| 453 | + |
| 454 | Matches any change that has 'FOOTER' as footer in the commit message of the |
| 455 | current patch set. 'FOOTER' can be specified verbatim ('<key>: <value>', must |
| 456 | be quoted) or as '<key>=<value>'. The matching is done case-insensitive. |
| 457 | |
Patrick Hiesel | b0701ee | 2022-02-01 13:34:10 +0100 | [diff] [blame] | 458 | [[hasfooter-operator]] |
| 459 | hasfooter:'FOOTERNAME':: |
| 460 | + |
| 461 | Matches any change that has a commit message with a footer where the footer |
| 462 | name is equal to 'FOOTERNAME'.The matching is done case-sensitive. |
| 463 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 464 | [[has]] |
| 465 | has:draft:: |
| 466 | + |
| 467 | True if there is a draft comment saved by the current user. |
| 468 | |
Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 469 | [[has-star]] |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 470 | has:star:: |
| 471 | + |
Chris Poucet | 79b89e2 | 2022-08-23 14:54:13 +0000 | [diff] [blame] | 472 | Same as 'is:starred', true if the change has been starred by the current user |
| 473 | with the default label. |
Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 474 | |
David Ostrovsky | 9952870 | 2015-04-30 23:48:35 +0200 | [diff] [blame] | 475 | has:edit:: |
| 476 | + |
| 477 | True if the change has inline edit created by the current user. |
| 478 | |
Changcheng Xiao | 81c4809 | 2017-02-08 13:04:07 +0100 | [diff] [blame] | 479 | has:unresolved:: |
| 480 | + |
| 481 | True if the change has unresolved comments. |
| 482 | |
Paladox none | a9c9b04 | 2021-08-04 07:04:41 +0000 | [diff] [blame] | 483 | has:attention:: |
| 484 | + |
| 485 | True if the change has attention by the current user. |
| 486 | |
| 487 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 488 | [[is]] |
Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 489 | [[is-starred]] |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 490 | is:starred:: |
| 491 | + |
| 492 | Same as 'has:star', true if the change has been starred by the |
Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 493 | current user with the default label. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 494 | |
Paladox none | a9c9b04 | 2021-08-04 07:04:41 +0000 | [diff] [blame] | 495 | is:attention:: |
| 496 | + |
| 497 | True if the change has attention by the current user. |
| 498 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 499 | is:watched:: |
| 500 | + |
| 501 | True if this change matches one of the current user's watch filters, |
| 502 | and thus is likely to notify the user when it updates. |
| 503 | |
| 504 | is:reviewed:: |
| 505 | + |
Dave Borowitz | 8ee50e7 | 2015-05-25 19:34:34 -0700 | [diff] [blame] | 506 | True if any user has commented on the change more recently than the |
| 507 | last update (comment or patch set) from the change owner. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 508 | |
Shawn O. Pearce | 068a0d8 | 2012-04-07 14:59:11 -0700 | [diff] [blame] | 509 | is:owner:: |
| 510 | + |
| 511 | True on any change where the current user is the change owner. |
| 512 | Same as `owner:self`. |
| 513 | |
Patrick Hiesel | ec5d10b | 2021-10-21 10:28:40 +0200 | [diff] [blame] | 514 | is:uploader:: |
| 515 | + |
| 516 | True on any change where the current user is the uploader of |
| 517 | the latest patch set. |
| 518 | Same as `uploader:self`. |
| 519 | |
Shawn O. Pearce | 068a0d8 | 2012-04-07 14:59:11 -0700 | [diff] [blame] | 520 | is:reviewer:: |
| 521 | + |
| 522 | True on any change where the current user is a reviewer. |
| 523 | Same as `reviewer:self`. |
| 524 | |
David Pursehouse | d58e473 | 2018-04-16 11:56:44 +0200 | [diff] [blame] | 525 | is:cc:: |
| 526 | + |
| 527 | True on any change where the current user is in CC. |
| 528 | Same as `cc:self`. |
| 529 | |
David Pursehouse | e3eccbd | 2019-08-30 16:44:35 +0900 | [diff] [blame] | 530 | is:open, is:pending, is:new:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 531 | + |
Shawn Pearce | 80fa0b6 | 2015-09-04 16:28:50 -0700 | [diff] [blame] | 532 | True if the change is open. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 533 | |
| 534 | is:closed:: |
| 535 | + |
| 536 | True if the change is either merged or abandoned. |
| 537 | |
Stefan Beller | 7bf178c4 | 2016-03-07 11:15:26 -0800 | [diff] [blame] | 538 | is:merged, is:abandoned:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 539 | + |
| 540 | Same as <<status,status:'STATE'>>. |
| 541 | |
Youssef Elghareeb | 84bcb6a | 2022-01-14 11:41:53 +0100 | [diff] [blame] | 542 | [[is-submittable]] |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 543 | is:submittable:: |
| 544 | + |
| 545 | True if the change is submittable according to the submit rules for |
| 546 | the project, for example if all necessary labels have been voted on. |
| 547 | + |
| 548 | This operator only takes into account one change at a time, not any |
| 549 | related changes, and does not guarantee that the submit button will |
| 550 | appear for matching changes. To check whether a submit button appears, |
| 551 | use the |
| 552 | link:rest-api-changes.html#get-revision-actions[Get Revision Actions] |
| 553 | API. |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 554 | |
Edwin Kempin | 6076b7a | 2014-05-14 14:52:16 +0200 | [diff] [blame] | 555 | [[mergeable]] |
Edwin Kempin | cfd5d25 | 2013-11-22 16:53:09 +0100 | [diff] [blame] | 556 | is:mergeable:: |
| 557 | + |
| 558 | True if the change has no merge conflicts and could be merged into its |
| 559 | destination branch. |
Saša Živkov | a803593 | 2017-03-21 17:37:29 +0100 | [diff] [blame] | 560 | + |
| 561 | Mergeability of abandoned changes is not computed. This operator will |
| 562 | not find any abandoned but mergeable changes. |
Patrick Hiesel | 493875f | 2020-03-02 15:09:21 +0100 | [diff] [blame] | 563 | + |
| 564 | This operator only works if Gerrit indexes 'mergeable'. See |
Vitaliy L. | 98ef454 | 2022-07-11 09:19:04 +0000 | [diff] [blame] | 565 | link:config-gerrit.html#change.mergeabilityComputationBehavior[change.mergeabilityComputationBehavior] |
Patrick Hiesel | 493875f | 2020-03-02 15:09:21 +0100 | [diff] [blame] | 566 | for details. |
Edwin Kempin | cfd5d25 | 2013-11-22 16:53:09 +0100 | [diff] [blame] | 567 | |
Edwin Kempin | 98ddc8a | 2017-02-21 11:56:08 +0100 | [diff] [blame] | 568 | [[private]] |
| 569 | is:private:: |
| 570 | + |
| 571 | True if the change is private, ie. only visible to owner and its |
| 572 | reviewers. |
| 573 | |
David Ostrovsky | 6cfcb37 | 2017-02-26 09:57:41 +0100 | [diff] [blame] | 574 | [[workInProgress]] |
| 575 | is:wip:: |
| 576 | + |
| 577 | True if the change is Work In Progress. |
| 578 | |
Saša Živkov | 71fd998 | 2015-11-04 15:12:34 +0100 | [diff] [blame] | 579 | [[merge]] |
| 580 | is:merge:: |
| 581 | + |
| 582 | True if the change is a merge commit. |
| 583 | |
Adithya Chakilam | b568ec3 | 2021-09-08 19:00:22 -0500 | [diff] [blame] | 584 | [[cherrypick]] |
| 585 | is:cherrypick:: |
| 586 | + |
| 587 | True if the change is a cherrypick of an another change. |
| 588 | |
| 589 | This is limited to changes which are cherrypicked using REST API |
| 590 | or WebUI only. It is not able to identify changes which are |
| 591 | cherry-picked locally using the git cherry-pick command and then |
| 592 | pushed to Gerrit. |
| 593 | |
Youssef Elghareeb | e9d30ae | 2021-10-26 14:07:49 +0200 | [diff] [blame] | 594 | [[pure-revert]] |
| 595 | is:pure-revert:: |
| 596 | + |
| 597 | True if the change is a pure revert. |
| 598 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 599 | [[status]] |
David Pursehouse | e3eccbd | 2019-08-30 16:44:35 +0900 | [diff] [blame] | 600 | status:open, status:pending, status:new:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 601 | + |
Shawn Pearce | 80fa0b6 | 2015-09-04 16:28:50 -0700 | [diff] [blame] | 602 | True if the change state is 'review in progress'. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 603 | |
| 604 | status:reviewed:: |
| 605 | + |
Dave Borowitz | 8ee50e7 | 2015-05-25 19:34:34 -0700 | [diff] [blame] | 606 | Same as 'is:reviewed', matches if any user has commented on the change |
| 607 | more recently than the last update (comment or patch set) from the |
| 608 | change owner. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 609 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 610 | status:closed:: |
| 611 | + |
| 612 | True if the change is either 'merged' or 'abandoned'. |
| 613 | |
| 614 | status:merged:: |
| 615 | + |
| 616 | Change has been merged into the branch. |
| 617 | |
| 618 | status:abandoned:: |
| 619 | + |
Edwin Kempin | 4c903b8 | 2012-06-13 16:06:07 +0200 | [diff] [blame] | 620 | Change has been abandoned. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 621 | |
Jeff Davidson | 45d0a77 | 2014-05-21 18:48:33 -0700 | [diff] [blame] | 622 | [[size]] |
| 623 | added:'RELATION''LINES', deleted:'RELATION''LINES', delta/size:'RELATION''LINES':: |
| 624 | + |
| 625 | True if the number of lines added/deleted/changed satisfies the given relation |
| 626 | for the given number of lines. |
| 627 | + |
| 628 | For example, added:>50 will be true for any change which adds at least 50 |
| 629 | lines. |
| 630 | + |
Vitaliy Lotorev | c2285a8 | 2020-10-13 20:13:39 +0000 | [diff] [blame] | 631 | Valid relations are >=, >, \<=, <, or no relation, which will match if the |
Jeff Davidson | 45d0a77 | 2014-05-21 18:48:33 -0700 | [diff] [blame] | 632 | number of lines is exactly equal. |
| 633 | |
Dave Borowitz | e6e14b9 | 2015-03-09 12:36:23 -0700 | [diff] [blame] | 634 | [[commentby]] |
| 635 | commentby:'USER':: |
| 636 | + |
| 637 | Changes containing a top-level or inline comment by 'USER'. The special |
| 638 | case of `commentby:self` will find changes where the caller has |
Youssef Elghareeb | af90578 | 2022-10-05 14:34:23 +0200 | [diff] [blame] | 639 | commented. Note that setting a vote is also considered as a comment. |
Dave Borowitz | e6e14b9 | 2015-03-09 12:36:23 -0700 | [diff] [blame] | 640 | |
Dave Borowitz | 657aa4d | 2015-03-09 15:00:14 -0700 | [diff] [blame] | 641 | [[from]] |
| 642 | from:'USER':: |
| 643 | + |
| 644 | Changes containing a top-level or inline comment by 'USER', or owned by |
| 645 | 'USER'. Equivalent to `(owner:USER OR commentby:USER)`. |
| 646 | |
Dave Borowitz | 8ee50e7 | 2015-05-25 19:34:34 -0700 | [diff] [blame] | 647 | [[reviewedby]] |
| 648 | reviewedby:'USER':: |
| 649 | + |
| 650 | Changes where 'USER' has commented on the change more recently than the |
| 651 | last update (comment or patch set) from the change owner. |
| 652 | |
David Pursehouse | cf43e17 | 2015-08-03 16:18:04 +0900 | [diff] [blame] | 653 | [[author]] |
Edwin Kempin | 42d5e93 | 2023-03-28 09:12:01 +0200 | [diff] [blame] | 654 | author:'AUTHOR', a:'AUTHOR':: |
David Pursehouse | cf43e17 | 2015-08-03 16:18:04 +0900 | [diff] [blame] | 655 | + |
| 656 | Changes where 'AUTHOR' is the author of the current patch set. 'AUTHOR' may be |
Orgad Shaneh | 71cff00 | 2021-08-11 14:13:09 +0300 | [diff] [blame] | 657 | the author's exact email address, or part of the name or email address. The |
| 658 | special case of `author:self` will find changes authored by the caller. |
David Pursehouse | cf43e17 | 2015-08-03 16:18:04 +0900 | [diff] [blame] | 659 | |
| 660 | [[committer]] |
| 661 | committer:'COMMITTER':: |
| 662 | + |
| 663 | Changes where 'COMMITTER' is the committer of the current patch set. |
| 664 | 'COMMITTER' may be the committer's exact email address, or part of the name or |
Orgad Shaneh | 71cff00 | 2021-08-11 14:13:09 +0300 | [diff] [blame] | 665 | email address. The special case of `committer:self` will find changes committed |
| 666 | by the caller. |
| 667 | |
Youssef Elghareeb | 0f67b81 | 2021-08-30 14:16:08 +0200 | [diff] [blame] | 668 | [[rule]] |
| 669 | rule:'SUBMIT_RULE_NAME':: |
| 670 | + |
| 671 | Changes where 'SUBMIT_RULE_NAME' returns a submit record with status in {OK, |
| 672 | FORCED}. This means that the submit rule has passed and is not blocking the |
| 673 | change submission. 'SUBMIT_RULE_NAME' should be in the form of |
| 674 | '$plugin_name~$rule_name'. For gerrit core rules, 'SUBMIT_RULE_NAME' should |
Youssef Elghareeb | 7032f99 | 2022-01-19 15:48:48 +0100 | [diff] [blame] | 675 | be in the form of 'gerrit~$rule_name' (example: `gerrit~DefaultSubmitRule`). |
Youssef Elghareeb | 0f67b81 | 2021-08-30 14:16:08 +0200 | [diff] [blame] | 676 | |
| 677 | rule:'SUBMIT_RULE_NAME'='STATUS':: |
| 678 | + |
| 679 | Changes where 'SUBMIT_RULE_NAME' returns a submit record with status equals to |
| 680 | 'STATUS'. The status can be any of the statuses that are documented for the |
| 681 | `status` field of link:rest-api-changes.html#submit-record[SubmitRecord]. |
| 682 | |
Changcheng Xiao | 81c4809 | 2017-02-08 13:04:07 +0100 | [diff] [blame] | 683 | [[unresolved]] |
| 684 | unresolved:'RELATION''NUMBER':: |
| 685 | + |
| 686 | True if the number of unresolved comments satisfies the given relation for the given number. |
| 687 | + |
| 688 | For example, unresolved:>0 will be true for any change which has at least one unresolved |
| 689 | comment while unresolved:0 will be true for any change which has all comments resolved. |
| 690 | + |
Vitaliy Lotorev | c2285a8 | 2020-10-13 20:13:39 +0000 | [diff] [blame] | 691 | Valid relations are >=, >, \<=, <, or no relation, which will match if the number of unresolved |
Changcheng Xiao | 81c4809 | 2017-02-08 13:04:07 +0100 | [diff] [blame] | 692 | comments is exactly equal. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 693 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 694 | == Argument Quoting |
Shawn O. Pearce | 757df06 | 2012-11-30 11:20:37 -0800 | [diff] [blame] | 695 | |
| 696 | Operator values that are not bare words (roughly A-Z, a-z, 0-9, @, |
David Pursehouse | 9246356 | 2013-06-24 10:16:28 +0900 | [diff] [blame] | 697 | hyphen, dot and underscore) must be quoted for the query parser. |
Shawn O. Pearce | 757df06 | 2012-11-30 11:20:37 -0800 | [diff] [blame] | 698 | |
| 699 | Quoting is accepted as either double quotes |
| 700 | (e.g. `message:"the value"`) or as matched |
| 701 | curly braces (e.g. `message:{the value}`). |
| 702 | |
| 703 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 704 | == Boolean Operators |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 705 | |
| 706 | Unless otherwise specified, operators are joined using the `AND` |
| 707 | boolean operator, thereby restricting the search results. |
| 708 | |
David Pursehouse | 9246356 | 2013-06-24 10:16:28 +0900 | [diff] [blame] | 709 | Parentheses can be used to force a particular precedence on complex |
| 710 | operator expressions, otherwise OR has higher precedence than AND. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 711 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 712 | === Negation |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 713 | Any operator can be negated by prefixing it with `-`, for example |
| 714 | `-is:starred` is the exact opposite of `is:starred` and will |
| 715 | therefore return changes that are *not* starred by the current user. |
| 716 | |
Patrick Hiesel | 56aaf26 | 2022-05-03 12:01:27 +0200 | [diff] [blame] | 717 | The operator `NOT` (in all caps) or `not` (all lower case) is a |
| 718 | synonym. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 719 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 720 | === AND |
Patrick Hiesel | 56aaf26 | 2022-05-03 12:01:27 +0200 | [diff] [blame] | 721 | The boolean operator `AND` (in all caps) or `and` (all lower case) |
| 722 | can be used to join two other operators together. This results in |
| 723 | a restriction of the results, returning only changes that match both |
| 724 | operators. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 725 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 726 | === OR |
Patrick Hiesel | 56aaf26 | 2022-05-03 12:01:27 +0200 | [diff] [blame] | 727 | The boolean operator `OR` (in all caps) or `or` (all lower case) |
| 728 | can be used to find changes that match either operator. This |
| 729 | increases the number of results that are returned, as more changes |
| 730 | are considered. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 731 | |
| 732 | |
| 733 | [[labels]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 734 | == Labels |
David Pursehouse | 221d4f6 | 2012-06-08 17:38:08 +0900 | [diff] [blame] | 735 | Label operators can be used to match approval scores given during |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 736 | a code review. The specific set of supported labels depends on |
David Pursehouse | 2f82f2f | 2013-10-23 09:26:38 +0900 | [diff] [blame] | 737 | the server configuration, however the `Code-Review` label is provided |
| 738 | out of the box. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 739 | |
| 740 | A label name is any of the following: |
| 741 | |
Dave Borowitz | 01c1b1f | 2013-02-27 13:49:04 -0800 | [diff] [blame] | 742 | * The label name. Example: `label:Code-Review`. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 743 | |
Craig Chapel | 9c6e537 | 2013-02-13 10:14:08 -0700 | [diff] [blame] | 744 | * The label name followed by a ',' followed by a reviewer id or a |
| 745 | group id. To make it clear whether a user or group is being looked |
| 746 | for, precede the value by a user or group argument identifier |
| 747 | ('user=' or 'group='). If an LDAP group is being referenced make |
| 748 | sure to use 'ldap/<groupname>'. |
| 749 | |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 750 | A label name must be followed by either a score with optional operator, |
| 751 | or a label status. The easiest way to explain this is by example. |
Edwin Kempin | 8070fce | 2017-09-20 13:52:15 +0200 | [diff] [blame] | 752 | |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 753 | First, some examples of scores with operators: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 754 | |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 755 | `label:Code-Review=2`:: |
| 756 | `label:Code-Review=+2`:: |
| 757 | `label:Code-Review+2`:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 758 | + |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 759 | Matches changes where there is at least one +2 score for Code-Review. |
Edwin Kempin | cdb0e00 | 2011-09-08 14:23:30 +0200 | [diff] [blame] | 760 | The + prefix is optional for positive score values. If the + is used, |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 761 | the = operator is optional. |
| 762 | |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 763 | `label:Code-Review=-2`:: |
| 764 | `label:Code-Review-2`:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 765 | + |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 766 | Matches changes where there is at least one -2 score for Code-Review. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 767 | Because the negative sign is required, the = operator is optional. |
| 768 | |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 769 | `label:Code-Review=1`:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 770 | + |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 771 | Matches changes where there is at least one +1 score for Code-Review. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 772 | Scores of +2 are not matched, even though they are higher. |
| 773 | |
Dave Borowitz | 41f909f | 2013-02-05 15:34:18 -0800 | [diff] [blame] | 774 | `label:Code-Review>=1`:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 775 | + |
| 776 | Matches changes with either a +1, +2, or any higher score. |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 777 | + |
| 778 | Instead of a numeric vote, you can provide a label status corresponding |
| 779 | to one of the fields in the |
| 780 | link:rest-api-changes.html#submit-record[SubmitRecord] REST API entity. |
| 781 | |
Youssef Elghareeb | 27e7a31 | 2021-09-22 13:44:04 +0200 | [diff] [blame] | 782 | `label:Code-Review\<=-1`:: |
| 783 | + |
| 784 | Matches changes with either a -1, -2, or any lower score. |
| 785 | |
Youssef Elghareeb | 57b60ae | 2021-06-11 14:22:31 +0200 | [diff] [blame] | 786 | `label:Code-Review=MAX`:: |
| 787 | + |
| 788 | Matches changes with label voted with the highest possible score. |
| 789 | |
| 790 | `label:Code-Review=MIN`:: |
| 791 | + |
| 792 | Matches changes with label voted with the lowest possible score. |
| 793 | |
| 794 | `label:Code-Review=ANY`:: |
| 795 | + |
| 796 | Matches changes with label voted with any score. |
| 797 | |
Youssef Elghareeb | f6e5464 | 2021-10-26 17:26:57 +0200 | [diff] [blame] | 798 | `label:Code-Review=+1,count=2`:: |
| 799 | + |
| 800 | Matches changes with exactly two +1 votes to the code-review label. The {MAX, |
| 801 | MIN, ANY} votes can also be used, for example `label:Code-Review=MAX,count=2` is |
| 802 | equivalent to `label:Code-Review=2,count=2` (if 2 is the maximum positive vote |
| 803 | for the code review label). The maximum supported value for `count` is 5. |
| 804 | `count=0` is not allowed and the query request will fail with `400 Bad Request`. |
| 805 | |
| 806 | `label:Code-Review=+1,count>=2`:: |
| 807 | + |
| 808 | Matches changes having two or more +1 votes to the code-review label. Can also |
| 809 | be used with the {MAX, MIN, ANY} label votes. All operators `>`, `>=`, `<`, `<=` |
| 810 | are supported. |
| 811 | Note that a query like `label:Code-Review=+1,count<x` will not match with |
| 812 | changes having zero +1 votes to this label. |
| 813 | |
Youssef Elghareeb | fda0e42 | 2022-02-11 14:39:02 +0100 | [diff] [blame] | 814 | `label:Non-Author-Code-Review=need` (deprecated):: |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 815 | + |
| 816 | Matches changes where the submit rules indicate that a label named |
| 817 | `Non-Author-Code-Review` is needed. (See the |
| 818 | link:prolog-cookbook.html#NonAuthorCodeReview[Prolog Cookbook] for how |
| 819 | this label can be configured.) |
Youssef Elghareeb | fda0e42 | 2022-02-11 14:39:02 +0100 | [diff] [blame] | 820 | + |
| 821 | This operator is also compatible with |
| 822 | link:config-submit-requirements.html[submit requirement] results. A submit |
| 823 | requirement name could be used instead of the label name. The submit record |
| 824 | statuses are mapped to submit requirement result statuses as follows: |
| 825 | + |
| 826 | * {`need`, `reject`} -> {`UNSATISFED`} |
| 827 | * {`ok`, `may`} -> {`SATISFIED`, `OVERRIDDEN`} |
| 828 | + |
| 829 | For example, a query like `label:Code-Review=ok` will also match changes |
| 830 | having a submit requirement with a result that is either `SATISFIED` or |
| 831 | `OVERRIDDEN`. Users are encouraged not to rely on this operator since submit |
| 832 | records are deprecated. |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 833 | |
Edwin Kempin | f6c0d52 | 2014-01-13 09:17:46 +0100 | [diff] [blame] | 834 | `label:Code-Review=+2,aname`:: |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 835 | `label:Code-Review=ok,aname`:: |
Craig Chapel | 9c6e537 | 2013-02-13 10:14:08 -0700 | [diff] [blame] | 836 | + |
| 837 | Matches changes with a +2 code review where the reviewer or group is aname. |
| 838 | |
Edwin Kempin | f6c0d52 | 2014-01-13 09:17:46 +0100 | [diff] [blame] | 839 | `label:Code-Review=2,user=jsmith`:: |
Craig Chapel | 9c6e537 | 2013-02-13 10:14:08 -0700 | [diff] [blame] | 840 | + |
| 841 | Matches changes with a +2 code review where the reviewer is jsmith. |
| 842 | |
David Ostrovsky | dc26bbf | 2016-07-06 06:45:43 +0200 | [diff] [blame] | 843 | `label:Code-Review=+2,user=owner`:: |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 844 | `label:Code-Review=ok,user=owner`:: |
David Ostrovsky | dc26bbf | 2016-07-06 06:45:43 +0200 | [diff] [blame] | 845 | `label:Code-Review=+2,owner`:: |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 846 | `label:Code-Review=ok,owner`:: |
David Ostrovsky | dc26bbf | 2016-07-06 06:45:43 +0200 | [diff] [blame] | 847 | + |
| 848 | The special "owner" parameter corresponds to the change owner. Matches |
| 849 | all changes that have a +2 vote from the change owner. |
| 850 | |
Edwin Kempin | 97673c7 | 2023-11-30 14:58:01 +0000 | [diff] [blame] | 851 | [[non_uploader]] |
Youssef Elghareeb | b1647c0 | 2021-08-27 12:02:43 +0200 | [diff] [blame] | 852 | `label:Code-Review=+2,user=non_uploader`:: |
| 853 | `label:Code-Review=ok,user=non_uploader`:: |
| 854 | `label:Code-Review=+2,non_uploader`:: |
| 855 | `label:Code-Review=ok,non_uploader`:: |
| 856 | + |
| 857 | The special "non_uploader" parameter corresponds to any user who's not the |
| 858 | uploader of the latest patchset. Matches all changes that have a +2 vote from |
| 859 | a non upoader. |
| 860 | |
Edwin Kempin | f6c0d52 | 2014-01-13 09:17:46 +0100 | [diff] [blame] | 861 | `label:Code-Review=+1,group=ldap/linux.workflow`:: |
Craig Chapel | 9c6e537 | 2013-02-13 10:14:08 -0700 | [diff] [blame] | 862 | + |
| 863 | Matches changes with a +1 code review where the reviewer is in the |
| 864 | ldap/linux.workflow group. |
| 865 | |
David Pursehouse | 48933d3 | 2013-09-26 15:21:47 +0900 | [diff] [blame] | 866 | `is:open label:Code-Review+2 label:Verified+1 NOT label:Verified-1 NOT label:Code-Review-2`:: |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 867 | `is:open label:Code-Review=ok label:Verified=ok`:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 868 | + |
Dave Borowitz | 6453fce | 2016-09-22 16:11:56 +0200 | [diff] [blame] | 869 | Matches changes that are ready to be submitted according to one common |
| 870 | label configuration. (For a more general check, use |
Youssef Elghareeb | 84bcb6a | 2022-01-14 11:41:53 +0100 | [diff] [blame] | 871 | link:#is-submittable[is:submittable].) |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 872 | |
David Pursehouse | 48933d3 | 2013-09-26 15:21:47 +0900 | [diff] [blame] | 873 | `is:open (label:Verified-1 OR label:Code-Review-2)`:: |
David Pursehouse | 6e5e6e6 | 2018-03-21 15:49:34 +0900 | [diff] [blame] | 874 | `is:open (label:Verified=reject OR label:Code-Review=reject)`:: |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 875 | + |
| 876 | Changes that are blocked from submission due to a blocking score. |
| 877 | |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 878 | == Magical Operators |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 879 | |
| 880 | Most of these operators exist to support features of Gerrit Code |
| 881 | Review, and are not meant to be accessed by the average end-user. |
| 882 | However, they are recognized by the query parser, and may prove |
| 883 | useful in limited contexts to administrators or power-users. |
| 884 | |
| 885 | visibleto:'USER-or-GROUP':: |
| 886 | + |
| 887 | Matches changes that are visible to 'USER' or to anyone who is a |
| 888 | member of 'GROUP'. Here group names may be specified as either |
| 889 | an internal group name, or if LDAP is being used, an external LDAP |
| 890 | group name. The value may be wrapped in double quotes to include |
| 891 | spaces or other special characters. For example, to match an LDAP |
| 892 | group: `visibleto:"CN=Developers, DC=example, DC=com"`. |
| 893 | + |
| 894 | This operator may be useful to test access control rules, however a |
| 895 | change can only be matched if both the current user and the supplied |
| 896 | user or group can see it. This is due to the implicit 'is:visible' |
| 897 | clause that is always added by the server. |
| 898 | |
| 899 | is:visible:: |
| 900 | + |
| 901 | Magical internal flag to prove the current user has access to read |
| 902 | the change. This flag is always added to any query. |
| 903 | |
Edwin Kempin | 1f55622 | 2015-04-22 13:24:39 +0200 | [diff] [blame] | 904 | [[limit]] |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 905 | limit:'CNT':: |
| 906 | + |
| 907 | Limit the returned results to no more than 'CNT' records. This is |
| 908 | automatically set to the page size configured in the current user's |
| 909 | preferences. Including it in a web query may lead to unpredictable |
| 910 | results with regards to pagination. |
| 911 | |
Shawn O. Pearce | 51d008d | 2010-07-16 18:34:31 -0700 | [diff] [blame] | 912 | GERRIT |
| 913 | ------ |
| 914 | Part of link:index.html[Gerrit Code Review] |
Yuxuan 'fishy' Wang | 99cb68d | 2013-10-31 17:26:00 -0700 | [diff] [blame] | 915 | |
| 916 | SEARCHBOX |
| 917 | --------- |