Mercurial > emacs
annotate admin/notes/bugtracker @ 103008:b41af984adfa
*** empty log message ***
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Fri, 17 Apr 2009 02:31:20 +0000 |
parents | 47e37f294247 |
children | 31a925451502 |
rev | line source |
---|---|
95505 | 1 NOTES ON THE EMACS BUG TRACKER -*- outline -*- |
95445 | 2 |
95505 | 3 The Emacs Bug Tracker can be found at http://emacsbugs.donarmstrong.com/ |
95445 | 4 |
96482 | 5 For a list of all bugs, see http://emacsbugs.donarmstrong.com/emacs |
95445 | 6 |
97973 | 7 ** How do I report a bug in Emacs now? |
8 The same way as you always did. Send mail to bug-gnu-emacs@gnu.org, | |
9 or use M-x report-emacs-bug. | |
10 | |
11 The only differences are: | |
12 | |
13 i) Your report will be assigned a number and generate an automatic reply. | |
14 | |
15 ii) Optionally, you can set some database parameters when you first | |
16 report a bug (see "Setting bug parameters" below). | |
17 | |
98568 | 18 iii) If you want to CC: someone, use X-Debbugs-CC: (this is important; |
19 see below). | |
97973 | 20 |
21 Once your report is filed and assigned a number, it is sent out to the | |
22 bug mailing list. In some cases, it may be appropriate to just file a | |
23 bug, without sending out a copy. To do this, send mail to | |
24 quiet@emacsbugs.donarmstrong.com. | |
25 | |
26 ** How do I reply to an existing bug report? | |
27 Reply to 123@emacsbugs.donarmstrong.com, replacing 123 with the number | |
98513 | 28 of the bug you are interested in. NB this only sends mail to the |
29 bug-list, it does NOT (?) send a CC to the original bug submitter. | |
30 So you need to explicitly CC him/her (and anyone else you like). | |
31 | |
32 (Many people think the submitter SHOULD be automatically subscribed | |
33 to subsequent discussion, but this does not seem to be implemented. | |
34 See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=37078) | |
35 | |
36 Do NOT send a separate copy to the bug list, since this may generate a | |
37 new report. The only time to send mail to the bug list is to create a | |
38 new report. | |
95445 | 39 |
101597
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
40 Gnus users can add the following to message-dont-reply-to-names; |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
41 similarly with Rmail and rmail-dont-reply-to-names: |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
42 |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
43 "\\(emacs-pretest-bug\\|bug-gnu-emacs\\)@gnu\\.org\\|\ |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
44 \\(\\(submit\\|control\\|owner\\)@emacsbugs\\.\\|bug-submit-list@\\)\ |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
45 donarmstrong\\.com" |
101512
80672b7f9b76
Add some addresses for rmail users to ignore.
Glenn Morris <rgm@gnu.org>
parents:
101312
diff
changeset
|
46 |
101597
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
47 The "bug-submit-list@donarmstrong.com" and |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
48 "owner@emacsbugs.donarmstrong.com" entries are there because they can |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
49 appear in the "Resent-To" and "Resent-CC" headers, respectively. For a |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
50 long time Rmail erroneously included these headers in replies. If you |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
51 correspond with an Rmail user on a bug, these addresses may end up in |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
52 the Cc. Mailing to them does nothing but create duplicates and errors. |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
53 (It is possible you might want to have a dialog with the owner |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
54 address, outside of normal bug reporting.) |
100191 | 55 |
96482 | 56 ** When reporting a bug, to send a Cc to another address |
98568 | 57 (e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header. |
96482 | 58 Instead, use "X-Debbugs-CC:". This ensures the Cc address will get a |
98568 | 59 mail with the bug report number in. If you do not do this, each reply |
60 in the subsequent discussion will end up creating a new bug. This is | |
61 annoying. | |
95486 | 62 |
102276 | 63 Note that the way this feature works is perhaps not ideal (Bug#1720). |
64 If X-Debbugs-CC: was specifed by a real header, that header is removed | |
65 in the mail sent out to the bug list, and the addresses merged into | |
66 the Resent-CC header (see below). They don't appear as an explicit CC: | |
67 header, nor do they appear in the Reply-To: header. So people you | |
68 X-Debbugs-CC are not included in any following discussion unless they are | |
69 manually cc'd. So this feature really only serves to notify them that | |
70 a bug has been filed. It's then up to them to follow any subsequent | |
71 discussion. | |
72 | |
73 If X-Debbugs-CC were merged into the Reply-To header, this might work | |
74 more the way people expect. | |
75 | |
76 ** How does Debbugs send out mails? | |
77 | |
78 The mails are sent out to the bug list with From: and To: unchanged. | |
79 Eg if you file a bug with "submit@emacsbugs.donarmstrong.com", that | |
80 remains in the To: address. They reach the bug list by being resent. | |
81 | |
82 Mails arriving at the bug list have the following Resent-* headers: | |
83 | |
84 Resent-From: person who submitted the bug | |
85 Resent-To: bug-submit-list@donarmstrong.com | |
86 Resent-CC: maintainer email address, plus any X-Debbugs-CC: entries | |
87 | |
88 The "maintainer email address" is "Emacs Bugs <bug-gnu-emacs@gnu.org>" | |
89 in most cases. | |
90 | |
91 They also have: | |
92 | |
93 Reply-To: bug submitter, 123@emacsbugs.donarmstrong.com | |
94 | |
95505 | 95 ** To not get acknowledgement mail from the tracker, |
98513 | 96 add an "X-Debbugs-No-Ack:" header (with any value). If you use Gnus, |
97 you can add an element to gnus-posting-styles to do this automatically, eg: | |
98 | |
99 ("gnu-emacs\\(-pretest\\)?-bug" | |
100 ("X-Debbugs-No-Ack" "yes")) | |
101 | |
102 (adjust the regexp according to the name you use for the bug lists) | |
95486 | 103 |
96467 | 104 ** To record a bug in the tracker without sending mail to the bug list. |
105 This can be useful to make a note of something discussed on | |
96468 | 106 emacs-devel that needs fixing. In other words, this can be the |
107 equivalent of adding something to FOR-RELEASE. | |
96467 | 108 |
109 To: quiet@emacsbugs.donarmstrong.com | |
110 [headers end] | |
111 Package: emacs | |
112 Version: 23.0.60 | |
113 Severity: minor | |
114 | |
115 Remember to fix FOO, as discussed on emacs-devel at http://... . | |
116 | |
96401 | 117 ** Not interested in tracker control messages (tags being set, etc)? |
118 Discard mails matching: | |
119 | |
120 ^X-Emacs-PR-Message: transcript | |
121 | |
96402 | 122 When you close a bug, you get a message matching: |
123 | |
124 ^X-Emacs-PR-Message: closed | |
125 | |
96401 | 126 ** How to avoid multiple copies of mails. |
127 When you reply to a bug, respect the Reply-To address, ie send mail | |
128 only to the submitter address and the numbered bug address. Do not | |
129 send mail direct to bug-gnu-emacs or emacs-pretest-bug unless you are | |
130 reporting a new bug. | |
131 | |
95505 | 132 ** To close bug #123 (for example), send mail |
95486 | 133 |
96482 | 134 To: 123-done@emacsbugs.donarmstrong.com |
95445 | 135 |
136 with a brief explanation in the body as to why the bug was closed. | |
137 | |
96482 | 138 ** Setting bug parameters. |
139 There are two ways to set the parameters of bugs in the database | |
140 (tags, severity level, etc). When you report a new bug, you can | |
141 provide a "pseudo-header" at the start of the report, eg: | |
95445 | 142 |
96482 | 143 Package: emacs |
144 Version: 23.0.60 | |
145 Severity: minor | |
95505 | 146 |
97973 | 147 Optionally, add a sub-package, eg Package: emacs,calendar. |
97782 | 148 This can include tags. Some things (e.g. submitter) don't seem to |
149 work here. | |
150 | |
96482 | 151 Otherwise, send mail to the control server, control@emacsbugs.donarmstrong.com. |
152 At the start of the message body, supply the desired commands, one per | |
153 line: | |
95505 | 154 |
96482 | 155 command bug-number [arguments] |
156 ... | |
157 quit|stop|thank|thanks|thankyou|thank you | |
95473 | 158 |
96482 | 159 The control server ignores anything after the last line above. So you |
160 can place control commands at the beginning of a reply to a bug | |
96506 | 161 report, and Bcc: the control server (note the commands have no effect |
162 if you just send them to the bug-report number). Bcc: is better than Cc: | |
163 in case people use Reply-to-All in response. | |
95473 | 164 |
96482 | 165 Some useful control commands: |
166 | |
167 *** To reopen a closed bug: | |
168 reopen 123 | |
169 | |
170 *** Bugs can be tagged in various ways (eg wontfix, patch, etc). | |
96506 | 171 The available tags are: |
172 patch wontfix moreinfo unreproducible fixed notabug | |
173 Note that the list at http://emacsbugs.donarmstrong.com/Developer#tags | |
174 is incorrect, at least for Emacs. | |
175 The list of tags can be prefixed with +, - or =, meaning to add (the | |
176 default), remove, or reset the tags. E.g.: | |
95445 | 177 |
96506 | 178 tags 123 + wontfix |
95505 | 179 |
96482 | 180 *** To merge bugs: |
181 Eg when bad replies create a bunch of new bugs for the same report. | |
97989 | 182 Bugs must all be in the same state (e.g. same package(s) and severity), |
183 but need not have the same tags (tags are merged). E.g.: | |
95505 | 184 |
96482 | 185 merge 123 124 125 ... |
96389 | 186 |
97989 | 187 Note that merging does not affect titles. In particular, a "retitle" |
188 of merged bugs only affects individual bugs, not all of them. | |
189 | |
96482 | 190 *** Forcing a merge: |
97989 | 191 Like `merge', but bugs need not be in the same state. The packages |
192 must still match though. The first one listed is the master. E.g.: | |
96469 | 193 |
96482 | 194 forcemerge 123 124 125 ... |
96469 | 195 |
100191 | 196 Note: you cannot merge with an archived bug - you must unarchive it first. |
197 | |
97713 | 198 *** To unmerge bugs: |
199 To disconnect a bug from all bugs it is merged with: | |
200 | |
201 unmerge 123 | |
202 | |
203 This command accepts only one bug number. | |
204 | |
98523 | 205 *** To clone bugs: |
206 Useful when one report refers to more than one bug. | |
207 | |
208 clone 123 -1 [-2 ...] | |
209 retitle -1 second bug | |
210 retitle -2 third bug | |
211 | |
212 The negative numbers provide a way to refer to the cloned bugs (which | |
213 will be assigned proper numbers). | |
214 | |
101763 | 215 NB you cannot clone a merged bug. You'd think that trying to do so |
216 would just give you an unmerged copy of the specified bug number, but no: | |
217 | |
218 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=474742 | |
219 | |
220 You must unmerge, clone, then re-merge. | |
221 | |
96482 | 222 *** To set severity: |
223 severity 123 critical|grave|serious|important|normal|minor|wishlist | |
96389 | 224 |
225 See http://emacsbugs.donarmstrong.com/Developer#severities for the meanings. | |
96447 | 226 |
97931 | 227 *** To set the owner of a bug: |
96482 | 228 owner 123 A Hacker <none@example.com> |
96447 | 229 |
230 The shorthand `!' means your own address. | |
231 | |
97931 | 232 *** To remove the owner of a bug: |
233 noowner 123 | |
234 | |
96482 | 235 *** To mark a bug as fixed in a particular version: |
236 fixed 123 23.0.60 | |
96447 | 237 |
96506 | 238 *** To remove a "fixed" mark: |
239 notfixed 123 23.0.60 | |
240 | |
96482 | 241 ** To remove spam from the tracker, move it to the `spam' pseudo-package: |
242 reassign 123 spam | |
97753 | 243 |
244 ** To change the title of a bug: | |
245 retitle 123 Some New Title | |
246 | |
247 ** To change the submitter address: | |
248 submitter 123 none@example.com | |
97782 | 249 |
250 Note that it does not seem to work to specify "Submitter:" in the | |
251 pseudo-header when first reporting a bug. | |
100967 | 252 |
253 ** How does archiving work? | |
254 You can still send mail to a bug after it is closed. After 28 days with | |
255 no activity, the bug is archived, at which point no more changes can | |
256 be made. If you try to send mail to the bug after that (or merge with | |
257 it), it will be rejected. To make any changes, you must unarchive it first: | |
258 | |
259 unarchive 123 | |
260 | |
261 The bug will be re-archived after the next 28 day period of no activity. | |
101312
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
262 |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
263 ** The web-page with the list of bugs is slow to load |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
264 |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
265 It's a function of the number of displayed bugs. You can speed things |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
266 up by only looking at the newest 100 bugs: |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
267 |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
268 http://emacsbugs.donarmstrong.com/cgi-bin/pkgreport.cgi?newest=100;package=emacs |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
269 |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
270 The above page is accessible from the "Options" section at the end of |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
271 the "main list of bugs" page. Select bugs "in package" = emacs; |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
272 "newest bugs" = 100. (I have no idea how you get to that Options |
9dea7f9ad305
Mention limiting number of bugs displayed on web-page.
Glenn Morris <rgm@gnu.org>
parents:
101299
diff
changeset
|
273 section without having to go through the bug list page first...) |
101597
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
274 |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
275 ** Mails to the bug tracker disappear |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
276 |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
277 Apparently it has some kind of spam filter that sometimes silently |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
278 discards valid mails. Adding a subject (pointless in control messages) |
fb07b238e55a
Update message-dont-reply-to-names section.
Glenn Morris <rgm@gnu.org>
parents:
101512
diff
changeset
|
279 may help. |
101949
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
280 |
102558
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
281 ** ChangeLog issues |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
282 |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
283 *** When you fix a bug, it can be helpful to put the bug number in the |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
284 ChangeLog entry, for example: |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
285 |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
286 * foo.el (foofunc): Fix the `foo' case. (Bug#123) |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
287 |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
288 Then the relevant bug can be found for easy reference. If it's an |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
289 obvious fix (e.g. a typo), there's no need to clutter the log with the |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
290 bug number. |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
291 |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
292 Similarly, when you close a bug, it can be helpful to include the |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
293 relevant ChangeLog entry in the message to the bug tracker, so people |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
294 can see eaxctly what the fix was. |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
295 |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
296 *** bug-reference-mode |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
297 |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
298 Activate `bug-reference-mode' in ChangeLogs to get clickable links to |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
299 the bug web-pages. |
47e37f294247
Mention some ChangeLog issues.
Glenn Morris <rgm@gnu.org>
parents:
102276
diff
changeset
|
300 |
101949
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
301 ** Gnus-specific voodoo |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
302 |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
303 *** Put point on a bug-number and try: M-x gnus-read-ephemeral-emacs-bug-group |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
304 |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
305 *** If the above is not available: |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
306 (add-hook 'gnus-article-mode-hook |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
307 (lambda () |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
308 (setq bug-reference-url-format |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
309 "http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=%s") |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
310 (bug-reference-mode 1))) |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
311 |
3d4ab04238a6
Add some gnus stuff from emacs-devel.
Glenn Morris <rgm@gnu.org>
parents:
101763
diff
changeset
|
312 and you can click on the bug number in the subject header. |