[llvm-dev] Delete Phabricator metadata tags before committing

[David Blaikie via llvm-dev]

I don't think they're sufficiently problematic to worry about adding more
steps people need to be aware of/follow to submit.

Maybe more advisory "you can remove the unneeded tags" might not hurt (but
still adds to the length of new contributor documentation, etc, which isn't
free) - though "Reviewed By" is useful (in addition to "Differential
Revision") if it accurately reflects who reviewed/signed off on the change
(makes it easy when I'm reading the mailing list to see who's already
looked a patch over, etc).

On Fri, Dec 27, 2019 at 12:48 PM Fangrui Song via llvm-dev <
llvm-dev at lists.llvm.org> wrote:

> Many git commits in the monorepo look like the following:
>
>    [Tag0][Tag1] Title line
>
>    Summary:
>    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque mauris
> neque, porta nec tristique at, sagittis vel nisi. Fusce pharetra nunc et
> mauris consequat venenatis.
>
>    Reviewers: username0, username1
>
>    Reviewed By: username0
>
>    Subscribers: username2, username3, llvm-commits
>
>    Tags: #llvm
>
>    Differential Revision: https://reviews.llvm.org/Dxxxxx
>
> These Phabricator metadata lines (`Reviewers:`, `Reviewed By:`, etc) are
> created automatically when the author uploads the patch via `arc diff
> 'HEAD^'`.
> The summary and metadata can be copied from Phabricator to the local
> commit via `arc amend`.
>
> Among the metadata tags, `Differential Revision:` is the most useful one.
> It associates a commit with a Phabricator differential (Dxxxxx) and allows
> the differential to be closed automatically when the commit is pushed to
> llvm-project master.
>
> The other tags (Subscribers:, Reviewers:, Reviewed By:, Tags:, and the
> `Summary:` line) are not useful. They just clutter up the commit message.
> Shall we mention on https://llvm.org/docs/DeveloperPolicy.html that
> developers are recommended to delete metadata tags before committing? It'd
> be nice if some pre-receive hooks can be set up to enforce deleting some
> really unnecessary metadata tags.
> _______________________________________________
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org
> https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20191227/8bbff6e2/attachment.html>