git: eddfe9b414 - main - committers-guide: Improve "Fixes:" metadata

From: Jose Luis Duran <jlduran_at_FreeBSD.org>
Date: Sat, 02 Nov 2024 15:54:07 UTC
The branch main has been updated by jlduran:

URL: https://cgit.FreeBSD.org/doc/commit/?id=eddfe9b41481924ecf6e6d80b544c9aa3045cbf4

commit eddfe9b41481924ecf6e6d80b544c9aa3045cbf4
Author:     Jose Luis Duran <jlduran@FreeBSD.org>
AuthorDate: 2024-11-02 15:47:57 +0000
Commit:     Jose Luis Duran <jlduran@FreeBSD.org>
CommitDate: 2024-11-02 15:53:35 +0000

    committers-guide: Improve "Fixes:" metadata
    
    Use the preferred format for displaying the "Fixes:" metadata in the git
    commit message, as discussed in the srcmgr meeting (20241101).
    
    Reviewed by:    emaste, imp, jhb
    Approved by:    emaste (mentor)
    Differential Revision:  https://reviews.freebsd.org/D47397
---
 documentation/content/en/articles/committers-guide/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index 764ae74835..3b096b082d 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2614,7 +2614,7 @@ Approved by: re (username)
 |The name of the project (if any) from which the code was obtained. Do not use this line for the name of an individual person.
 
 |`Fixes:`
-|The Git short hash and the title line of a commit that is fixed by this change as returned by `git log -n 1 --oneline GIT-COMMIT-HASH`.
+|The Git short hash and the title line of a commit that is fixed by this change as returned by `git log -n 1 --pretty=format:'%h ("%s")' GIT-COMMIT-HASH`.
 
 |`MFC after:`
 |To receive an e-mail reminder to MFC at a later date, specify the number of days, weeks, or months after which an MFC is planned.