Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

classic Classic list List threaded Threaded
82 messages Options
12345
Reply | Threaded
Open this post in threaded view
|

Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

hasufell
On 08/09/2015 03:58 PM, Michael Weber wrote:
> commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
> AuthorDate: Sun Aug  9 13:58:26 2015 +0000
> Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
> CommitDate: Sun Aug  9 13:58:26 2015 +0000
> URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
>
> sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
>

I was wondering if we should set a standard for referencing bug reports.
The portage team already does something like that:
https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3

Following that, the commit could have been:
=====
sci-libs/opencascade: add USE=vtk

thanks to Helmut Jarausch

X-Gentoo-Bug: 557022
X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
=====

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Ian Whyman-3
On 9 August 2015 at 15:09, hasufell <[hidden email]> wrote:
On 08/09/2015 03:58 PM, Michael Weber wrote:
> commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
> AuthorDate: Sun Aug  9 13:58:26 2015 +0000
> Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
> CommitDate: Sun Aug  9 13:58:26 2015 +0000
> URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
>
> sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
>

I was wondering if we should set a standard for referencing bug reports.
The portage team already does something like that:
https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3

Following that, the commit could have been:
=====
sci-libs/opencascade: add USE=vtk

thanks to Helmut Jarausch

X-Gentoo-Bug: 557022
X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
=====


Having the URL and number seems like a duplication of effort, but X-Gentoo-Bug works for me.

--
Ian Whyman
www.gentoo.org
Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Dirkjan Ochtman-3
In reply to this post by hasufell
On Sun, Aug 9, 2015 at 4:09 PM, hasufell <[hidden email]> wrote:

> I was wondering if we should set a standard for referencing bug reports.
> The portage team already does something like that:
> https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
>
> Following that, the commit could have been:
> =====
> sci-libs/opencascade: add USE=vtk
>
> thanks to Helmut Jarausch
>
> X-Gentoo-Bug: 557022
> X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
> =====

I don't really see why it has to be so verbose. Can we just make it
"bug 557022", or even #557022? That would also make it fit better if
you have a single-line commit message only.

Cheers,

Dirkjan

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

hasufell
On 08/09/2015 04:26 PM, Dirkjan Ochtman wrote:

> On Sun, Aug 9, 2015 at 4:09 PM, hasufell <[hidden email]> wrote:
>> I was wondering if we should set a standard for referencing bug reports.
>> The portage team already does something like that:
>> https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
>>
>> Following that, the commit could have been:
>> =====
>> sci-libs/opencascade: add USE=vtk
>>
>> thanks to Helmut Jarausch
>>
>> X-Gentoo-Bug: 557022
>> X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
>> =====
>
> I don't really see why it has to be so verbose. Can we just make it
> "bug 557022", or even #557022? That would also make it fit better if
> you have a single-line commit message only.
>

I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
parse commit messages.


Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Dirkjan Ochtman-3
On Sun, Aug 9, 2015 at 4:38 PM, hasufell <[hidden email]> wrote:
>> I don't really see why it has to be so verbose. Can we just make it
>> "bug 557022", or even #557022? That would also make it fit better if
>> you have a single-line commit message only.
>
> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
> parse commit messages.

I don't. Just the "bug " prefix should be fine for almost all
purposes, even for tools.

Also, https://tools.ietf.org/html/rfc6648.

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

hasufell
On 08/09/2015 04:43 PM, Dirkjan Ochtman wrote:

> On Sun, Aug 9, 2015 at 4:38 PM, hasufell <[hidden email]> wrote:
>>> I don't really see why it has to be so verbose. Can we just make it
>>> "bug 557022", or even #557022? That would also make it fit better if
>>> you have a single-line commit message only.
>>
>> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
>> parse commit messages.
>
> I don't. Just the "bug " prefix should be fine for almost all
> purposes, even for tools.
>
> Also, https://tools.ietf.org/html/rfc6648.
>

That can be ambiguous, because it isn't clear whether you are
referencing a gentoo bug. You can reference bugs from other bugtrackers
as well.

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Michael Orlitzky
In reply to this post by Dirkjan Ochtman-3
On 08/09/2015 10:43 AM, Dirkjan Ochtman wrote:

> On Sun, Aug 9, 2015 at 4:38 PM, hasufell <[hidden email]> wrote:
>>> I don't really see why it has to be so verbose. Can we just make it
>>> "bug 557022", or even #557022? That would also make it fit better if
>>> you have a single-line commit message only.
>>
>> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
>> parse commit messages.
>
> I don't. Just the "bug " prefix should be fine for almost all
> purposes, even for tools.
>
> Also, https://tools.ietf.org/html/rfc6648.
>

There's a "standard" set of patch tags all in the style of RFC822
headers -- Signed-off-by, Acked-by, Suggested-by, etc. are all common:

  https://www.kernel.org/doc/Documentation/SubmittingPatches

X-Gentoo-Bug is just following that example for metadata.


Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Sven Vermeulen
In reply to this post by Dirkjan Ochtman-3
On Sun, Aug 09, 2015 at 04:43:36PM +0200, Dirkjan Ochtman wrote:
> > I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
> > parse commit messages.
>
> I don't. Just the "bug " prefix should be fine for almost all
> purposes, even for tools.

I'm pretty sure the majority of developers don't care that one developer
uses "X-Gentoo-Bug" and another just adds it to the commit title.

I like /guidelines/ in the sense that, if I don't know something, I can look
it up. But don't make it mandatory until we start depending on it (for
instance, when we would automate stuff based on the content of the commit
message).

Wkr,
        Sven Vermeulen

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

hasufell
On 08/09/2015 05:03 PM, Sven Vermeulen wrote:

> On Sun, Aug 09, 2015 at 04:43:36PM +0200, Dirkjan Ochtman wrote:
>>> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
>>> parse commit messages.
>>
>> I don't. Just the "bug " prefix should be fine for almost all
>> purposes, even for tools.
>
> I'm pretty sure the majority of developers don't care that one developer
> uses "X-Gentoo-Bug" and another just adds it to the commit title.
>
> I like /guidelines/ in the sense that, if I don't know something, I can look
> it up. But don't make it mandatory until we start depending on it (for
> instance, when we would automate stuff based on the content of the commit
> message).
>

At the time we decide to depend on it, it will already be useless for
the complete past history, because some people did it... and others not.

Deciding on such things early on is a good idea, especially for a
project as big as gentoo. That is... if we want our history to be useful.


Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Tobias Klausmann-4
In reply to this post by Sven Vermeulen
Hi!

On Sun, 09 Aug 2015, Sven Vermeulen wrote:

> On Sun, Aug 09, 2015 at 04:43:36PM +0200, Dirkjan Ochtman wrote:
> > > I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
> > > parse commit messages.
> >
> > I don't. Just the "bug " prefix should be fine for almost all
> > purposes, even for tools.
>
> I'm pretty sure the majority of developers don't care that one developer
> uses "X-Gentoo-Bug" and another just adds it to the commit title.
>
> I like /guidelines/ in the sense that, if I don't know something, I can look
> it up. But don't make it mandatory until we start depending on it (for
> instance, when we would automate stuff based on the content of the commit
> message).

I'd just go with "Gentoo-Bug". The X- is pointless since it was
for eXtending Email-Headers. And what we do is only linked in
style.

Regards,
Tobias

--
Sent from aboard the Culture ship
        (ex) General Transport Craft (Interstellar-class) Now We Try It My Way

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

hasufell
On 08/09/2015 05:19 PM, Tobias Klausmann wrote:

> Hi!
>
> On Sun, 09 Aug 2015, Sven Vermeulen wrote:
>
>> On Sun, Aug 09, 2015 at 04:43:36PM +0200, Dirkjan Ochtman wrote:
>>>> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
>>>> parse commit messages.
>>>
>>> I don't. Just the "bug " prefix should be fine for almost all
>>> purposes, even for tools.
>>
>> I'm pretty sure the majority of developers don't care that one developer
>> uses "X-Gentoo-Bug" and another just adds it to the commit title.
>>
>> I like /guidelines/ in the sense that, if I don't know something, I can look
>> it up. But don't make it mandatory until we start depending on it (for
>> instance, when we would automate stuff based on the content of the commit
>> message).
>
> I'd just go with "Gentoo-Bug". The X- is pointless since it was
> for eXtending Email-Headers. And what we do is only linked in
> style.
>

I'd be fine with that and add a reference to the kernel guideline [0] to
the wiki as well, so that it is clear that we also allow/use Acked-by,
Reviewed-by, Suggested-by and whatnot.

I'll wait for more ++ though.


[0] https://www.kernel.org/doc/Documentation/SubmittingPatches

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Mike Gilbert-2
On Sun, Aug 9, 2015 at 11:30 AM, hasufell <[hidden email]> wrote:

> On 08/09/2015 05:19 PM, Tobias Klausmann wrote:
>> Hi!
>>
>> On Sun, 09 Aug 2015, Sven Vermeulen wrote:
>>
>>> On Sun, Aug 09, 2015 at 04:43:36PM +0200, Dirkjan Ochtman wrote:
>>>>> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
>>>>> parse commit messages.
>>>>
>>>> I don't. Just the "bug " prefix should be fine for almost all
>>>> purposes, even for tools.
>>>
>>> I'm pretty sure the majority of developers don't care that one developer
>>> uses "X-Gentoo-Bug" and another just adds it to the commit title.
>>>
>>> I like /guidelines/ in the sense that, if I don't know something, I can look
>>> it up. But don't make it mandatory until we start depending on it (for
>>> instance, when we would automate stuff based on the content of the commit
>>> message).
>>
>> I'd just go with "Gentoo-Bug". The X- is pointless since it was
>> for eXtending Email-Headers. And what we do is only linked in
>> style.
>>
>
> I'd be fine with that and add a reference to the kernel guideline [0] to
> the wiki as well, so that it is clear that we also allow/use Acked-by,
> Reviewed-by, Suggested-by and whatnot.
>
> I'll wait for more ++ though.

I like Gentoo-Bug. Much nicer without the X-.

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Davide Pesavento-2
On Sun, Aug 9, 2015 at 8:43 AM, Mike Gilbert <[hidden email]> wrote:

> On Sun, Aug 9, 2015 at 11:30 AM, hasufell <[hidden email]> wrote:
>> On 08/09/2015 05:19 PM, Tobias Klausmann wrote:
>>> Hi!
>>>
>>> On Sun, 09 Aug 2015, Sven Vermeulen wrote:
>>>
>>>> On Sun, Aug 09, 2015 at 04:43:36PM +0200, Dirkjan Ochtman wrote:
>>>>>> I think "X-Gentoo-Bug: 557022" also makes the job easier for tools that
>>>>>> parse commit messages.
>>>>>
>>>>> I don't. Just the "bug " prefix should be fine for almost all
>>>>> purposes, even for tools.
>>>>
>>>> I'm pretty sure the majority of developers don't care that one developer
>>>> uses "X-Gentoo-Bug" and another just adds it to the commit title.
>>>>
>>>> I like /guidelines/ in the sense that, if I don't know something, I can look
>>>> it up. But don't make it mandatory until we start depending on it (for
>>>> instance, when we would automate stuff based on the content of the commit
>>>> message).
>>>
>>> I'd just go with "Gentoo-Bug". The X- is pointless since it was
>>> for eXtending Email-Headers. And what we do is only linked in
>>> style.
>>>
>>
>> I'd be fine with that and add a reference to the kernel guideline [0] to
>> the wiki as well, so that it is clear that we also allow/use Acked-by,
>> Reviewed-by, Suggested-by and whatnot.
>>
>> I'll wait for more ++ though.
>
> I like Gentoo-Bug. Much nicer without the X-.
>

+1 for Gentoo-Bug (or Gentoo-bug? not sure about the capitalization)

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Michał Górny-5
In reply to this post by hasufell
Dnia 2015-08-09, o godz. 16:09:29
hasufell <[hidden email]> napisał(a):

> On 08/09/2015 03:58 PM, Michael Weber wrote:
> > commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> > Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
> > AuthorDate: Sun Aug  9 13:58:26 2015 +0000
> > Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
> > CommitDate: Sun Aug  9 13:58:26 2015 +0000
> > URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
> >
> > sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
> >
>
> I was wondering if we should set a standard for referencing bug reports.
> The portage team already does something like that:
> https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
>
> Following that, the commit could have been:
> =====
> sci-libs/opencascade: add USE=vtk
>
> thanks to Helmut Jarausch
>
> X-Gentoo-Bug: 557022
> X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
> =====
Which is terribly redundant. Just put the whole bug URL. Advantages:

- keeps the bug namespaced to bugs.gentoo.org,
- has the bug no inside,
- is convenient -- you can click it instead of copy-pasting the no.

Also there are some standard keywords that are sometimes used to
reference bugs, like 'Fixes:' used by x.org.

--
Best regards,
Michał Górny
<http://dev.gentoo.org/~mgorny/>

attachment0 (968 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

hasufell
On 08/09/2015 09:56 PM, Michał Górny wrote:

> Dnia 2015-08-09, o godz. 16:09:29
> hasufell <[hidden email]> napisał(a):
>
>> On 08/09/2015 03:58 PM, Michael Weber wrote:
>>> commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
>>> Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
>>> AuthorDate: Sun Aug  9 13:58:26 2015 +0000
>>> Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
>>> CommitDate: Sun Aug  9 13:58:26 2015 +0000
>>> URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
>>>
>>> sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
>>>
>>
>> I was wondering if we should set a standard for referencing bug reports.
>> The portage team already does something like that:
>> https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
>>
>> Following that, the commit could have been:
>> =====
>> sci-libs/opencascade: add USE=vtk
>>
>> thanks to Helmut Jarausch
>>
>> X-Gentoo-Bug: 557022
>> X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
>> =====
>
> Which is terribly redundant. Just put the whole bug URL. Advantages:
>
> - keeps the bug namespaced to bugs.gentoo.org,
> - has the bug no inside,
> - is convenient -- you can click it instead of copy-pasting the no.
>
> Also there are some standard keywords that are sometimes used to
> reference bugs, like 'Fixes:' used by x.org.
>

I am not sure what exactly you do propose.

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Michał Górny-5
Dnia 2015-08-09, o godz. 23:01:32
hasufell <[hidden email]> napisał(a):

> On 08/09/2015 09:56 PM, Michał Górny wrote:
> > Dnia 2015-08-09, o godz. 16:09:29
> > hasufell <[hidden email]> napisał(a):
> >
> >> On 08/09/2015 03:58 PM, Michael Weber wrote:
> >>> commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> >>> Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
> >>> AuthorDate: Sun Aug  9 13:58:26 2015 +0000
> >>> Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
> >>> CommitDate: Sun Aug  9 13:58:26 2015 +0000
> >>> URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
> >>>
> >>> sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
> >>>
> >>
> >> I was wondering if we should set a standard for referencing bug reports.
> >> The portage team already does something like that:
> >> https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
> >>
> >> Following that, the commit could have been:
> >> =====
> >> sci-libs/opencascade: add USE=vtk
> >>
> >> thanks to Helmut Jarausch
> >>
> >> X-Gentoo-Bug: 557022
> >> X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
> >> =====
> >
> > Which is terribly redundant. Just put the whole bug URL. Advantages:
> >
> > - keeps the bug namespaced to bugs.gentoo.org,
> > - has the bug no inside,
> > - is convenient -- you can click it instead of copy-pasting the no.
> >
> > Also there are some standard keywords that are sometimes used to
> > reference bugs, like 'Fixes:' used by x.org.
> >
>
> I am not sure what exactly you do propose.
Fixes: https://bugs.gentoo.org/show_bug.cgi?id=557022
References: https://bugs.gentoo.org/show_bug.cgi?id=557022
X-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=557022
Whatever: https://bugs.gentoo.org/show_bug.cgi?id=557022

Just no magical numbers which are meaningless without the context.

--
Best regards,
Michał Górny
<http://dev.gentoo.org/~mgorny/>

attachment0 (968 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Rich Freeman
On Sun, Aug 9, 2015 at 5:11 PM, Michał Górny <[hidden email]> wrote:
> X-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=557022

How about just:
Bug-URL: xxx
or Bug: xxx

X- is not recommended as a prefix for the various reasons already
well-stated by the IETF in the previously-linked RFC.

--
Rich

Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Andrew Savchenko
In reply to this post by Michał Górny-5
On Sun, 9 Aug 2015 21:56:05 +0200 Michał Górny wrote:

> Dnia 2015-08-09, o godz. 16:09:29
> hasufell <[hidden email]> napisał(a):
>
> > On 08/09/2015 03:58 PM, Michael Weber wrote:
> > > commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> > > Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
> > > AuthorDate: Sun Aug  9 13:58:26 2015 +0000
> > > Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
> > > CommitDate: Sun Aug  9 13:58:26 2015 +0000
> > > URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
> > >
> > > sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
> > >
> >
> > I was wondering if we should set a standard for referencing bug reports.
> > The portage team already does something like that:
> > https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
> >
> > Following that, the commit could have been:
> > =====
> > sci-libs/opencascade: add USE=vtk
> >
> > thanks to Helmut Jarausch
> >
> > X-Gentoo-Bug: 557022
> > X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
> > =====
>
> Which is terribly redundant. Just put the whole bug URL. Advantages:
>
> - keeps the bug namespaced to bugs.gentoo.org,
> - has the bug no inside,
> - is convenient -- you can click it instead of copy-pasting the no.
1. URL may change in future, bug number — unlikely.
2. Bug number can be easily typed, URL has to be copied or
generated by some tool.
3. Too many text, hard to read. Some bugs may refer to a dozen of
URLs.
4. It is easier to copy a number, than selecting and copying whole
string. Not all terminals support running browser on URL click.
5. Clicking is less convenient than typing "bugs search $number" —
user have to move hands from a keyboard to a mouse — a terrible
waste of time, at least in my case with my typing speed.

Best regards,
Andrew Savchenko

attachment0 (836 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Michał Górny-5
Dnia 2015-08-10, o godz. 00:44:09
Andrew Savchenko <[hidden email]> napisał(a):

> On Sun, 9 Aug 2015 21:56:05 +0200 Michał Górny wrote:
> > Dnia 2015-08-09, o godz. 16:09:29
> > hasufell <[hidden email]> napisał(a):
> >
> > > On 08/09/2015 03:58 PM, Michael Weber wrote:
> > > > commit:     40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> > > > Author:     Michael Weber <xmw <AT> gentoo <DOT> org>
> > > > AuthorDate: Sun Aug  9 13:58:26 2015 +0000
> > > > Commit:     Michael Weber <xmw <AT> gentoo <DOT> org>
> > > > CommitDate: Sun Aug  9 13:58:26 2015 +0000
> > > > URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=40b3fd64
> > > >
> > > > sci-libs/opencascade: add USE=vtk (bug 557022, thanks Helmut Jarausch).
> > > >
> > >
> > > I was wondering if we should set a standard for referencing bug reports.
> > > The portage team already does something like that:
> > > https://github.com/gentoo/portage/commit/b7149002bf23889f280c502afe6ceda0b1345ca3
> > >
> > > Following that, the commit could have been:
> > > =====
> > > sci-libs/opencascade: add USE=vtk
> > >
> > > thanks to Helmut Jarausch
> > >
> > > X-Gentoo-Bug: 557022
> > > X-Gentoo-Bug-url: https://bugs.gentoo.org/show_bug.cgi?id=557022
> > > =====
> >
> > Which is terribly redundant. Just put the whole bug URL. Advantages:
> >
> > - keeps the bug namespaced to bugs.gentoo.org,
> > - has the bug no inside,
> > - is convenient -- you can click it instead of copy-pasting the no.
>
> 1. URL may change in future, bug number — unlikely.
If the URL changes, we need to provide backwards compatibility. Too
many resources already depend on that.

> 2. Bug number can be easily typed, URL has to be copied or
> generated by some tool.

So, please remind me, how many times the 'easy typing' got the bug
number wrong? This is not a real argument, just another of Gentoo's
'I'm too lazy to do things right'.

> 3. Too many text, hard to read. Some bugs may refer to a dozen of
> URLs.

And how is a dozen numbers better?

> 4. It is easier to copy a number, than selecting and copying whole
> string. Not all terminals support running browser on URL click.

So we should optimize for a corner case?

> 5. Clicking is less convenient than typing "bugs search $number" —
> user have to move hands from a keyboard to a mouse — a terrible
> waste of time, at least in my case with my typing speed.

You can type the number you see at the end of the URL. If you really
want to go l33t, that shouldn't a problem for you.

--
Best regards,
Michał Górny
<http://dev.gentoo.org/~mgorny/>

attachment0 (968 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Referencing bug reports in git (WAS: Re: [gentoo-commits] repo/gentoo:master commit in: sci-libs/opencascade/)

Andrew Savchenko
On Mon, 10 Aug 2015 00:40:44 +0200 Michał Górny wrote:

> > > Which is terribly redundant. Just put the whole bug URL. Advantages:
> > >
> > > - keeps the bug namespaced to bugs.gentoo.org,
> > > - has the bug no inside,
> > > - is convenient -- you can click it instead of copy-pasting the no.
> >
> > 1. URL may change in future, bug number — unlikely.
>
> If the URL changes, we need to provide backwards compatibility. Too
> many resources already depend on that.
>
> > 2. Bug number can be easily typed, URL has to be copied or
> > generated by some tool.
>
> So, please remind me, how many times the 'easy typing' got the bug
> number wrong? This is not a real argument, just another of Gentoo's
> 'I'm too lazy to do things right'.
URLs are longer, so probability of error during typing increases
compared to raw numbers.
 
> > 3. Too many text, hard to read. Some bugs may refer to a dozen of
> > URLs.
>
> And how is a dozen numbers better?

Less text, more readable.
 
> > 4. It is easier to copy a number, than selecting and copying whole
> > string. Not all terminals support running browser on URL click.
>
> So we should optimize for a corner case?

What is a corner case? Why not defining "clicking on the link in
the git log" as a corner case?

> > 5. Clicking is less convenient than typing "bugs search $number" —
> > user have to move hands from a keyboard to a mouse — a terrible
> > waste of time, at least in my case with my typing speed.
>
> You can type the number you see at the end of the URL. If you really
> want to go l33t, that shouldn't a problem for you.
 
This is not a matter of going l33t, this is a matter of getting rid
of redundant and pretty much useless data all the same through
almost all commit messages.

Best regards,
Andrew Savchenko

attachment0 (836 bytes) Download Attachment
12345