Page MenuHomeFreeBSD

tools: git hooks: drop "submitted by" from commit template
AcceptedPublic

Authored by kevans on Sat, Jan 9, 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 OK
Unit
No Unit Test Coverage
Build Status
Buildable 36067
Build 32956: arc lint + arc unit

Event Timeline

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

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

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

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

why the \ quotes on the single back-tick quotes? Why not single, forward ticks?

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.

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.

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

So... change it, or leave it?

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

I'd leave it as you have it now

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