[lldb-dev] Referencing rdar bugs in commit messages

[Zachary Turner]

I didn't want to call out any specific commits, although that is the most
recent example I've seen.  I mostly just brought it up because I've seen
similar commit messages on a number of different occasions.  I'm sure it's
completely unintentional, but ideally commit messages would stand on their
own with no additional context needed to understand the problem.

It's possible i'm just advocating for better commit messages in general,
and this is unspecific to rdar issues.  For example, Sean's explanation
elaboration is more informative and gives some context to people who aren't
already that familiar with that section of code.

> I wouldn't put "Fixes rdar//whatever" in the comment, that does seem like
it's dangling candy just out of reach.  I always just put the radar number
at the bottom of the comment since it is useful when you get another Radar
reporting the same problem and internally we want to dup the two, but it
makes it clear it isn't a vital piece of info.  But other than that the
comment should stand on its own.

If the primary reason for linking rdar issues in commit messages is just to
be able to dupe the issue if they're fixed by the same issue, then wouldn't
it work to link the commit number in the rdar issue instead of the other
way around?  Mostly though it's what you said, seeing it there makes it
appear that there's additional information that's being left out, even if
there's not.

On Thu Nov 13 2014 at 10:17:47 AM Sean Callanan <scallanan at apple.com> wrote:

> Zachary might be referring to commits like 221850.
>
> "Do not override the existing definition of addr_size when adding new
> properties to SBTarget. Fixes rdar://18963842”
>
> It’s not immediately clear from that message what the original issue here
> was: a problem with 220372 where addr_size was erroneously repurposed to
> mean “size of a target byte in host bytes” where it had a different meaning
> (“size of a target address in bytes”) originally.
>
> Sean
>
> On Nov 13, 2014, at 10:11 AM, Greg Clayton <gclayton at apple.com> wrote:
>
> We strip the actual title from the radar, but we do describe what is being
> fixed in each commit message. So you aren't missing any info.
>
> On Nov 12, 2014, at 5:47 PM, Zachary Turner <zturner at google.com> wrote:
>
> Would it be possible, when referencing a rdar bug in a commit message, to
> additionally provide a brief description of the bug that it fixes?  Those
> of us without access to rdar don't have any insight into what the patches
> are fixing.
>
> I understand this may not be possible when the bugs are related to issues
> that are not public information, but wherever possible I think this would
> benefit all of the non Apple people.
>
>
> _______________________________________________
> lldb-dev mailing list
> lldb-dev at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/lldb-dev
>
>
>
> _______________________________________________
> lldb-dev mailing list
> lldb-dev at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/lldb-dev
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/lldb-dev/attachments/20141113/c0b227ce/attachment.html>