← Back to branch summary

~vcs-imports/bts-lin/trunk

« back to all changes in this revision

Viewing changes to htdocs/index.txt

  • Committer: Pierre Habouzit
  • Date: 2007-06-16 22:46:53 UTC
  • Revision ID: git-v1:dd866ed351d03fb8f3549498a8004c293737d836
Renames

Signed-off-by: Pierre Habouzit <madcoder@debian.org>

Show diffs side-by-side

added added

removed removed

Lines of Context:
htdocs/index.txt
 
1
bts-link
 
2
========
 
3
 
 
4
******************************************************************************
 
5
This page tries to explain quickly how 'bts-link' work, and to answer most of
 
6
the usual questions people have with it.
 
7
 
 
8
If you need more extensive informations about it, please contact my author:
 
9
mailto:madcoder@debian.org[Pierre Habouzit], or even better the
 
10
mailto:bts-link-devel@lists.alioth.debian.org[Developpement mailing list].
 
11
 
 
12
'bts-link' is developped using git, on `git.debian.org`:
 
13
 
 
14
- git://git.debian.org/git/bts-link/bts-link.git
 
15
- http://git.debian.org/?p=bts-link/bts-link.git[gitweb]
 
16
 
 
17
******************************************************************************
 
18
 
 
19
 
 
20
Introduction
 
21
------------
 
22
 
 
23
'bts-link' brings the remote BTSes to our http://bugs.debian.org[Debian BTS],
 
24
see the
 
25
http://lists.debian.org/debian-devel-announce/2006/05/msg00001.html[announce].
 
26
 
 
27
 
 
28
Its purpose is to allow to 'Fire and forget' bugs reports to upstreams, and
 
29
let an automatic tool track the upstream bug status. It was once written to
 
30
help the pkg-kde team, and was then extended so that other teams and other
 
31
BTSes than bugzilla could be supported. At the time when this documentation
 
32
was written, 'bts-link' supports:
 
33
 
 
34
- bugzilla (and issuezilla);
 
35
- gnats;
 
36
- mantis;
 
37
- savane (from savanah);
 
38
- sourceforge trackers;
 
39
- trac.
 
40
 
 
41
 
 
42
How does it work ?
 
43
----------------
 
44
 
 
45
'bts-link' uses the `forwarded` state of debian bugs to detect URI's of remote
 
46
BTSes it knows about. The _current_ configuration file is always available
 
47
from http://git.debian.org/?p=bts-link/bts-link.git;a=blob;f=btslink.cfg;hb=HEAD[gitweb].
 
48
 
 
49
Then, based on its information, it polls the remote BTSes, gets the remote bug
 
50
_status_, and _resolution_ if the bug was closed, and acts accordingly.
 
51
 
 
52
 
 
53
Gory Details
 
54
------------
 
55
 
 
56
'bts-link' uses usertags to store its informations. The user is
 
57
bts-link-upstream@lists.alioth.debian.org and it uses `status-\*` and
 
58
`resolution-\*` tags to store those informations.
 
59
 
 
60
Then each time the upstream bug status changes, 'bts-link' takes the following
 
61
decisions:
 
62
 
 
63
- if the bug was previously opened, then closed: it tags the debian bug
 
64
  'fixed-upstream' ;
 
65
- if the bug was previously closed, then re-opened: it removes the tag
 
66
  'fixed-upstream' ;
 
67
- if the upstream resolution is also detected as a wontfix-like (it does not
 
68
  catches everyone of them though): it adds a 'wontfix' tag (and it will
 
69
  remove it also if the resolution moves from a wontfix state to another one).
 
70
 
 
71
******************************************************************************
 
72
'bts-link' uses the tags like that:
 
73
 
 
74
- 'fixed-upstream' is meant as "hey, this bug has been reported as fixed
 
75
  upstream, please checks it's true" ;
 
76
- 'fixed-upstream' + 'wontfix': this special combination means in fact
 
77
  'wontfix-upstream' but this tag does not exists.
 
78
 
 
79
******************************************************************************
 
80
 
 
81
'bts-link' will never _ever_ try to change tags in any other conditions. It
 
82
hence means that if you (as a Debian Maintainer) think that the bug isn't
 
83
fixed upstream, whatever upstream claims, you can completely remove the
 
84
'fixed-upstream' tag, 'bts-link' won't force it back, _except_ if upstream
 
85
re-opens the bug, then closes it again.