~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 00:49:50 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909004950-43z4zdicb5u91iet
tweak quick reference naming to make it consistent with other PDFs

Show diffs side-by-side

added added

removed removed

Lines of Context:
51
51
report, but they generally care more about getting bugs fixed.
52
52
 
53
53
The aim of investigating bugs before starting concentrated work on them is
54
 
therefore only to:
 
54
therefore only to: 
55
55
 
56
56
* determine if they are critical or high priority (and
57
57
  should displace existing work)
76
76
 | One of the things you should not do often is to start asking
77
77
 | questions/for more debug info and then forget about the bug. It's just
78
78
 | a waste of the reporter's and your time, and will create frustration
79
 
 | on the reporter side.
 
79
 | on the reporter side. 
80
80
 
81
81
 
82
82
Priorities
85
85
The suggested priorities for bug work are:
86
86
 
87
87
1. Fix critical bugs.
88
 
 
 
88
   
89
89
2. Get existing fixes through review and landed.
90
90
 
91
91
3. Fix bugs that are already in progress.
136
136
    yet.
137
137
Incomplete
138
138
    The bug requires more information from the reporter to make progress.
139
 
 
140
 
    Only set this state if it's impossible or uneconomical to make
141
 
    progress on the bug without that information.  The bug will expire if
142
 
    it remains in this state for two months.
143
139
Confirmed
144
 
    The bug report has been seen by a developer and we agree it's a bug.
145
 
    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
146
142
    it's not a good idea for a developer to spend time reproducing the bug
147
143
    until they're going to work on it.)
148
144
Triaged
149
 
    We don't use this status.  If it is set, it means the same as
150
 
    Confirmed.
 
145
    This is an odd state - one we consider a bug in launchpad, as it really
 
146
    means "Importance has been set". We use this to mean the same thing
 
147
    as confirmed, and set no preference on whether Confirmed or Triaged are
 
148
    used. Please do not change a "Confirmed" bug to "Triaged" or vice verca -
 
149
    any reports we create or use will always search for both "Confirmed" and
 
150
    "Triaged" or neither "Confirmed" nor "Triaged".
151
151
In Progress
152
 
    Someone has started working on this.  We can deliver the value of the
153
 
    work already done by finishing and shipping the fix.  
154
 
    
155
 
    The bug keeps this state from the time someone does non-trivial
156
 
    analysis, until the fix is merged to a release or trunk branch (when
157
 
    it is Fix Released), or until they give up on it (back to New or
158
 
    Confirmed) or decide it is Invalid or Incomplete.
 
152
    Someone has started working on this.
159
153
Won't Fix
160
154
    The behaviour complained about is intentional and we won't fix it.
161
155
    Needless to say, be thoughtful before using this status, and consider if
164
158
    The reporter was confused, and this is not actually a bug.
165
159
    Again, be sensitive in explaining this to the user.
166
160
Fix Committed
167
 
    Don't use this.  If set on old bug, it probably means In Progress,
168
 
    with the fix waiting for review.  See Launchpad `bug 163694`_.
 
161
    A fix for this bug exists in a branch somewhere.  Ideally the bug will
 
162
    be linked to the branch.
169
163
Fix Released
170
 
    The fix for this bug is now in the bzr branch that this task is for.
171
 
    The branch for the default task on a bug is bzr.dev.  
172
 
    
173
 
    We use this value even though the fix may not have been been included
174
 
    in a release yet because all the developer activity around it is
175
 
    complete and we want to both avoid bug spam when releases happen, and
176
 
    keep the list of bugs that developers see when they look at the bug
177
 
    tracker trimmed to those that require action. 
178
 
    
179
 
    When setting a bug task to fix released, the bug target milestone
180
 
    should be set to the release the fix will be included in (or was
181
 
    included in, if you are updating an old bug). Don't spend too much
182
 
    time updating this if you don't immediately know: its not critical
183
 
    that it be set.
184
 
 
185
 
.. _`bug 163694`: https://bugs.launchpad.net/malone/+bug/163694
 
164
    The fix for this bug is now in the bzr trunk.  It's not necessarily
 
165
    true that it's released yet, but it will be in the next release.  The
 
166
    bug target milestone should be set to the release it went into, but
 
167
    don't spend too much time updating this if you don't immediately know.
186
168
 
187
169
 
188
170
Bug Importance
226
208
***************
227
209
 
228
210
It's possible to target a bug to a milestone, eg
229
 
<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>.  We use this to help the
230
 
release manager know what **must** be merged to make the release.
 
211
<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>.  We use this mostly
 
212
to help the release manager know what **must** be merged to make the
 
213
release.
231
214
 
232
215
Therefore, we don't target bugs that we'd like to have fixed or that could
233
216
be fixed in a particular release, we only target bugs that must be fixed
234
 
and that will cause us to slip the release if they're not fixed.  At any time,
235
 
very few if any of the bugs targeted to a release should be still open.  By
236
 
definition, these bugs should normally be Critical priority.
 
217
and that will or might cause us to decide to slip the release if they're
 
218
not fixed.  At any time, very few if any of the bugs targetted to a
 
219
release should be still open.  By definition, these bugs should normally
 
220
be Critical priority.
237
221
 
238
222
 
239
223
Backports
244
228
represent this, create a new bug task (ie link in the status table on the
245
229
bug page) by clicking the `poorly-named
246
230
<https://bugs.launchpad.net/bugs/132733>`_ "Target to Release" link.
247
 
Target it to the appropriate series (ie 1.15). If the bug should also
248
 
prevent any point releases of that series then you should also target the
249
 
new task to the appropriate milestone within that release. (See Targeting Bugs
250
 
above)
 
231
Target it to the appropriate series (ie 1.15) and then to the milestone
 
232
within that release.  
251
233
 
252
234
This bug task then has a separate status and importance to indicate the
253
235
separate work to get it into that release.
271
253
authentication
272
254
    authenticating to servers
273
255
 
274
 
backport
 
256
backport 
275
257
    candidate for backporting to an update of the previous release
276
258
 
277
 
dirstate
 
259
dirstate 
278
260
    WorkingTree4
279
261
 
280
 
easy
 
262
easy 
281
263
    should be possible to finish in an hour or two
282
264
 
283
 
hpss
 
265
hpss 
284
266
    bugs about the High-Performance Smart Server, i.e. bzr+ssh://, etc.
285
267
 
286
 
hpssvfs
 
268
hpssvfs 
287
269
    bugs for causes of VFS methods of the smart server
288
270
 
289
 
launchpad
 
271
launchpad 
290
272
    bugs about interactions with launchpad (typically this means bzrlib.plugins.launchpad).
291
273
 
292
 
locale
 
274
locale 
293
275
    problems using locales other than English
294
276
 
295
 
memory
 
277
memory 
296
278
    problems where we use too much memory for some reason
297
279
 
298
 
newformat
 
280
newformat 
299
281
    fixing this would need a new disk format
300
282
 
301
 
performance
 
283
performance 
302
284
    bugs about performance problems.
303
285
 
304
 
test
 
286
test 
305
287
    needs changes to the test framework
306
288
 
307
 
transport
 
289
transport 
308
290
    virtual filesystem for http, sftp, etc
309
291
 
310
 
trivial
 
292
trivial 
311
293
    should be very easy to fix (10-20 minutes) and easily landed: typically just spelling errors and the like
312
294
 
313
 
ui
 
295
ui 
314
296
    bugs relating to the bzr user interface, e.g. confusing error messages.
315
297
 
316
 
win32
317
 
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for marking specific bugs.
 
298
win32 
 
299
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for marking specific bugs. 
318
300
 
319
301
You can see the full list of tags in use at
320
302
<https://bugs.edge.launchpad.net/bzr/+bugs>.  As of September 2008 the
321
 
list is on the right.
 
303
list is on the right. 
322
304
 
323
305
.. vim: ft=rst