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

2015-08-10 Thread Ryan Hill
On Mon, 10 Aug 2015 23:43:29 +0300
Andrew Savchenko  wrote:

> On Mon, 10 Aug 2015 15:11:02 +0200 Michał Górny wrote:
> > > > > 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.
> > 
> > Not really. You are closer to the threshold when you are too lazy to
> > type it and you just copy-paste it.
> 
> Copy and pasting requires more time than typing 6 digits.
>  
> > > > > 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.
> > 
> > How is:
> > 
> >   Bug: 123451, 453445, 344334, 343444
> > 
> > more readable than:
> > 
> >   Bug: https://bugs.gentoo.org/123451
> >   Bug: https://bugs.gentoo.org/453445
> >   Bug: https://bugs.gentoo.org/344334
> >   Bug: https://bugs.gentoo.org/343444
> > 
> > Readability is a matter of formatting, not contents.
> 
> 1. One line and 35 chars are certainly more readable than four lines
> and 140 chars.

It isn't.  There's a reason why lists of things are generally written top to
bottom.  I found the second form to be much more readable.  In fact I was
generally against the URIs until I saw this.

> 2. Strings are read from left to right (at least in English), thus
> having most important information last on the line is not
> convenient.

Maybe if you were reading the whole line, but you're not.  You have built-in
pattern recognition.  Try it out.

> 3. A lot of duplicated and useless information consumes time and
> space, irritating people.

Arg, that is so irritating how I have easily-clickable machine-parsable links in
my git log. Look at all the space we could have saved!  How much time have I
wasted reading every character?!  Sorry kids, can't play, daddy's busy reading
commit logs.

No matter what we decide three months from now we won't remember arguing about
it.  So let's save some time an irritability now and pick something.



-- 
Ryan Hillpsn: dirtyepic_sk
   gcc-porting/toolchain/wxwidgets @ gentoo.org

47C3 6D62 4864 0E49 8E9E  7F92 ED38 BD49 957A 8463


pgpjwTP4s_CiU.pgp
Description: OpenPGP digital signature


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

2015-08-09 Thread Ryan Hill
On Mon, 10 Aug 2015 00:44:09 +0300
Andrew Savchenko  wrote:

> On Sun, 9 Aug 2015 21:56:05 +0200 Michał Górny wrote:
> > Dnia 2015-08-09, o godz. 16:09:29
> > hasufell  napisał(a):
> > 
> > > On 08/09/2015 03:58 PM, Michael Weber wrote:
> > > > commit: 40b3fd64ec9c5d6d94f0f0897740bc77622c24a1
> > > > Author: Michael Weber  gentoo  org>
> > > > AuthorDate: Sun Aug  9 13:58:26 2015 +
> > > > Commit: Michael Weber  gentoo  org>
> > > > CommitDate: Sun Aug  9 13:58:26 2015 +
> > > > 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
> 

Also the URL should be https://bugs.gentoo.org/557022 so already that's wrong.


-- 
Ryan Hillpsn: dirtyepic_sk
   gcc-porting/toolchain/wxwidgets @ gentoo.org

47C3 6D62 4864 0E49 8E9E  7F92 ED38 BD49 957A 8463


pgpSyBwzJyfPG.pgp
Description: OpenPGP digital signature