git: 03774659d1f2 - main - tools: git hooks: drop "submitted by" from commit template

Kyle Evans kevans at FreeBSD.org
Thu Jan 14 06:33:19 UTC 2021


The branch main has been updated by kevans:

URL: https://cgit.FreeBSD.org/src/commit/?id=03774659d1f24d47ce00e165048a253263028cff

commit 03774659d1f24d47ce00e165048a253263028cff
Author:     Kyle Evans <kevans at FreeBSD.org>
AuthorDate: 2021-01-14 06:33:07 +0000
Commit:     Kyle Evans <kevans at FreeBSD.org>
CommitDate: 2021-01-14 06:33:07 +0000

    tools: git hooks: drop "submitted by" from commit template
    
    With the switch to git, we should strive to properly attribute every
    commit appropriately with the metadata that's provided to do so. In this
    case, the submitter should be recorded via the author metadata.  Committing
    an arbitrary patch, one can set it as such:
    
    git commit --author="John Smith <smith at example.com>"
    
    Reviewed-by:    emaste
    Differential-Revision:  https://reviews.freebsd.org/D28069
---
 tools/tools/git/hooks/prepare-commit-msg | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools/tools/git/hooks/prepare-commit-msg b/tools/tools/git/hooks/prepare-commit-msg
index 51b92a10724d..0ebec48fd9a5 100755
--- a/tools/tools/git/hooks/prepare-commit-msg
+++ b/tools/tools/git/hooks/prepare-commit-msg
@@ -43,7 +43,6 @@ $(awk '1;/^#$/{exit}' $1)
 # Uncomment and complete these metadata fields, as appropriate:
 # 
 # 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.>
@@ -57,7 +56,8 @@ $(awk '1;/^#$/{exit}' $1)
 # Differential Revision:	<https://reviews.freebsd.org/D###>
 #
 # "Pull Request" and "Differential Revision" require the *full* GitHub or
-# Phabricator URL.
+# Phabricator URL.  The commit author should be set appropriately, using
+# \`git commit --author\` if someone besides the committer sent in the change.
 $(awk '/^#$/,EOF' "$1")
 EOF
 


More information about the dev-commits-src-all mailing list