summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-05-30 13:23:25 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-05-30 13:23:39 (GMT)
commite21245ecafae78ff2fd3947f95cc30eac68ed5e8 (patch)
tree1800cb16e8536fd503126d7baaf83a618f75ac23
parent392f223d6055a8863064fabcc704442f29bd0c23 (diff)
parent82e01cbfc5c177920c8ee4c2cd141887efa0bbfe (diff)
downloadCMake-e21245ecafae78ff2fd3947f95cc30eac68ed5e8.zip
CMake-e21245ecafae78ff2fd3947f95cc30eac68ed5e8.tar.gz
CMake-e21245ecafae78ff2fd3947f95cc30eac68ed5e8.tar.bz2
Merge topic 'clarify-topic-rename'
82e01cbfc5 Help: Clarify usage of Topic-rename Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2110
-rw-r--r--Help/dev/review.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index be02a1a..a524115 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -401,11 +401,14 @@ The ``Do: merge`` command accepts the following arguments:
branch in the constructed merge commit message.
Additionally, ``Do: merge`` extracts configuration from trailing lines
-in the MR description:
+in the MR description (the following have no effect if used in a MR
+comment instead):
* ``Topic-rename: <topic>``: substitute ``<topic>`` for the name of
the MR topic branch in the constructed merge commit message.
- The ``-t`` option overrides this.
+ It is also used in merge commits constructed by ``Do: stage``.
+ The ``-t`` option to a ``Do: merge`` command overrides any topic
+ rename set in the MR description.
.. _`CMake GitLab Project Masters`: https://gitlab.kitware.com/cmake/cmake/settings/members