summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2018-05-25 23:07:15 (GMT)
committerCraig Scott <craig.scott@crascit.com>2018-05-29 20:56:11 (GMT)
commit82e01cbfc5c177920c8ee4c2cd141887efa0bbfe (patch)
treec0dcafc1217612301f34397914cfd105fbb2d8bf /Help
parent46b26b52c9e4a308dbb9efbca062ae15a2a2d47c (diff)
downloadCMake-82e01cbfc5c177920c8ee4c2cd141887efa0bbfe.zip
CMake-82e01cbfc5c177920c8ee4c2cd141887efa0bbfe.tar.gz
CMake-82e01cbfc5c177920c8ee4c2cd141887efa0bbfe.tar.bz2
Help: Clarify usage of Topic-rename
Diffstat (limited to 'Help')
-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