Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 181255 - packages.gentoo.org - support hyperlink for bug#NNNNN convention
Summary: packages.gentoo.org - support hyperlink for bug#NNNNN convention
Status: RESOLVED INVALID
Alias: None
Product: Gentoo Infrastructure
Classification: Unclassified
Component: [OLD] gpackages (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Albert Hopkins (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-06-07 21:51 UTC by Alon Bar-Lev (RETIRED)
Modified: 2007-06-13 07:06 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alon Bar-Lev (RETIRED) gentoo-dev 2007-06-07 21:51:58 UTC
Hello,

Anton brought this to my attention...

It seems that packages.gentoo.org does not mark bug#NNNNN as a hyperlink... As it does for #NNNNN.
Can you please fix it so that both conventions will be supported?

Examples:
http://packages.gentoo.org/ebuilds/?truecrypt-4.3a
http://packages.gentoo.org/ebuilds/?cgi_multipart_eof_fix-2.1

Thanks!
Comment 1 Albert Hopkins (RETIRED) gentoo-dev 2007-06-12 12:21:45 UTC
Shouldn't "bug" and the number be two words?  I would consider this more a grammatical error than convention.
Comment 2 Alon Bar-Lev (RETIRED) gentoo-dev 2007-06-12 17:24:37 UTC
No.
Bugzilla convention is bug#181255
Comment 3 Daniel Drake (RETIRED) gentoo-dev 2007-06-12 18:13:27 UTC
I disagree as to that being a convention, see devmanual:
http://devmanual.gentoo.org/ebuild-writing/misc-files/changelog/index.html
The gentoo-syntax vim plugin also only recognises "bug #x" and not "bug#x".
Comment 4 Alon Bar-Lev (RETIRED) gentoo-dev 2007-06-12 18:21:30 UTC
dsd: I show it works with bugzilla... And as so it is a convention we all using.

I don't understand... Any reason not supporting this in Gentoo specific stuff?
Comment 5 Albert Hopkins (RETIRED) gentoo-dev 2007-06-12 18:33:19 UTC
$ cd /usr/portage
$ find . -name ChangeLog -print | xargs cat |awk '/#[0-9]/ { count++;} END { print count;}'
64983
$ find . -name ChangeLog -print | xargs cat |awk '/bug [0-9]/ { count++;} END { print count;}'  
11989
$ find . -name ChangeLog -print | xargs cat |awk '/bug#[0-9]/ { count++;} END { print count;}'  
197

I really would not consider a ratio like 0.25% to be "convention".  Seems to be more on par with my spelling "the" as "teh".

But regardless, would you not at least consider not having a [SPACE] between the word "bug" and the number to be bad style?  It is more difficult for users to read and I would rather it be discouraged.

This is an easy fix and I'm not at all trying to be lazy/resistant, I just think it's a bad idea. I'm hoping that at least if you do not agree you understand my motivation, or at least I will understand yours.

Leaving this bug open for discussion.
Comment 6 Alon Bar-Lev (RETIRED) gentoo-dev 2007-06-12 18:35:38 UTC
Well.
I don't really care.

I thought that we should be consistence... If the main bug system uses a convention we should line up.
Comment 7 Alon Bar-Lev (RETIRED) gentoo-dev 2007-06-12 18:37:22 UTC
comment #6
Comment 8 Anton Bolshakov 2007-06-12 23:25:37 UTC
There is one more thing. As you can see from examples above, some people use wrt acronym and write "wrt #181110", others put just a number. Does it mean they don't follow Gentoo Development Guide too?
Shouldn't it be "bug #181110" everytime without exception to be consistant?
Right now the log file looks messy:

  09 Jun 2007; Raúl Porcel <armin76@gentoo.org>
  x86 stable wrt #181110

  07 Jun 2007; Gustavo Zacarias <gustavoz@gentoo.org>
  Stable on sparc wrt #181110

  07 Jun 2007; Markus Rothe <corsair@gentoo.org>
  Stable on ppc64; bug #181110

  04 Apr 2007; Nguyễn Thái Ngọc Duy <pclouds@gentoo.org>
  Redigest, #173297

ps. I'm wondering how bugzilla will parse it without the space: wrt#181110, xxx#181110
Comment 9 Albert Hopkins (RETIRED) gentoo-dev 2007-06-13 00:25:48 UTC
(In reply to comment #8)
> There is one more thing. As you can see from examples above, some people use
> wrt acronym and write "wrt #181110", others put just a number. Does it mean
> they don't follow Gentoo Development Guide too?

It was Mr. Drake that made the comment about the Gentoo Development Guide.  I'll give him the opportunity to answer that question if he so chooses.

> Shouldn't it be "bug #181110" everytime without exception to be consistant?
> Right now the log file looks messy:

I don't know.  Probably yes, but that's not my argument. My concern is that it's all about readability/common sense.  I've seen wrt and I've also seen "fixes #xxxx", but they usually have a space between the two words. I don't mean to come off like Strunk and White, but doesn't it just make sense to have a space between them?  This is not program code where we are usually more limited to where we can use whitespace.  Changelogs are documents that are supposed to be read by humans.  Spaces between words (or acronyms) is something we're taught as soon as we learn how to read.  Now I'm not going to submit a bug/enhancement request every time I see a Changelog that uses bad style, but maybe not having the hyperlinks work will have some minor part in encouraging developers to do what I consider common sense in the first place.

> ps. I'm wondering how bugzilla will parse it without the space: wrt#181110,
> xxx#181110

I can't speak for bugzilla.  It's an entirely different piece of software and I'm not involved in it in any way.  All I can say is that if they do allow you to not have a whitespace around bug numbers then shame on them ;-)

ps.  On most keyboards the [SPACE] key is the biggest key (so big that's it's called the SPACE *bar*. Is it really that hard for you to use?
Comment 10 Daniel Drake (RETIRED) gentoo-dev 2007-06-13 02:06:27 UTC
I wasn't saying that "bug #1234" is a documented convention, neither was I saying that there is anything wrong with "bug#x", I was just pointing out that this is a matter of personal opinion and not a matter of convention.
Comment 11 Alon Bar-Lev (RETIRED) gentoo-dev 2007-06-13 07:06:47 UTC
And there is an edge condition... What about long paragraphs?

bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla bla bug
#181255 bla bla bla.

The "bug" is the type of "#NNNN", just like "comment#NNN" or "attachment#NNN".

Parsing only "#NNNN" was valid in old bugzilla and then modified to TTTT#NNNN to allow more flexible cross reference.