summaryrefslogtreecommitdiffstats
path: root/Help/dev
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2017-03-21 17:07:42 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2017-03-21 18:53:31 (GMT)
commit7d22203912bdab5eeefe532d7e644f43c6446925 (patch)
tree4d152db67a780742945a53208564165a3518e39f /Help/dev
parent48dc2d122d74f47ea323066df7be33165a34fa57 (diff)
downloadCMake-7d22203912bdab5eeefe532d7e644f43c6446925.zip
CMake-7d22203912bdab5eeefe532d7e644f43c6446925.tar.gz
CMake-7d22203912bdab5eeefe532d7e644f43c6446925.tar.bz2
Help/dev: mention how the robot performs its checks
Fixes: #16264.
Diffstat (limited to 'Help/dev')
-rw-r--r--Help/dev/review.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index e23c0fb..03f6cda 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -65,9 +65,14 @@ The "Kitware Robot" (``@kwrobot``) automatically performs basic checks on
the commits proposed in a MR. If all is well the robot silently reports
a successful "build" status to GitLab. Otherwise the robot posts a comment
with its diagnostics. **A topic may not be merged until the automatic
-review succeeds.** The MR submitter is expected to address the robot's
-comments by *rewriting* the commits named by the robot's diagnostics
-(e.g. via ``git rebase -i``).
+review succeeds.**
+
+Note that the MR submitter is expected to address the robot's comments by
+*rewriting* the commits named by the robot's diagnostics (e.g., via
+``git rebase -i``). This is because the robot checks each commit individually,
+not the topic as a whole. This is done in order to ensure that commits in the
+middle of a topic do not, for example, add a giant file which is then later
+removed in the topic.
The automatic check is repeated whenever the topic branch is updated.
One may explicitly request a re-check by adding a comment with the