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

[Daniel Campbell (zlg)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 08/09/2015 02:11 PM, Michał Górny wrote:
> Dnia 2015-08-09, o godz. 23:01:32 hasufell <hasufell@g.o>
> napisał(a):
>
>> On 08/09/2015 09:56 PM, 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/b7149002bf23889f280c502afe
6ceda0b1345ca3
>>>>
>>>>
>>>>
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.
>
The issue with linking is that we may not be using show_bug.cgi (or
'id' in GET) forever. Bug numbers would be feasible to migrate outside
of Bugzilla, and technically a webserver can be used to translate
those URLs, but the important bit of information is the bug number.

I don't know about you guys, but I have a "smart bookmark" in Firefox
where I type "bgo xxxxxx" and it'll take me to the relevant bug. It'd
be trivial to set that up as a bash alias, too. There are tons of ways
to get to a bug; the important part is the bug number. I think putting
the URL in there adds extra work for us later down the road should we
migrate away from Bugzilla.

- -- 
Daniel Campbell - Gentoo Developer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCAAGBQJVx+oQAAoJEAEkDpRQOeFwoYwQAKSYfi2sXsYfghAsA/ym+sV9
aP6+1iTlOqxibYwfMrF5S6PeCIZDgfX/FMV41L344b2nchcOQz6JrgZ/iAWeOOHR
fvlzP1jz879P3xW2vktdOpEBK8j2Pz8M12qJuYLCM98u2mTqGKl6MieuTD5l5LDq
PASSyI1BckNcBDgiiI9IDkXzINLEYDIoTKCLvndyCBabeF+0ydRK9iX+iHHPhnG7
qz7AndjuSl6JbT0W6IPvkpssSFC67bfq2vEUows+Ek3CvhE/K+qcopcbnJjJyfsf
0ELaKUzNgioW6blX/uQK6pfs5QIsZpfM/mhrMa5y03a7b+JZUt+HEsyh8hmSf7lP
LhfOnV+h4EAAREFdYa9MI1Hn+rZ/lfTOY1Gp0pHFKAX9cu7Xhxn6uu9he6M8EOPG
es03hoB5cyzvsBJ/r7OggySidXeovtFVdPuPDkom82KqqrB/qG9qM458u4d8uWh/
y3nMLKCPuOiKL981RNijXwjZ5MKxSFrgrutgEQ+tJfiLfncz8ySmqNjrP2DJQBwi
+vK7/trpooh//6yEFVq+MYH8COqFzQrImkHe4OprrxQFBTLeCfVwMp15Usw73Wbh
D8+7rW2uz9TYqBom/dAdEzLNO00DKpJpp724k4RXsE6FCeT2N+6vIJZfyNTiB8f1
ohES4L5gJI3GZnr556G3
=pxsK
-----END PGP SIGNATURE-----