make the git commit message template more compact

git's default commit message includes the list of staged, unstaged, and
untracked files; adding our metadata tags and then their descriptions
made for a very long template.

Move the descriptions to the metadata lines themselves.

Reviewed by:	bcr
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D27664

1 files changed, 17 insertions, 27 deletions

diff --git a/tools/tools/git/hooks/prepare-commit-msg b/tools/tools/git/hooks/prepare-commit-msg
index 9e623371447f..9dcb85cd1a3f 100755
--- a/tools/tools/git/hooks/prepare-commit-msg
+++ b/tools/tools/git/hooks/prepare-commit-msg
@@ -28,36 +28,26 @@ outfile=$(mktemp /tmp/freebsd-git-commit.XXXXXXXX)
 
 cat >$outfile <<EOF
 $(awk '1;/^#$/{exit}' $1)
+#                                                         72 columns --|
+#
 # Uncomment and complete these metadata fields, as appropriate:
 # 
-# PR:		
-# Submitted by:	
-# Reported by:	
-# Reviewed by:	
-# Approved by:	
-# Obtained from:	
-# MFC after:	
-# MFH:		
-# Relnotes:	
-# Security:	
-# Sponsored by:	
-# Pull Request:	
-# Differential Revision:	
+# PR:		<If and which Problem Report is related.>
+# Submitted by:	<If someone else sent in the change.>
+# Reported by:	<If someone else reported the issue.>
+# Reviewed by:	<If someone else reviewed your modification.>
+# Approved by:	<If you needed approval for this commit.>
+# Obtained from:	<If the change is from a third party.>
+# MFC after:	<N [day[s]|week[s]|month[s]].  Request a reminder email>
+# MFH:		<Ports tree branch name.  Request approval for merge.>
+# Relnotes:	<Set to 'yes' for mention in release notes.>
+# Security:	<Vulnerability reference (one per line) or description.>
+# Sponsored by:	<If the change was sponsored by an organization.>
+# Pull Request:	<https://github.com/freebsd/<repo>/pull/###>
+# Differential Revision:	<https://reviews.freebsd.org/D###>
 #
-# Description of fields to fill in above:                 72 columns --|
-# PR:                       If and which Problem Report is related.
-# Submitted by:             If someone else sent in the change.
-# Reported by:              If someone else reported the issue.
-# Reviewed by:              If someone else reviewed your modification.
-# Approved by:              If you needed approval for this commit.
-# Obtained from:            If the change is from a third party.
-# MFC after:                N [day[s]|week[s]|month[s]].  Request a reminder email.
-# MFH:                      Ports tree branch name.  Request approval for merge.
-# Relnotes:                 Set to 'yes' for mention in release notes.
-# Security:                 Vulnerability reference (one per line) or description.
-# Sponsored by:             If the change was sponsored by an organization.
-# Pull Request:             https://github.com/freebsd/<repo>/pull/### (*full* GitHub URL needed).
-# Differential Revision:    https://reviews.freebsd.org/D### (*full* phabric URL needed).
+# "Pull Request" and "Differential Revision" require the *full* GitHub or
+# Phabricator URL.
 $(awk '/^#$/,EOF' $1)
 EOF