Paths

Table of Contentst

-
tools/tools/git/hooks/
-
tools/
-
git/
-
hooks/
2/5
prepare-commit-msg

tools: git hooks: drop "submitted by" from commit template
ClosedPublic
Actions

Authored by kevans on Jan 9 2021, 7:55 PM.

Details

Reviewers

emaste
imp

Summary

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@example.com>"

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 36066
Build 32955: arc lint + arc unit

Event Timeline

kevans requested review of this revision.Jan 9 2021, 7:55 PM

kevans created this revision.

Harbormaster completed remote builds in B36066: Diff 81966.Jan 9 2021, 7:55 PM

perhaps we should include git commit --author in the template, something like "should be set appropriately, using git commit --author... if someone"?

In D28069#627164, @emaste wrote:

perhaps we should include git commit --author in the template, something like "should be set appropriately, using git commit --author... if someone"?

Yes. this is an obscure edge case for git usage for most people....

Explicitly reference git commit --author

Harbormaster completed remote builds in B36067: Diff 81967.Jan 9 2021, 8:23 PM

imp added inline comments.Jan 9 2021, 8:27 PM

tools/tools/git/hooks/prepare-commit-msg
60	why the \ quotes on the single back-tick quotes? Why not single, forward ticks?

kevans added inline comments.Jan 9 2021, 8:28 PM

tools/tools/git/hooks/prepare-commit-msg
60	I'm indifferent, just used to styling commands with backticks which aren't directly usable without escape in this context. No objection to using some other stylization.

emaste added inline comments.Jan 9 2021, 8:36 PM

tools/tools/git/hooks/prepare-commit-msg
60	I've become comfortable with backticks for commands via markdown and they seem fine in plain text too.

kevans added inline comments.Jan 11 2021, 9:17 PM

tools/tools/git/hooks/prepare-commit-msg
60	So... change it, or leave it?

emaste added inline comments.Jan 11 2021, 9:31 PM

tools/tools/git/hooks/prepare-commit-msg
60	I'd leave it as you have it now

emaste accepted this revision.Jan 11 2021, 9:31 PM

This revision is now accepted and ready to land.Jan 11 2021, 9:31 PM

kevans mentioned this in rG03774659d1f2: tools: git hooks: drop "submitted by" from commit template.Jan 14 2021, 6:33 AM

kevans closed this revision.Jan 21 2021, 6:35 PM

Revision Contents
Changeset List

Path

Size

tools/

git/

hooks/

prepare-commit-msg

4 lines

Diff 81966

View Options

tools/tools/git/hooks/prepare-commit-msg

	Show All 37 Lines

	cat >$outfile <<EOF			cat >$outfile <<EOF
	$(awk '1;/^#$/{exit}' $1)			$(awk '1;/^#$/{exit}' $1)
	# 72 columns --\|			# 72 columns --\|
	#			#
	# Uncomment and complete these metadata fields, as appropriate:			# Uncomment and complete these metadata fields, as appropriate:
	#			#
	# PR: <If and which Problem Report is related.>			# 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.>			# Reported by: <If someone else reported the issue.>
	# Reviewed by: <If someone else reviewed your modification.>			# Reviewed by: <If someone else reviewed your modification.>
	# Approved by: <If you needed approval for this commit.>			# Approved by: <If you needed approval for this commit.>
	# Obtained from: <If the change is from a third party.>			# Obtained from: <If the change is from a third party.>
	# MFC after: <N [day[s]\|week[s]\|month[s]]. Request a reminder email>			# MFC after: <N [day[s]\|week[s]\|month[s]]. Request a reminder email>
	# MFH: <Ports tree branch name. Request approval for merge.>			# MFH: <Ports tree branch name. Request approval for merge.>
	# Relnotes: <Set to 'yes' for mention in release notes.>			# Relnotes: <Set to 'yes' for mention in release notes.>
	# Security: <Vulnerability reference (one per line) or description.>			# Security: <Vulnerability reference (one per line) or description.>
	# Sponsored by: <If the change was sponsored by an organization.>			# Sponsored by: <If the change was sponsored by an organization.>
	# Pull Request: <https://github.com/freebsd/<repo>/pull/###>			# Pull Request: <https://github.com/freebsd/<repo>/pull/###>
	# Differential Revision: <https://reviews.freebsd.org/D###>			# Differential Revision: <https://reviews.freebsd.org/D###>
	#			#
	# "Pull Request" and "Differential Revision" require the full GitHub or			# "Pull Request" and "Differential Revision" require the full GitHub or
	# Phabricator URL.			# Phabricator URL. The commit author should be set appropriately if someone
				# besides the committer sent in the change.
				impUnsubmitted Not Done Inline Actions why the \ quotes on the single back-tick quotes? Why not single, forward ticks? imp: why the \ quotes on the single back-tick quotes? Why not single, forward ticks?
				kevansAuthorUnsubmitted Done Inline Actions I'm indifferent, just used to styling commands with backticks which aren't directly usable without escape in this context. No objection to using some other stylization. kevans: I'm indifferent, just used to styling commands with backticks which aren't directly usable…
				emasteUnsubmitted Not Done Inline Actions I've become comfortable with backticks for commands via markdown and they seem fine in plain text too. emaste: I've become comfortable with backticks for commands via markdown and they seem fine in plain…
				kevansAuthorUnsubmitted Done Inline Actions So... change it, or leave it? kevans: So... change it, or leave it?
				emasteUnsubmitted Not Done Inline Actions I'd leave it as you have it now emaste: I'd leave it as you have it now
	$(awk '/^#$/,EOF' "$1")			$(awk '/^#$/,EOF' "$1")
	EOF			EOF

	mv "$outfile" "$1"			mv "$outfile" "$1"

tools: git hooks: drop "submitted by" from commit templateClosedPublicActions