[PATCHv6 wayland-protocols] Add name event to xdg-output

Pekka Paalanen ppaalanen at gmail.com
Thu Apr 26 10:20:28 UTC 2018

On Thu, 26 Apr 2018 11:46:54 +0200
Drew DeVault <sir at cmpwn.com> wrote:

> On 2018-04-26 10:49 AM, Pekka Paalanen wrote:
> > when someone merges this patch, please do add a commit message
> > explaining why these events are added. See
> > https://cgit.freedesktop.org/wayland/wayland/tree/doc/Contributing#n21
> > for guidance on what to write.
> > 
> > Even if it seems obvious to everyone right now, it's not obvious after
> > 5 years. I don't think the one line summary explains it.
> > 
> > For example, we had a long discussion about having just one event
> > instead of two, what that one event would mean, and yet we ended up
> > with two separate events (which I think is for the better). I would
> > expect the commit message to explain why we have two events instead of
> > one, since having one was the original and intuitive proposal.
> > 
> > Acked-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
> > 
> > I would give R-b if the commit message was there. The protocol spec
> > text looks good to me.  
> I respectfully disagree. The commit message should pertain only to the
> final approach, and historical information and timely commentary belongs
> on the mailing list. 5 years from now, should it prove confusing,
> looking up the mailing list posts will not be considerably more
> difficult than looking up the commit message.

A commit must always document the "why exactly this change is being
made", and here it is completely missing, even for the final approach.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/wayland-devel/attachments/20180426/ee0ff552/attachment.sig>

More information about the wayland-devel mailing list