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

[Andrew Savchenko]

On Sun, 9 Aug 2015 21:56:05 +0200 Michał Górny wrote:
> Dnia 2015-08-09, o godz. 16:09:29
> hasufell <hasufell@g.o> 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