summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2020-08-20 11:29:06 (GMT)
committerBrad King <brad.king@kitware.com>2020-08-20 11:29:06 (GMT)
commite05b200be2cd650b4b07d9e2411cd640da5ace28 (patch)
tree1ff185657ea2f4b8383e1625ddbf522f6471ac23
parentb544a1ebec7357fd6df0025f87179c9e30e454b1 (diff)
downloadCMake-e05b200be2cd650b4b07d9e2411cd640da5ace28.zip
CMake-e05b200be2cd650b4b07d9e2411cd640da5ace28.tar.gz
CMake-e05b200be2cd650b4b07d9e2411cd640da5ace28.tar.bz2
Help/dev: Update CMake Review Process document to suggest 'git describe'
Using `git describe --contains` is the preferred way to reference a commit relative to a tag.
-rw-r--r--Help/dev/review.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index f2a91c0..8326e70 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -264,6 +264,7 @@ fixed, it is preferable to link to the issue instead.
If relevant, add the first release tag of CMake containing the commit after
the ``<date>``, i.e., ``commit <shorthash> (<subject>, <date>, <tag>)``.
+Or, use the output of ``git describe --contains <commit>`` as the ``<tag>``.
Alternatively, the full commit ``<hash>`` may be used.