Page MenuHomePhabricator

Update the attribution policy to use the 'Author' property of a git commit
ClosedPublic

Authored by dsanders on Jan 9 2020, 10:34 AM.

Details

Summary

The older method of adding 'Patch by John Doe' is documented in the
Attribution of Changes section to support correct attribution of commits
that pre-date the adoption of git.

Diff Detail

Event Timeline

dsanders created this revision.Jan 9 2020, 10:34 AM
Herald added a project: Restricted Project. · View Herald TranscriptJan 9 2020, 10:34 AM

Thank you for working on this!

llvm/docs/DeveloperPolicy.rst
295–303

title, body -> a title and a body.

299

It would be helpful if we documented somewhere that the patch author should provide this information as part of their review when deciding who will commit the patch.

SGTM in general

llvm/docs/DeveloperPolicy.rst
295–303

Worth explicitly stating that there should be an empty line between the title and the body?
I.e. Separate the commit message into title and body with an empty line.

echristo added inline comments.
llvm/docs/DeveloperPolicy.rst
299

That and if you wouldn't mind a couple of actual command line examples would be nice too.

dsanders updated this revision to Diff 237177.Jan 9 2020, 1:13 PM
dsanders marked 3 inline comments as done.

Small changes for review comments

dsanders marked an inline comment as done.Jan 9 2020, 1:13 PM
dsanders added inline comments.
llvm/docs/DeveloperPolicy.rst
299

It would be helpful if we documented somewhere that the patch author should provide this information as part of their review when deciding who will commit the patch.

Sure. I'm pretty sure I've seen a suitable place but I'm having trouble finding it at the moment. I'll keep looking

That and if you wouldn't mind a couple of actual command line examples would be nice too.

For this, I've just changed the current command to a realistic example. Hopefully jdoe@llvm.org isn't an address that's in use.

dsanders updated this revision to Diff 237185.Jan 9 2020, 1:27 PM
dsanders marked 2 inline comments as done.

Add a bit about asking someone to commit for you so that we can document
providing the information needed for the Author property

llvm/docs/DeveloperPolicy.rst
299

> It would be helpful if we documented somewhere that the patch author should provide this information as part of their review when deciding who will commit the patch.
Sure. I'm pretty sure I've seen a suitable place but I'm having trouble finding it at the moment. I'll keep looking

I can't find the place where I saw a mention of asking someone to commit for you so I suspect I'm imagining it. I've added a paragraph to "Obtaining commit access" for this

mehdi_amini accepted this revision.Jan 9 2020, 6:01 PM

LGTM, please wait for the others that commented here to approve as well.

This revision is now accepted and ready to land.Jan 9 2020, 6:01 PM

Thanks everyone. Landed in a5230ac10b0

This revision was automatically updated to reflect the committed changes.

This looks great!