/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/bug-handling.txt
1
1
***********************
2
 
Tracking Bugs in Breezy
 
2
Tracking Bugs in Bazaar
3
3
***********************
4
4
 
5
 
This document describes the bug-tracking processes for developing Breezy
6
 
itself.  Bugs in Breezy are recorded in Launchpad.
 
5
This document describes the bug-tracking processes for developing Bazaar
 
6
itself.  Bugs in Bazaar are recorded in Launchpad.
7
7
 
8
8
 
9
9
See also:
10
10
 
11
 
* `Breezy Developer Documents <index.html>`_.
12
 
 
13
 
* `The Breezy Development Cycle <cycle.html>`_.
14
 
 
15
 
* `The Breezy User Guide <../en/user-guide/index.html>`_ -- for
16
 
  information on integrating Breezy with other bug trackers.
 
11
* `Bazaar Developer Documents <index.html>`_.
 
12
 
 
13
* `The Bazaar Development Cycle <cycle.html>`_.
 
14
 
 
15
* `The Bazaar User Guide <../en/user-guide/index.html>`_ -- for
 
16
  information on integrating Bazaar with other bug trackers.
17
17
 
18
18
 
19
19
Links
20
20
*****
21
21
 
22
 
* `Breezy bugs home page <https://bugs.launchpad.net/brz>`_.
23
 
 
24
 
* `Critical bugs <https://bugs.launchpad.net/brz/+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/brz/+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/brz/+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/brz-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
35
33
************
36
34
 
37
 
Anyone involved with Breezy is welcome to contribute to managing our bug
 
35
Anyone involved with Bazaar is welcome to contribute to managing our bug
38
36
reports.  **Edit boldly**: try to help users out, assess importance or improve
39
37
the bug description or status.  Other people will see the bugs: it's
40
38
better to have 20 of them processed and later change the status of a
41
39
couple than to leave them lie.
42
40
 
43
 
When you file a bug as a Breezy developer or active user, if you feel
 
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
 
    This bug has been confirmed by at least one other person (developer or otherwise).
147
 
Triaged
148
 
    The bug report has been seen by a developer and we agree it's a bug.
149
 
    You don't have to reproduce the bug to mark it Triaged.  (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
150
142
    it's not a good idea for a developer to spend time reproducing the bug
151
143
    until they're going to work on it.)
 
144
Triaged
 
145
    We don't use this status.  If it is set, it means the same as
 
146
    Confirmed.
152
147
In Progress
153
 
    Someone has started working on this.  We can deliver the value of the
154
 
    work already done by finishing and shipping the fix.
155
 
 
156
 
    The bug keeps this state from the time someone does non-trivial
157
 
    analysis, until the fix is merged to a release or trunk branch (when
158
 
    it is Fix Released), or until they give up on it (back to New or
159
 
    Confirmed) or decide it is Invalid or Incomplete.
 
148
    Someone has started working on this.
160
149
Won't Fix
161
150
    The behaviour complained about is intentional and we won't fix it.
162
151
    Needless to say, be thoughtful before using this status, and consider if
165
154
    The reporter was confused, and this is not actually a bug.
166
155
    Again, be sensitive in explaining this to the user.
167
156
Fix Committed
168
 
    Don't use this.  If set on old bug, it probably means In Progress,
169
 
    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.
170
159
Fix Released
171
 
    The fix for this bug is now in the Breezy branch that this task is for.
172
 
    The branch for the default task on a bug is trunk.
173
 
 
174
 
    We use this value even though the fix may not have been been included
175
 
    in a release yet because all the developer activity around it is
176
 
    complete and we want to both avoid bug spam when releases happen, and
177
 
    keep the list of bugs that developers see when they look at the bug
178
 
    tracker trimmed to those that require action.
179
 
 
180
 
    When setting a bug task to fix released, the bug target milestone
181
 
    should be set to the release the fix will be included in (or was
182
 
    included in, if you are updating an old bug). Don't spend too much
183
 
    time updating this if you don't immediately know: its not critical
184
 
    that it be set.
185
 
 
186
 
.. _`bug 163694`: https://bugs.launchpad.net/launchpad/+bug/163694
 
160
    The fix for this bug is now in the bzr trunk.  It's not necessarily
 
161
    true that it's released yet, but it will be in the next release.  The
 
162
    bug target milestone should be set to the release it went into, but
 
163
    don't spend too much time updating this if you don't immediately know.
187
164
 
188
165
 
189
166
Bug Importance
190
167
**************
191
168
 
192
169
Critical
193
 
    This is a serious bug that could cause data loss, stop Breezy being
 
170
    This is a serious bug that could cause data loss, stop bzr being
194
171
    usable in an important case, or represents a regression in something
195
172
    previously working.  We should fix critical bugs before doing other
196
173
    work, or seriously consider whether the bug is really critical
197
174
    or whether the other change is more urgent.
198
175
High
199
176
    This is a bug that can seriously interfere with people's use of
200
 
    Breezy.  We should seriously consider fixing these bugs before
 
177
    Bazaar.  We should seriously consider fixing these bugs before
201
178
    working on new features.
202
179
Medium
203
180
    A regular bug.  We'd like to fix them, but there may be a long delay.
227
204
***************
228
205
 
229
206
It's possible to target a bug to a milestone, eg
230
 
<https://bugs.launchpad.net/brz/+milestone/1.16>.  We use this to help the
231
 
release manager know what **must** be merged to make the release.
 
207
<https://bugs.edge.launchpad.net/bzr/+milestone/1.16>.  We use this mostly
 
208
to help the release manager know what **must** be merged to make the
 
209
release.
232
210
 
233
211
Therefore, we don't target bugs that we'd like to have fixed or that could
234
212
be fixed in a particular release, we only target bugs that must be fixed
235
 
and that will cause us to slip the release if they're not fixed.  At any time,
236
 
very few if any of the bugs targeted to a release should be still open.  By
237
 
definition, these bugs should normally be Critical priority.
 
213
and that will or might cause us to decide to slip the release if they're
 
214
not fixed.  At any time, very few if any of the bugs targetted to a
 
215
release should be still open.  By definition, these bugs should normally
 
216
be Critical priority.
238
217
 
239
218
 
240
219
Backports
245
224
represent this, create a new bug task (ie link in the status table on the
246
225
bug page) by clicking the `poorly-named
247
226
<https://bugs.launchpad.net/bugs/132733>`_ "Target to Release" link.
248
 
Target it to the appropriate series (ie 1.15). If the bug should also
249
 
prevent any point releases of that series then you should also target the
250
 
new task to the appropriate milestone within that release. (See Targeting Bugs
251
 
above)
 
227
Target it to the appropriate series (ie 1.15) and then to the milestone
 
228
within that release.  
252
229
 
253
230
This bug task then has a separate status and importance to indicate the
254
231
separate work to get it into that release.
255
232
 
256
233
 
257
 
Release Notes
 
234
The News File
258
235
*************
259
236
 
260
 
Most bugs that are fixed should be mentioned in the `Release Notes
261
 
<../en/release-notes/>`_ for the forthcoming version,
 
237
Most bugs that are fixed should be mentioned in a `NEWS
 
238
<../en/release-notes/NEWS.html>`_ file entry,
262
239
including the bug number.
263
240
(Exceptions might be bugs that are not at all user visible.)
264
241
 
266
243
Tags
267
244
****
268
245
 
269
 
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.
 
246
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.
270
247
 
271
248
 
272
249
authentication
273
250
    authenticating to servers
274
251
 
275
 
backport
 
252
backport 
276
253
    candidate for backporting to an update of the previous release
277
254
 
278
 
dirstate
 
255
dirstate 
279
256
    WorkingTree4
280
257
 
281
 
easy
 
258
easy 
282
259
    should be possible to finish in an hour or two
283
260
 
284
 
hpss
 
261
hpss 
285
262
    bugs about the High-Performance Smart Server, i.e. bzr+ssh://, etc.
286
263
 
287
 
hpssvfs
 
264
hpssvfs 
288
265
    bugs for causes of VFS methods of the smart server
289
266
 
290
 
launchpad
291
 
    bugs about interactions with launchpad (typically this means breezy.plugins.launchpad).
 
267
launchpad 
 
268
    bugs about interactions with launchpad (typically this means bzrlib.plugins.launchpad).
292
269
 
293
 
locale
 
270
locale 
294
271
    problems using locales other than English
295
272
 
296
 
memory
 
273
memory 
297
274
    problems where we use too much memory for some reason
298
275
 
299
 
newformat
 
276
newformat 
300
277
    fixing this would need a new disk format
301
278
 
302
 
performance
 
279
performance 
303
280
    bugs about performance problems.
304
281
 
305
 
regression
306
 
    bugs which represent an aspect of Breezy becoming accidentally less good than it was.
307
 
 
308
 
test
 
282
test 
309
283
    needs changes to the test framework
310
284
 
311
 
transport
312
 
    virtual filesystem for HTTP, SFTP, etc.
313
 
 
314
 
trivial
315
 
    should be very easy to fix (10-20 minutes) and easily landed: typically
316
 
    just spelling errors and the like
317
 
 
318
 
ui
319
 
    bugs relating to the Breezy user interface, e.g. confusing error messages.
320
 
 
321
 
win32
322
 
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for
323
 
    marking specific bugs.
 
285
transport 
 
286
    virtual filesystem for http, sftp, etc
 
287
 
 
288
trivial 
 
289
    should be very easy to fix (10-20 minutes) and easily landed: typically just spelling errors and the like
 
290
 
 
291
ui 
 
292
    bugs relating to the bzr user interface, e.g. confusing error messages.
 
293
 
 
294
win32 
 
295
    bugs that mainly affects Windows. Also there is cygwin and win98 tags for marking specific bugs. 
324
296
 
325
297
You can see the full list of tags in use at
326
 
<https://bugs.launchpad.net/brz/+bugs>.  As of September 2008 the
327
 
list is on the right.
 
298
<https://bugs.edge.launchpad.net/bzr/+bugs>.  As of September 2008 the
 
299
list is on the right. 
328
300
 
329
301
.. vim: ft=rst