Differences between revisions 25 and 26
Revision 25 as of 2013-05-25 03:51:51
Size: 10050
Comment: remove broken link to http://halbgar.com/english/bts-usercategories.2007-11-08-07-00.html
Revision 26 as of 2016-01-28 16:32:46
Size: 10485
Editor: OsamuAoki
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
<!> This is now documented in the [[http://www.debian.org/Bugs/server-request#user|Debian web site]], and as such, this page might need cleanup now. == Tags and usertags ==
Line 3: Line 3:
The [[BTS]] supports tagging mechanisms to organize and manage bugs:
 * [[http://www.debian.org/Bugs/Developer#tags|global tags]]
  * global pre-defined '''tags''': patch, wontfix, moreinfo, unreproducible, help, pending, security, upstream, confirmed, fixed, fixed-upstream, fixed-in-experimental, d-i, ipv6, lfs, l10n, potato, woody, sarge, sarge-ignore, etch, etch-ignore, lenny, lenny-ignore, squeeze, squeeze-ignore, wheezy, wheezy-ignore, jessie, jessie-ignore, sid, experimental
 * [[https://www.debian.org/Bugs/server-request#usertag|user tags]]
  * free-form '''usertags''' associated with a '''user'''
Line 4: Line 9:
== Context == There are 2 typical use cases of the '''usertags''':
 * package centric '''usertags''' which use the e-mail address ''packagename''@packages.debian.org for '''user'''
 * personal or team '''usertags''' which use an e-mail address for '''user'''
Line 6: Line 13:
Aside from the set of [[http://www.debian.org/Bugs/Developer#tags|global tags]] (such as ''lenny'', ''fixed-upstream'' etc.), the [[BTS]] also supports putting free-form tags on bugs. Such free-form tags are called 'usertags' and are always associated with a 'user', identified by an email address. The email address is not important and doesn't even need to be valid. It just provides a namespace for the tag to exist in. This means there is no need to co-ordinate a central list of tags (and that there is no way to get a list of existing tags). == Package centric usertags ==
Line 8: Line 15:
Usertags can be used for 'personal' tags, but are more usually used to help teams manage 'their' bugs. In that case, a list address may be used, for example as in: The use of package centric '''usertags''' enables to organize the default BTS package view if [[https://www.debian.org/Bugs/server-request#usercategory|usercategory]] is set for the package. See [[https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=no&src=devscripts|BTS for devscripts]] as an example.
Line 10: Line 17:
  http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=lsb;users=debian-lsb@lists.debian.org Here are some typical cases:
Line 12: Line 19:
If a bug report is on the {{{bts}}} command in the {{{devscripts}}} package with its version ''1.0'', you set the pseudo-header '''User:''' to ''devscripts@packages.debian.org'' and '''Usertags:''' to ''bts'' as:
{{{
Package: devscripts
Version: 1.0
User: devscripts@packages.debian.org
Usertags: bts
Line 13: Line 26:
== Add usertags to bugs == bugreport...
}}}
Line 15: Line 29:
Currently the best documentation on using usertags is the [[http://lists.debian.org/debian-devel-announce/2005/09/msg00002.html|original announcement by aj]] - perhaps this information should be copied somewhere and maintained (perhaps here?).

You can tag existing bugs by sending email to control@bugs.debian.org of this format:
If you wish to set '''usertags''' to ''bts'' for an bug# 12345, you send an e-mail to control@bugs.debian.org with the following content:
Line 20: Line 32:
user user@domain.tld
usertags <#bug> <tagname>
usertags ...
user devscripts@packages.debian.org
usertags 12345 bts
Line 27: Line 38:
or using bts command (from devscripts package): Alternatively, you may use the {{{bts}}} command from the shell as:
Line 29: Line 40:
{{{bts user 'user@domain.tld' , usertags <#bug> <tagname> , usertags ... , ...}}}

Using a colon in the email to control@d.o will result in errors. Eg:
 usertags: <#bug> <tagname>
Produces '''Unknown command or malformed arguments to command.'''

You can also set a usertag in an initial email to submit@bugs.debian.org:
Line 37: Line 41:
Package: foo
Version: version
User: user@domain.tld
Usertags: tag

bugreport...
 $ bts user devscripts@packages.debian.org , usertags 12345 bts
Line 45: Line 44:
== Display usertags on the web BTS view == The tweaking of [[https://www.debian.org/Bugs/server-request#usercategory|usercategory]] should be done '''only''' by people involved with resolving bugs.
Line 47: Line 46:
You're half-way now; it you want a nice packages bugs list like [[http://bugs.debian.org/devscripts|devscripts]] (with tag to group up bugs), then you need to use {{{usercategory}}} in an email to control@bugs.debian.org ([[http://www.erisian.com.au/wordpress/2005/10/10/usercategories-and-other-miscellania|some more information]]): == Personal or team usertags ==

The use of personal or team '''usertag''' enables to organize the user specific BTS package view associated to a '''user''' identified by a personal e-mail address or a team e-mail address.

  * http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=lsb;users=debian-lsb@lists.debian.org
  * Bug-Urls listed in [[https://release.debian.org/lenny/goals.txt|lenny release goal]]

The email address is not important and doesn't even need to be valid. It just provides a namespace for the tag to exist in. This means there is no need to co-ordinate a central list of tags (and that there is no way to get a list of existing tags).

If you wish to mark bug# 12345 as ''todo'', use the {{{bts}}} command from the shell as:
Line 50: Line 58:
user user@domain.tld
usercategory <cat-name>
 * <place a name here> [tag=]
 + <tag1> [<tag1>]
 + <tag2> [<tag2>]
   ...
 + <tagN> [<tagN>]
 + Uncategorized []
usercategory normal
 * status
 * <cat-name>
 * severity
usercategory <pkg>-sort
 * status
 * <cat-name>
 * severity
usercategory old
 * status
 * severity
 * classification
 $ bts user foo@example.org , usertags 12345 todo
Line 72: Line 61:
To view the bug page thus ordered, you simply can add the following to your query URL:
{{{
 ;users=user@domain.tld;ordering=<category name>
}}}
where {{{user@domain.tld}}} is the name used above (defaults to {{{<pkg>@packages.debian.org}}}) and {{{<category name>}}} is one of the categories above (defaults to {{{normal}}}).
Then, you can see all bugs with the ''todo'' usertags with http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=todo;users=foo@example.org
Line 78: Line 63:

== Display usertags on the default BTS package view ==
== Note on usercategory and display ==
Line 96: Line 79:
 * The official documentation
  * [[user|https://www.debian.org/Bugs/server-request#user]]
  * [[usertags|https://www.debian.org/Bugs/server-request#usertags]]
  * [[usercategory|https://www.debian.org/Bugs/server-request#usercategory]]
Line 98: Line 85:
 * [[http://www.erisian.com.au/wordpress/2005/10/10/usercategories-and-other-miscellania|some more information]]

Tags and usertags

The BTS supports tagging mechanisms to organize and manage bugs:

  • global tags

    • global pre-defined tags: patch, wontfix, moreinfo, unreproducible, help, pending, security, upstream, confirmed, fixed, fixed-upstream, fixed-in-experimental, d-i, ipv6, lfs, l10n, potato, woody, sarge, sarge-ignore, etch, etch-ignore, lenny, lenny-ignore, squeeze, squeeze-ignore, wheezy, wheezy-ignore, jessie, jessie-ignore, sid, experimental

  • user tags

    • free-form usertags associated with a user

There are 2 typical use cases of the usertags:

  • package centric usertags which use the e-mail address packagename@packages.debian.org for user

  • personal or team usertags which use an e-mail address for user

Package centric usertags

The use of package centric usertags enables to organize the default BTS package view if usercategory is set for the package. See BTS for devscripts as an example.

Here are some typical cases:

If a bug report is on the bts command in the devscripts package with its version 1.0, you set the pseudo-header User: to devscripts@packages.debian.org and Usertags: to bts as:

Package: devscripts
Version: 1.0
User: devscripts@packages.debian.org
Usertags: bts

bugreport...

If you wish to set usertags to bts for an bug# 12345, you send an e-mail to control@bugs.debian.org with the following content:

user devscripts@packages.debian.org
usertags 12345 bts
...
thanks

Alternatively, you may use the bts command from the shell as:

 $ bts user devscripts@packages.debian.org , usertags 12345 bts

The tweaking of usercategory should be done only by people involved with resolving bugs.

Personal or team usertags

The use of personal or team usertag enables to organize the user specific BTS package view associated to a user identified by a personal e-mail address or a team e-mail address.

The email address is not important and doesn't even need to be valid. It just provides a namespace for the tag to exist in. This means there is no need to co-ordinate a central list of tags (and that there is no way to get a list of existing tags).

If you wish to mark bug# 12345 as todo, use the bts command from the shell as:

 $ bts user foo@example.org , usertags 12345 todo

Then, you can see all bugs with the todo usertags with http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=todo;users=foo@example.org

Note on usercategory and display

Use <pkg>@packages.debian.org as user@domain.tld (only if you are actually from that team).

  1. pay attention at the order you write the tags in the usercategory, since it will be the same order the tags will show up on the BTS page.

  2. when you add a tag to bugs, you need to modify the usercategory to treat that tag too (I don't like this, but that's the way it is).

  3. you can add a usertag to usercategory even if no bug is usertagged (yet) with it: it will appears as soon a some bugs will have that usertag.

  4. usertag name can have only alphanumerics, at, dot, plus and dash, while <cat> in <cat> [<tag>] can have underscore too (maybe other chars, untested).

Comments

Comments about usertags can go on this page...

from #debian-mentors:

<pabs3> ooh, usertags
<pabs3> bts++
<Nigel> pabs3: i thought it was a random users suggestion at first, was about to reply, "HAHAHA, they will never do that"
<pabs3> :)
<pabs3> aj does roxor
<Nigel> yeah
<Nigel> i must go and set usertags on all my bugs now...
<Nigel> i must say the following though: it'd be nice for the maintainer to get a copy of all tags set...
<pabs3> yeah, indeed
<Nigel> also, it'd be nice if there was a link up the top now, with "Maintainers Tags"
<Nigel> or (dunno if this defeats the purpose) set it up so tags set against the maintainer's email address, or the package@packages.d.o addy shown by default...
<pabs3> even better, add a thing to reqest@ for advertising usertags by default for a certain user/package/etc combo
<pabs3> adding it to the wiki page :)


  • After playing around with usertags a bit for the purpose of using them for tracking bugs about non-DFSG-free documentation, here some thoughts about further improvements:

One could add a option to the CGI to select a predefined categorisation class. I would like to say something like

 Example 1:
 ...;class0=Status;nam1=myown;pri1=...;ttl1=...;class2=Severity

Another useful addition could be to be able to globally rearrange the ordering of the categories. If I have used example 1 and now I want to rearrange the categorisation to move Severity to the top level I currently would have to do that (we assume for a moment the class parameters would actually work):

 Example 2:
 ...;class1=Status;nam2=myown;pri2=...;ttl2=...;class0=Severity
 better:
 ...;class0=Status;nam1=myown;pri1=...;ttl1=...;class2=Severity;ord=1,2,0

Here my first tries with categorisation together with usertags:

by ?FrankLichtenheld


  • I've started to use usertags to track QA issues, using "proposed-{removal,orphan}" on bugs that I've filed on very old and rc-buggy packages. At the moment, I'm using this to track my bugs (as they were filed yesterday, I don't have much experience yet). It's quite useful, but the long URIs are not ideal, so I second Frank's request for a way to specify standard classifications in a shorter way.

It would also be very nice to use the package a bug is filed against to divide them into sections. I'd like to use something like this:

   tag=proposed-orphan,proposed-removal;
   users=debian-qa@lists.debian.org;
   ...
   nam1=Status;pri1=pkg:ftp.debian.org,wnpp;
   ttl1=Pending removal,Waiting for adoption,No answer yet;
   ord1=2,1,0

by ?MarcBrockschmidt


  • Couldn't we show the usertags of packagename@packages.debian.org by default on the BTS site of packagename? Like this the maintainer could categorise the bugs with a set of his own tags and all users could see them.

(This is done.)


  • I've created a page, OngoingTransitions, that tracks library transitions in unstable. It'd be nice to have support for classifying by "is there a tag by this user set?", in order to separate claimed bugs (by bugsquash@qa.debian.org ).ç

--?AdeodatoSimo



  • The testing security team tags bugs with their CVE id (ie, CVE-2005-0001) and also uses a "tracked" tag to indicate security bugs that they are tracking and find ones they are not. These tags are added automatically based on info in their database. Set users= debian-security@lists.debian.org to see these tags.

Here's a useful view in the BTS: http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=security;users=debian-security@lists.debian.org;ordering=tracked