Skip to content

Commit 472477c

Browse files
preamesmemfrob
authored andcommitted
[docs] Expand the pre-merge testing description a bit
Core changes are: Be explicit about desired balance between missing true positives and reporting false positives. Mention the opt-out mechanism. Provide links to background, and give description of who to contact if needed. Differential Revision: https://reviews.llvm.org/D110873
1 parent c550275 commit 472477c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

llvm/docs/Phabricator.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,12 @@ branch - thus the term *pre-merge testing*.
181181

182182
When a user uploads a patch to Phabricator, Phabricator triggers the checks and
183183
then displays the results. This way bugs in a patch are contained during the
184-
code review stage and do not pollute the main branch.
184+
code review stage and do not pollute the main branch.
185+
186+
Our goal with pre-merge testing is to report most true problems while strongly
187+
minimizing the number of false positive reports. Our goal is that problems
188+
reported are always actionable. If you notice a false positive, please report
189+
it so that we can identify the cause.
185190

186191
If you notice issues or have an idea on how to improve pre-merge checks, please
187192
`create a new issue <https://github.com/google/llvm-premerge-checks/issues/new>`_
@@ -217,6 +222,25 @@ the unit test to see the details:
217222

218223
.. image:: Phabricator_premerge_unit_tests.png
219224

225+
Opting Out
226+
^^^^^^^^^^
227+
228+
In case you want to opt-out entirely of pre-merge testing, add yourself to the
229+
`OPT OUT project <https://reviews.llvm.org/project/view/83/>`_. If you decide
230+
to opt-out, please let us know why, so we might be able to improve in the future.
231+
232+
Operational Details
233+
^^^^^^^^^^^^^^^^^^^
234+
235+
The code responsible for running the pre-merge flow can be found in the external
236+
repository `https://github.com/google/llvm-premerge-checks`_. For enhancement
237+
ideas and most bugs, please file an issue on said repository. For immediate
238+
operational problems, the point of contact is
239+
`Mikhail Goncharov <mailto:[email protected]>`_.
240+
241+
Background on the pre-merge infrastructure can be found in `this 2020 DevMeeting
242+
talk <https://llvm.org/devmtg/2020-09/slides/Goncharov-Pre-merge_checks.pdf>`_
243+
220244
Committing a change
221245
-------------------
222246

0 commit comments

Comments
 (0)