~ubuntu-branches/ubuntu/lucid/bzr/lucid-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Jelmer Vernooij
  • Date: 2010-02-17 17:47:40 UTC
  • mfrom: (1.4.5 upstream) (9.2.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20100217174740-35yh6t5rjnztg9z6
Tags: 2.1.0-1
New upstream release.

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.
139
143
Confirmed
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
 
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
142
146
    it's not a good idea for a developer to spend time reproducing the bug
143
147
    until they're going to work on it.)
144
148
Triaged
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".
 
149
    We don't use this status.  If it is set, it means the same as
 
150
    Confirmed.
151
151
In Progress
152
 
    Someone has started working on this.
 
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.
153
159
Won't Fix
154
160
    The behaviour complained about is intentional and we won't fix it.
155
161
    Needless to say, be thoughtful before using this status, and consider if
158
164
    The reporter was confused, and this is not actually a bug.
159
165
    Again, be sensitive in explaining this to the user.
160
166
Fix Committed
161
 
    A fix for this bug exists in a branch somewhere.  Ideally the bug will
162
 
    be linked to the branch.
 
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`_.
163
169
Fix Released
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.
 
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
168
186
 
169
187
 
170
188
Bug Importance
208
226
***************
209
227
 
210
228
It's possible to target a bug to a milestone, eg
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.
 
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.
214
231
 
215
232
Therefore, we don't target bugs that we'd like to have fixed or that could
216
233
be fixed in a particular release, we only target bugs that must be fixed
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.
 
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.
221
237
 
222
238
 
223
239
Backports
228
244
represent this, create a new bug task (ie link in the status table on the
229
245
bug page) by clicking the `poorly-named
230
246
<https://bugs.launchpad.net/bugs/132733>`_ "Target to Release" link.
231
 
Target it to the appropriate series (ie 1.15) and then to the milestone
232
 
within that release.  
 
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)
233
251
 
234
252
This bug task then has a separate status and importance to indicate the
235
253
separate work to get it into that release.
253
271
authentication
254
272
    authenticating to servers
255
273
 
256
 
backport 
 
274
backport
257
275
    candidate for backporting to an update of the previous release
258
276
 
259
 
dirstate 
 
277
dirstate
260
278
    WorkingTree4
261
279
 
262
 
easy 
 
280
easy
263
281
    should be possible to finish in an hour or two
264
282
 
265
 
hpss 
 
283
hpss
266
284
    bugs about the High-Performance Smart Server, i.e. bzr+ssh://, etc.
267
285
 
268
 
hpssvfs 
 
286
hpssvfs
269
287
    bugs for causes of VFS methods of the smart server
270
288
 
271
 
launchpad 
 
289
launchpad
272
290
    bugs about interactions with launchpad (typically this means bzrlib.plugins.launchpad).
273
291
 
274
 
locale 
 
292
locale
275
293
    problems using locales other than English
276
294
 
277
 
memory 
 
295
memory
278
296
    problems where we use too much memory for some reason
279
297
 
280
 
newformat 
 
298
newformat
281
299
    fixing this would need a new disk format
282
300
 
283
 
performance 
 
301
performance
284
302
    bugs about performance problems.
285
303
 
286
 
test 
 
304
test
287
305
    needs changes to the test framework
288
306
 
289
 
transport 
 
307
transport
290
308
    virtual filesystem for http, sftp, etc
291
309
 
292
 
trivial 
 
310
trivial
293
311
    should be very easy to fix (10-20 minutes) and easily landed: typically just spelling errors and the like
294
312
 
295
 
ui 
 
313
ui
296
314
    bugs relating to the bzr user interface, e.g. confusing error messages.
297
315
 
298
 
win32 
299
 
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for marking specific bugs. 
 
316
win32
 
317
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for marking specific bugs.
300
318
 
301
319
You can see the full list of tags in use at
302
320
<https://bugs.edge.launchpad.net/bzr/+bugs>.  As of September 2008 the
303
 
list is on the right. 
 
321
list is on the right.
304
322
 
305
323
.. vim: ft=rst