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 36067
Build 32956: 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.