~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/bug-handling.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-10-13 06:08:53 UTC
  • mfrom: (4737.1.1 merge-2.0-into-devel)
  • Revision ID: pqm@pqm.ubuntu.com-20091013060853-erk2aaj80fnkrv25
(andrew) Merge lp:bzr/2.0 into lp:bzr, including fixes for #322807,
        #389413, #402623 and documentation improvements.

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
Links
20
20
*****
21
21
 
22
 
* `bzr bugs home page <https://bugs.launchpad.net/bzr>`_.
23
 
 
24
 
* `Critical bugs <https://bugs.launchpad.net/bzr/+bugs?search=Search&field.importance=Critical&field.status=New&field.status=Incomplete&field.status=Confirmed&field.status=Triaged&field.status=In+Progress&field.status=Fix+Committed>`_.
25
 
 
26
 
* `Open bugs by importance <https://bugs.launchpad.net/bzr/+bugs>`_.
 
22
* `bzr bugs home page <https://bugs.edge.launchpad.net/bzr>`_.
 
23
 
 
24
* `Critical bugs <https://bugs.edge.launchpad.net/bzr/+bugs?search=Search&field.importance=Critical&field.status=New&field.status=Incomplete&field.status=Confirmed&field.status=Triaged&field.status=In+Progress&field.status=Fix+Committed>`_.
 
25
 
 
26
* `Open bugs by importance <https://bugs.edge.launchpad.net/bzr/+bugs>`_.
27
27
 
28
28
* `Open bugs most recently changed first
29
 
  <https://bugs.launchpad.net/bzr/+bugs?field.searchtext=&orderby=-date_last_updated&search=Search&field.status%3Alist=NEW&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.assignee=&field.bug_reporter=&field.omit_dupes=on&field.has_patch=&field.has_no_package=>`_.
30
 
 
31
 
* `Most commonly duplicated bugs <http://tinyurl.com/bzr-bugs-by-dupes>`_.
 
29
  <https://bugs.edge.launchpad.net/bzr/+bugs?field.searchtext=&orderby=-date_last_updated&search=Search&field.status%3Alist=NEW&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.assignee=&field.bug_reporter=&field.omit_dupes=on&field.has_patch=&field.has_no_package=>`_.
32
30
 
33
31
 
34
32
Generalities
43
41
When you file a bug as a Bazaar developer or active user, if you feel
44
42
confident in doing so, make an assessment of status and importance at the
45
43
time you file it, rather than leaving it for someone else.  It's more
46
 
efficient to change the importance if someone else feels it's higher or
 
44
efficient to change the importance if someone else feel's it's higher or
47
45
lower, than to have someone else edit all bugs.
48
46
 
49
47
It's more useful to actually ship bug fixes than to garden the bug
53
51
report, but they generally care more about getting bugs fixed.
54
52
 
55
53
The aim of investigating bugs before starting concentrated work on them is
56
 
therefore only to:
 
54
therefore only to: 
57
55
 
58
56
* determine if they are critical or high priority (and
59
57
  should displace existing work)
78
76
 | One of the things you should not do often is to start asking
79
77
 | questions/for more debug info and then forget about the bug. It's just
80
78
 | a waste of the reporter's and your time, and will create frustration
81
 
 | on the reporter side.
 
79
 | on the reporter side. 
82
80
 
83
81
 
84
82
Priorities
87
85
The suggested priorities for bug work are:
88
86
 
89
87
1. Fix critical bugs.
90
 
 
 
88
   
91
89
2. Get existing fixes through review and landed.
92
90
 
93
91
3. Fix bugs that are already in progress.
138
136
    yet.
139
137
Incomplete
140
138
    The bug requires more information from the reporter to make progress.
141
 
 
142
 
    Only set this state if it's impossible or uneconomical to make
143
 
    progress on the bug without that information.  The bug will expire if
144
 
    it remains in this state for two months.
145
139
Confirmed
146
 
    The bug report has been seen by a developer and we agree it's a bug.
147
 
    You don't have to reproduce the bug to mark it Confirmed.  (Generally
 
140
    The bug report has been seen by a developer and we agree it's a bug.  
 
141
    You don't have to reproduce the bug to mark it confirmed.  (Generally
148
142
    it's not a good idea for a developer to spend time reproducing the bug
149
143
    until they're going to work on it.)
150
144
Triaged
151
145
    We don't use this status.  If it is set, it means the same as
152
146
    Confirmed.
153
147
In Progress
154
 
    Someone has started working on this.  We can deliver the value of the
155
 
    work already done by finishing and shipping the fix.  
156
 
    
157
 
    The bug keeps this state from the time someone does non-trivial
158
 
    analysis, until the fix is merged to a release or trunk branch (when
159
 
    it is Fix Released), or until they give up on it (back to New or
160
 
    Confirmed) or decide it is Invalid or Incomplete.
 
148
    Someone has started working on this.
161
149
Won't Fix
162
150
    The behaviour complained about is intentional and we won't fix it.
163
151
    Needless to say, be thoughtful before using this status, and consider if
166
154
    The reporter was confused, and this is not actually a bug.
167
155
    Again, be sensitive in explaining this to the user.
168
156
Fix Committed
169
 
    Don't use this.  If set on old bug, it probably means In Progress,
170
 
    with the fix waiting for review.  See Launchpad `bug 163694`_.
 
157
    A fix for this bug exists in a branch somewhere.  Ideally the bug will
 
158
    be linked to the branch.
171
159
Fix Released
172
160
    The fix for this bug is now in the bzr branch that this task is for.
173
 
    The branch for the default task on a bug is bzr.dev.  
174
 
    
175
 
    We use this value even though the fix may not have been been included
176
 
    in a release yet because all the developer activity around it is
177
 
    complete and we want to both avoid bug spam when releases happen, and
178
 
    keep the list of bugs that developers see when they look at the bug
179
 
    tracker trimmed to those that require action. 
180
 
    
181
 
    When setting a bug task to fix released, the bug target milestone
182
 
    should be set to the release the fix will be included in (or was
183
 
    included in, if you are updating an old bug). Don't spend too much
184
 
    time updating this if you don't immediately know: its not critical
185
 
    that it be set.
186
 
 
187
 
.. _`bug 163694`: https://bugs.launchpad.net/launchpad/+bug/163694
 
161
    The branch for the default task on a bug is bzr.dev.  We use this value
 
162
    even though the fix may not have been been included in a release yet
 
163
    because all the developer activity around it is complete and we want to
 
164
    both avoid bug spam when releases happen, and keep the list of bugs that
 
165
    developers see when they look at the bug tracker trimmed to those that
 
166
    require action. When setting a bug task to fix released, the bug target
 
167
    milestone should be set to the release the fix will be included in (or
 
168
    was included in, if you are updating an old bug). Don't spend too much time
 
169
    updating this if you don't immediately know: its not critical that it be
 
170
    set.
188
171
 
189
172
 
190
173
Bug Importance
228
211
***************
229
212
 
230
213
It's possible to target a bug to a milestone, eg
231
 
<https://bugs.launchpad.net/bzr/+milestone/1.16>.  We use this to help the
 
214
<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>.  We use this to help the
232
215
release manager know what **must** be merged to make the release.
233
216
 
234
217
Therefore, we don't target bugs that we'd like to have fixed or that could
255
238
separate work to get it into that release.
256
239
 
257
240
 
258
 
Release Notes
 
241
The News File
259
242
*************
260
243
 
261
 
Most bugs that are fixed should be mentioned in the `Release Notes
262
 
<../en/release-notes/>`_ for the forthcoming version,
 
244
Most bugs that are fixed should be mentioned in a `NEWS
 
245
<../en/release-notes/NEWS.html>`_ file entry,
263
246
including the bug number.
264
247
(Exceptions might be bugs that are not at all user visible.)
265
248
 
267
250
Tags
268
251
****
269
252
 
270
 
Here are some bug tags we use.  In Launchpad Bugs tags are currently of limited use, so don't feel obliged to tag bugs unless you're finding it useful.
 
253
Here are some bug tags we use.  In Malone tags are currently of limited use, so don't feel obliged to tag bugs unless you're finding it useful.
271
254
 
272
255
 
273
256
authentication
274
257
    authenticating to servers
275
258
 
276
 
backport
 
259
backport 
277
260
    candidate for backporting to an update of the previous release
278
261
 
279
 
dirstate
 
262
dirstate 
280
263
    WorkingTree4
281
264
 
282
 
easy
 
265
easy 
283
266
    should be possible to finish in an hour or two
284
267
 
285
 
hpss
 
268
hpss 
286
269
    bugs about the High-Performance Smart Server, i.e. bzr+ssh://, etc.
287
270
 
288
 
hpssvfs
 
271
hpssvfs 
289
272
    bugs for causes of VFS methods of the smart server
290
273
 
291
 
launchpad
 
274
launchpad 
292
275
    bugs about interactions with launchpad (typically this means bzrlib.plugins.launchpad).
293
276
 
294
 
locale
 
277
locale 
295
278
    problems using locales other than English
296
279
 
297
 
memory
 
280
memory 
298
281
    problems where we use too much memory for some reason
299
282
 
300
 
newformat
 
283
newformat 
301
284
    fixing this would need a new disk format
302
285
 
303
 
performance
 
286
performance 
304
287
    bugs about performance problems.
305
288
 
306
 
regression
307
 
    bugs which represent an aspect of bzr becoming accidentally less good than it was.
308
 
 
309
 
test
 
289
test 
310
290
    needs changes to the test framework
311
291
 
312
 
transport
313
 
    virtual filesystem for HTTP, SFTP, etc.
314
 
 
315
 
trivial
316
 
    should be very easy to fix (10-20 minutes) and easily landed: typically 
317
 
    just spelling errors and the like
318
 
 
319
 
ui
 
292
transport 
 
293
    virtual filesystem for http, sftp, etc
 
294
 
 
295
trivial 
 
296
    should be very easy to fix (10-20 minutes) and easily landed: typically just spelling errors and the like
 
297
 
 
298
ui 
320
299
    bugs relating to the bzr user interface, e.g. confusing error messages.
321
300
 
322
 
win32
323
 
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for 
324
 
    marking specific bugs.
 
301
win32 
 
302
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for marking specific bugs. 
325
303
 
326
304
You can see the full list of tags in use at
327
 
<https://bugs.launchpad.net/bzr/+bugs>.  As of September 2008 the
 
305
<https://bugs.edge.launchpad.net/bzr/+bugs>.  As of September 2008 the
328
306
list is on the right. 
329
307
 
330
308
.. vim: ft=rst