Jelajahi Sumber

Merge topic 'doc-dev-do-reformat'

72f534ca Help/dev: Document `Do: reformat` action
2192247e Help/dev: Make `Do: check` cross-reference more specific

Acked-by: Kitware Robot <[email protected]>
Reviewed-by: Ben Boeckel <[email protected]>
Merge-request: !606
Brad King 8 tahun lalu
induk
melakukan
da802afd6e
1 mengubah file dengan 20 tambahan dan 1 penghapusan
  1. 20 1
      Help/dev/review.rst

+ 20 - 1
Help/dev/review.rst

@@ -74,6 +74,9 @@ 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.
 
+Automatic Check
+---------------
+
 The automatic check is repeated whenever the topic branch is updated.
 One may explicitly request a re-check by adding a comment with the
 following command among the `comment trailing lines`_::
@@ -83,6 +86,21 @@ following command among the `comment trailing lines`_::
 ``@kwrobot`` will add an award emoji to the comment to indicate that it
 was processed and also run its checks again.
 
+Automatic Format
+----------------
+
+The automatic check will reject commits introducing source code not
+formatted according to ``clang-format``.  One may ask the robot to
+automatically rewrite the MR topic branch with expected formatting
+by adding a comment with the following command among the
+`comment trailing lines`_::
+
+  Do: reformat
+
+``@kwrobot`` will add an award emoji to the comment to indicate that it
+was processed and also rewrite the MR topic branch and force-push an
+updated version with every commit formatted as expected by the check.
+
 Human Review
 ============
 
@@ -154,7 +172,8 @@ Comment Trailer Commands
 Among the `comment trailing lines`_ authorized users may issue special
 commands to ``@kwrobot`` using the form ``Do: ...``:
 
-* ``Do: check`` explicitly re-runs `Robot Review`_ checks.
+* ``Do: check`` explicitly re-runs the robot `Automatic Check`_.
+* ``Do: reformat`` rewrites the MR topic for `Automatic Format`_.
 * ``Do: test`` submits the MR for `Topic Testing`_.
 * ``Do: stage`` submits the MR for `Integration Testing`_.
 * ``Do: merge`` submits the MR for `Merge`_.