[Cmake-commits] CMake branch, master, updated. v3.13.3-1159-gfc96aa0

[Kitware Robot]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".

The branch, master has been updated
       via  fc96aa03f8a3d3133aaddab27bfc0b684594558b (commit)
       via  939dc9a58c5667ea18809c3a5e97ef1b60eb746c (commit)
      from  8e495333c0914a0684d6d82e2cc15327c9f811f3 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=fc96aa03f8a3d3133aaddab27bfc0b684594558b
commit fc96aa03f8a3d3133aaddab27bfc0b684594558b
Merge: 8e49533 939dc9a
Author:     Brad King <brad.king at kitware.com>
AuthorDate: Mon Jan 28 13:45:17 2019 +0000
Commit:     Kitware Robot <kwrobot at kitware.com>
CommitDate: Mon Jan 28 08:45:24 2019 -0500

    Merge topic 'commit-ref-in-prose'
    
    939dc9a58c Help: prefer commit hashes in commit references
    
    Acked-by: Kitware Robot <kwrobot at kitware.com>
    Merge-request: !2854


https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=939dc9a58c5667ea18809c3a5e97ef1b60eb746c
commit 939dc9a58c5667ea18809c3a5e97ef1b60eb746c
Author:     Ben Boeckel <ben.boeckel at kitware.com>
AuthorDate: Thu Jan 24 13:31:37 2019 -0500
Commit:     Ben Boeckel <ben.boeckel at kitware.com>
CommitDate: Fri Jan 25 12:10:10 2019 -0500

    Help: prefer commit hashes in commit references
    
    The logic is that the describe output is readily available using `git
    tag --contains` locally. In addition, for a hypothetical commit which
    landed in both v3.9.4 and v3.10.1, there is no "better" tag to refer to.
    since v3.10.0's relation to such a commit is unclear either way.
    
    Also mention that a `Fixes` trailer is preferred if the mention is just
    to indicate a commit which introduced an error rather than writing a
    complete sentence about it.

diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index 0c4eded..1d664c4 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -238,12 +238,10 @@ Referencing Commits in Commit Messages
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The preferred form for references to other commits is
-``commit <commit> (<subject>, <date>)``, where:
+``commit <shorthash> (<subject>, <date>)``, where:
 
-* ``<commit>``:
-  If available, a tag-relative name of the commit produced by
-  ``git describe --contains <commit-ish>``.  Otherwise, the first
-  8-10 characters of the commit ``<hash>``.
+* ``<shorthash>``:
+  The abbreviated hash of the commit.
 
 * ``<subject>``:
   The first line of the commit message.
@@ -252,6 +250,17 @@ The preferred form for references to other commits is
   The author date of the commit, in its original time zone, formatted as
   ``CCYY-MM-DD``.  ``git-log(1)`` shows the original time zone by default.
 
+This may be generated with
+``git show -s --date=short --pretty="format:%h (%s, %ad)" <commit>``.
+
+If the commit is a fix for the mentioned commit, consider using a ``Fixes:``
+trailer in the commit message with the specified format. This trailer should
+not be word-wrapped. Note that if there is also an issue for what is being
+fixed, it is preferrable 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>)``.
+
 Alternatively, the full commit ``<hash>`` may be used.
 
 Revising Commit Messages

-----------------------------------------------------------------------

Summary of changes:
 Help/dev/review.rst | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)


hooks/post-receive
-- 
CMake