From f3fec471a3303e372943b610d38b59905c385a11 Mon Sep 17 00:00:00 2001
From: Ed Maste <emaste@FreeBSD.org>
Date: Thu, 17 Dec 2020 20:31:45 +0000
Subject: [PATCH] Describe the commit message template our git hook script
 produces

Reported by:	rpokala
---
 tools/tools/git/hooks/prepare-commit-msg | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/tools/tools/git/hooks/prepare-commit-msg b/tools/tools/git/hooks/prepare-commit-msg
index 2da681db559..9e623371447 100755
--- a/tools/tools/git/hooks/prepare-commit-msg
+++ b/tools/tools/git/hooks/prepare-commit-msg
@@ -16,8 +16,17 @@ merge)
 esac
 
 outfile=$(mktemp /tmp/freebsd-git-commit.XXXXXXXX)
-cat >$outfile <<EOF
 
+# Create a commit message template from three parts:
+#
+# 1. The beginning of the git-provided template (up to the first comment-only
+#    line) which explains commented lines and such.
+# 2. Our template.
+# 3. The remainder of the git-provided template (from the first comment-only
+#    line to the end of the file) which lists files staged for commit, files
+#    not staged, and untracked files.
+
+cat >$outfile <<EOF
 $(awk '1;/^#$/{exit}' $1)
 # Uncomment and complete these metadata fields, as appropriate:
 # 
-- 
2.45.0