Commit message in Coreboot

[himanshu sahdev]

Hi,

I have seen some patches on gerrit, found "BUG=b:#bug_no." in the commit
message.

example: CB:35233 https://review.coreboot.org/c/coreboot/+/35233

I am not able to find this bug id and its significance with the particular
commit.
Also, have been through the https://ticket.coreboot.org/issues, it also
doesn't have those bug_no.

I want to know if coreboot uses some other bug tracking system I am unaware
of or is it just that the bug id depends on some
external/confidential/vendor_specific tracking system?

Next, what if I want to provide the bug=# in commit message which
referred an issue on https://ticket.coreboot.org/issues?
Should I write bug=T220 or bug=b:220 for bug no 220?

*HIMANSHU SAHDEV*
*bio:           *https://in.linkedin.com/in/himanshu-sahdev
*mobile:     **9560957360*

[Angel Pons]

Hi Himanshu,

On Sat, Sep 7, 2019, 11:53 himanshu sahdev  wrote:
> Hi,
>
> I have seen some patches on gerrit, found "BUG=b:#bug_no." in the commit
> message.
>
> example: CB:35233 https://review.coreboot.org/c/coreboot/+/35233

As far as I recall, these BUG=b:# lines refer to a private Google
bugtracker.

I am not able to find this bug id and its significance with the particular
> commit.
> Also, have been through the https://ticket.coreboot.org/issues, it also
> doesn't have those bug_no.

It's expected, as the bugtracker is only accessible to Google employees and
partners (usually silicon/mainboard vendors). I don't like it that people
without access (e.g., me) can't know what the issue is about. I guess
confidential information is the main reason the bugtracker is not publicly
accessible.

I want to know if coreboot uses some other bug tracking system I am unaware
> of or is it just that the bug id depends on some
> external/confidential/vendor_specific tracking system?

coreboot has the ticket system you mentioned below, though I barely use it
myself.

Next, what if I want to provide the bug=# in commit message which
> referred an issue on https://ticket.coreboot.org/issues?
> Should I write bug=T220 or bug=b:220 for bug no 220?

I'm not sure if there's a recommended way to reference coreboot tickets. I
got confused when reading your first suggestion (because of the Lenovo
Thinpad T520, T420, X220), and the second suggestion can be easily mistaken
for a Google bugtracker issue.

How about explicitly mentioning what the commit addresses/fixes? For
example, somewhere on the commit message, say that "This commit addresses
coreboot ticket #220." I believe this would be much clearer to future
readers.

*HIMANSHU SAHDEV*
>

Best regards,

Angel
>

[himanshu sahdev]

Hi,

Thanks for the suggestion Angel, seems like explicitly mentioning is the
best way for now.

But I think, we should have some recommended way to reference coreboot
tickets specifically in future, if not already there!

On Saturday, September 7, 2019, Angel Pons  wrote:
> Hi Himanshu,
>
> On Sat, Sep 7, 2019, 11:53 himanshu sahdev  wrote:
> > Hi,
> >
> > I have seen some patches on gerrit, found "BUG=b:#bug_no." in the commit
> > message.
> >
> > example: CB:35233 https://review.coreboot.org/c/coreboot/+/35233
>
> As far as I recall, these BUG=b:# lines refer to a private Google
> bugtracker.
>
> I am not able to find this bug id and its significance with the particular
> > commit.
> > Also, have been through the https://ticket.coreboot.org/issues, it also
> > doesn't have those bug_no.
>
> It's expected, as the bugtracker is only accessible to Google employees
> and partners (usually silicon/mainboard vendors). I don't like it that
> people without access (e.g., me) can't know what the issue is about. I
> guess confidential information is the main reason the bugtracker is not
> publicly accessible.
>
> I want to know if coreboot uses some other bug tracking system I am
> > unaware of or is it just that the bug id depends on some
> > external/confidential/vendor_specific tracking system?
>
> coreboot has the ticket system you mentioned below, though I barely use it
> myself.
>
> Next, what if I want to provide the bug=# in commit message which
> > referred an issue on https://ticket.coreboot.org/issues?
> > Should I write bug=T220 or bug=b:220 for bug no 220?
>
> I'm not sure if there's a recommended way to reference coreboot tickets. I
> got confused when reading your first suggestion (because of the Lenovo
> Thinpad T520, T420, X220), and the second suggestion can be easily mistaken
> for a Google bugtracker issue.
>
> How about explicitly mentioning what the commit addresses/fixes? For
> example, somewhere on the commit message, say that "This commit addresses
> coreboot ticket #220." I believe this would be much clearer to future
> readers.
>
> *HIMANSHU SAHDEV*
> >
>
> Best regards,
>
> Angel
> >