Commit e05b200b authored by Brad King's avatar Brad King
Browse files

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.
parent b544a1eb
...@@ -264,6 +264,7 @@ fixed, it is preferable to link to the issue instead. ...@@ -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 If relevant, add the first release tag of CMake containing the commit after
the ``<date>``, i.e., ``commit <shorthash> (<subject>, <date>, <tag>)``. 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. Alternatively, the full commit ``<hash>`` may be used.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment