aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes/bugtracker
diff options
context:
space:
mode:
authorStefan Monnier2022-09-25 16:15:16 -0400
committerStefan Monnier2022-09-25 16:15:16 -0400
commit650c20f1ca4e07591a727e1cfcc74b3363d15985 (patch)
tree85d11f6437cde22f410c25e0e5f71a3131ebd07d /admin/notes/bugtracker
parent8869332684c2302b5ba1ead4568bbc7ba1c0183e (diff)
parent4b85ae6a24380fb67a3315eaec9233f17a872473 (diff)
downloademacs-650c20f1ca4e07591a727e1cfcc74b3363d15985.tar.gz
emacs-650c20f1ca4e07591a727e1cfcc74b3363d15985.zip
Merge 'master' into noverlay
Diffstat (limited to 'admin/notes/bugtracker')
-rw-r--r--admin/notes/bugtracker82
1 files changed, 48 insertions, 34 deletions
diff --git a/admin/notes/bugtracker b/admin/notes/bugtracker
index dfca809dc46..deb06f552cc 100644
--- a/admin/notes/bugtracker
+++ b/admin/notes/bugtracker
@@ -8,9 +8,13 @@ This is 95% of all you will ever need to know.
8 8
9** How do I report a bug? 9** How do I report a bug?
10Use M-x report-emacs-bug, or send mail to bug-gnu-emacs@gnu.org. 10Use M-x report-emacs-bug, or send mail to bug-gnu-emacs@gnu.org.
11If you want to Cc someone, use an "X-Debbugs-CC" header (or 11If you want to Cc someone, use an "X-Debbugs-Cc" header (or
12pseudo-header, see below) instead. 12pseudo-header, see below) instead.
13 13
14** How do I read a bug?
15Visit https://debbugs.gnu.org/123 in your web browser or try this in
16Emacs: M-x gnus-read-ephemeral-emacs-bug-group.
17
14** How do I comment on a bug? 18** How do I comment on a bug?
15Reply to a mail on the bug-gnu-emacs list in the normal way. 19Reply to a mail on the bug-gnu-emacs list in the normal way.
16Or send a mail to 123@debbugs.gnu.org. 20Or send a mail to 123@debbugs.gnu.org.
@@ -29,7 +33,7 @@ By mailing commands to control@debbugs.gnu.org. Place commands at the
29start of the message body, one per line. 33start of the message body, one per line.
30 34
31severity 123 serious|important|normal|minor|wishlist 35severity 123 serious|important|normal|minor|wishlist
32tags 123 moreinfo|unreproducible|wontfix|patch 36tags 123 moreinfo|unreproducible|wontfix|patch|notabug
33 37
34* More detailed information 38* More detailed information
35 39
@@ -53,7 +57,7 @@ i) Your report will be assigned a number and generate an automatic reply.
53ii) Optionally, you can set some database parameters when you first 57ii) Optionally, you can set some database parameters when you first
54report a bug (see "Setting bug parameters" below). 58report a bug (see "Setting bug parameters" below).
55 59
56iii) If you want to CC: someone, use X-Debbugs-CC: (note this only 60iii) If you want to Cc someone, use X-Debbugs-Cc: (note this only
57applies to _new_ reports, not followups). 61applies to _new_ reports, not followups).
58 62
59Once your report is filed and assigned a number, it is sent out to the 63Once your report is filed and assigned a number, it is sent out to the
@@ -64,15 +68,15 @@ quiet@debbugs.gnu.org.
64** How do I reply to an existing bug report? 68** How do I reply to an existing bug report?
65Reply to 123@debbugs.gnu.org, replacing 123 with the number 69Reply to 123@debbugs.gnu.org, replacing 123 with the number
66of the bug you are interested in. NB this only sends mail to the 70of the bug you are interested in. NB this only sends mail to the
67bug-list, it does NOT send a CC to the original bug submitter. 71bug-list, it does NOT send a Cc to the original bug submitter.
68So you need to explicitly CC him/her (and anyone else you like). 72So you need to explicitly Cc him/her (and anyone else you like).
69(This works the same way as all the Emacs mailing lists. We generally 73(This works the same way as all the Emacs mailing lists. We generally
70don't assume anyone who posts to a list is subscribed to it, so we 74don't assume anyone who posts to a list is subscribed to it, so we
71cc everyone on replies.) 75cc everyone on replies.)
72 76
73(Many people think the submitter SHOULD be automatically subscribed 77(Many people think the submitter SHOULD be automatically subscribed
74to subsequent discussion, but this does not seem to be implemented. 78to subsequent discussion, but this does not seem to be implemented.
75See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=37078 79See https://bugs.debian.org/37078
76See also https://debbugs.gnu.org/5439 ) 80See also https://debbugs.gnu.org/5439 )
77 81
78Do NOT send a separate copy to the bug list address, since this may 82Do NOT send a separate copy to the bug list address, since this may
@@ -80,7 +84,7 @@ generate a new report. The only time to send mail to the bug list
80address is to create a new report. 84address is to create a new report.
81 85
82Gnus users can add the following to message-dont-reply-to-names; 86Gnus users can add the following to message-dont-reply-to-names;
83similarly with Rmail and rmail-dont-reply-to-names: 87similarly with Rmail and mail-dont-reply-to-names:
84 88
85"\\(emacs-pretest-bug\\|bug-gnu-emacs\\|bug-\\(e\\|gnu\\)macs\\)@gnu\\.org\\|\ 89"\\(emacs-pretest-bug\\|bug-gnu-emacs\\|bug-\\(e\\|gnu\\)macs\\)@gnu\\.org\\|\
86\\(submit\\|control\\|owner\\)@debbugs\\.gnu\\.org" 90\\(submit\\|control\\|owner\\)@debbugs\\.gnu\\.org"
@@ -95,20 +99,23 @@ normal bug reporting.)
95 99
96** When reporting a new bug, to send a Cc to another address 100** When reporting a new bug, to send a Cc to another address
97(e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header. 101(e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header.
98Instead, use "X-Debbugs-CC:". This ensures the Cc address will get a 102Instead, use "X-Debbugs-Cc:". This ensures the Cc address(es) will get a
99mail with the bug report number in. If you do not do this, each reply 103mail with the bug report number in. If you do not do this, each reply
100in the subsequent discussion might end up creating a new bug. 104in the subsequent discussion might end up creating a new bug.
101This is annoying. (So annoying that a form of message-id tracking has 105This is annoying. (So annoying that a form of message-id tracking has
102been implemented to hopefully stop this happening, but it is still 106been implemented to hopefully stop this happening, but it is still
103better to use X-Debbugs-CC.) 107better to use X-Debbugs-Cc.)
108
109If you want to send copies to more than one address, add them
110comma-separated in only one X-Debbugs-Cc line.
104 111
105Like any X-Debbugs- header, this one can also be specified in the 112Like any X-Debbugs- header, this one can also be specified in the
106pseudo-header (see below), if your mail client does not let you add 113pseudo-header (see below), if your mail client does not let you add
107"X-" headers. 114"X-" headers.
108 115
109If a new report contains X-Debbugs-CC in the input, this is 116If a new report contains X-Debbugs-Cc in the input, this is
110converted to a real Cc header in the output. (See Bug#1780,5384) 117converted to a real Cc header in the output. (See Bug#1780,5384)
111It is also merged into the Resent-CC header (see below). 118It is also merged into the Resent-Cc header (see below).
112 119
113** How does Debbugs send out mails? 120** How does Debbugs send out mails?
114 121
@@ -117,15 +124,15 @@ header is unchanged. In new reports only (at present), the To:
117address is altered as follows. Any "bug-gnu-emacs", 124address is altered as follows. Any "bug-gnu-emacs",
118"emacs-pretest-bug", or "submit@debbugs" address is replaced by 125"emacs-pretest-bug", or "submit@debbugs" address is replaced by
119123@debbugs in the mail that gets sent out. (This also applies to any 126123@debbugs in the mail that gets sent out. (This also applies to any
120Cc: header, though you should be using X-Debbugs-CC instead in new 127Cc: header, though you should be using X-Debbugs-Cc instead in new
121reports). The original header is stored as X-Debbugs-Original-To, if 128reports). The original header is stored as X-Debbugs-Original-To, if
122it was changed. Any X-Debbugs-CC is merged into the Cc. 129it was changed. Any X-Debbugs-Cc is merged into the Cc.
123 130
124Mails arriving at the bug list have the following Resent-* headers: 131Mails arriving at the bug list have the following Resent-* headers:
125 132
126Resent-From: person who submitted the bug 133Resent-From: person who submitted the bug
127Resent-To: owner@debbugs.gnu.org 134Resent-To: owner@debbugs.gnu.org
128Resent-CC: maintainer email address, plus any X-Debbugs-CC: entries 135Resent-Cc: maintainer email address, plus any X-Debbugs-Cc: entries
129 136
130The "maintainer email address" is "bug-gnu-emacs@gnu.org" in most cases. 137The "maintainer email address" is "bug-gnu-emacs@gnu.org" in most cases.
131 138
@@ -148,7 +155,7 @@ Package: emacs
148Version: 23.0.60 155Version: 23.0.60
149Severity: minor 156Severity: minor
150 157
151Remember to fix FOO, as discussed on emacs-devel at http://... . 158Remember to fix FOO, as discussed on emacs-devel at https://... .
152 159
153** Not interested in tracker control messages (tags being set, etc)? 160** Not interested in tracker control messages (tags being set, etc)?
154Discard mails matching: 161Discard mails matching:
@@ -178,7 +185,7 @@ Basically, reply only to the numbered bug address (and any individual
178people's addresses). Do not send mail direct to bug-gnu-emacs or 185people's addresses). Do not send mail direct to bug-gnu-emacs or
179emacs-pretest-bug unless you are reporting a new bug. 186emacs-pretest-bug unless you are reporting a new bug.
180 187
181** To close bug #123 (for example), send mail 188** To close bug#123 (for example), send mail
182 189
183To: 123-done@debbugs.gnu.org 190To: 123-done@debbugs.gnu.org
184 191
@@ -236,23 +243,31 @@ The control server ignores anything after the last line above. So you
236can place control commands at the beginning of a reply to a bug 243can place control commands at the beginning of a reply to a bug
237report, and Bcc: the control server (note the commands have no effect 244report, and Bcc: the control server (note the commands have no effect
238if you just send them to the bug-report number). Bcc: is better than Cc: 245if you just send them to the bug-report number). Bcc: is better than Cc:
239in case people use Reply-to-All in response. 246in case people use Reply-To-All in response.
247
248For the full documentation of control commands, see
249https://debbugs.gnu.org/server-control.html
240 250
241Some useful control commands: 251Some useful control commands:
242 252
253*** To close a bug and indicate in what Emacs version it was fixed
254close 123 VERSION
255
256where VERSION is XX.YY numerical version number, like 42.1.
257
243*** To reopen a closed bug: 258*** To reopen a closed bug:
244reopen 123 259reopen 123
245 260
246*** Bugs can be tagged in various ways (eg wontfix, patch, etc). 261*** Bugs can be tagged in various ways (eg wontfix, patch, etc).
247The available tags are: 262The available tags are:
248patch wontfix moreinfo unreproducible fixed notabug 263patch wontfix moreinfo unreproducible fixed notabug help security confirmed easy
249See https://debbugs.gnu.org/Developer#tags 264See https://debbugs.gnu.org/Developer#tags
250The list of tags can be prefixed with +, - or =, meaning to add (the 265The list of tags can be prefixed with +, - or =, meaning to add (the
251default), remove, or reset the tags. E.g.: 266default), remove, or reset the tags. E.g.:
252 267
253tags 123 + wontfix 268tags 123 + wontfix
254 269
255** URL shortcuts 270*** URL shortcuts
256 271
257https://debbugs.gnu.org/... 272https://debbugs.gnu.org/...
258 273
@@ -263,9 +278,9 @@ from:submitter@email.address
263severity:severity # all bugs of given severity 278severity:severity # all bugs of given severity
264tag:tag # all bugs with given tag 279tag:tag # all bugs with given tag
265 280
266** Usertags 281*** Usertags
267 282
268See <http://wiki.debian.org/bugs.debian.org/usertags> 283See <https://wiki.debian.org/bugs.debian.org/usertags>
269 284
270"Usertags" are very similar to tags: a set of labels that can be added 285"Usertags" are very similar to tags: a set of labels that can be added
271to a bug. There are two differences between normal tags and user tags: 286to a bug. There are two differences between normal tags and user tags:
@@ -275,10 +290,9 @@ limited, predefined set of normal tags are available (see above).
275 290
2762) A usertag is associated with a specific user. This is normally 2912) A usertag is associated with a specific user. This is normally
277an email address (with an "@" sign and least 4 characters after the "@"), 292an email address (with an "@" sign and least 4 characters after the "@"),
278but on debbugs.gnu.org, the definition is less strict - anything with 293but on debbugs.gnu.org, it can also be a package name. For personal tags,
2795 or more alphanumeric characters will work. For personal tags,
280using an email address is still recommended. Please only use the 294using an email address is still recommended. Please only use the
281"emacs" user, or other short users, for "official" tags. 295"emacs" user for "official" tags.
282 296
283You set usertags in the same way as tags, by talking to the control server. 297You set usertags in the same way as tags, by talking to the control server.
284One difference is that you can also specify the associated user. 298One difference is that you can also specify the associated user.
@@ -292,7 +306,7 @@ a) In a control message:
292user emacs # or email@example.com 306user emacs # or email@example.com
293usertags 1234 any-tag-you-like 307usertags 1234 any-tag-you-like
294 308
295This will add a usertag "any-tag-you-like" to bug 1234. The tag will 309This will add a usertag "any-tag-you-like" to bug#1234. The tag will
296be associated with the user "emacs". If you omit the first line, 310be associated with the user "emacs". If you omit the first line,
297the tag will be associated with your email address. 311the tag will be associated with your email address.
298 312
@@ -370,7 +384,7 @@ will be assigned proper numbers).
370NB you cannot clone a merged bug. You'd think that trying to do so 384NB you cannot clone a merged bug. You'd think that trying to do so
371would just give you an unmerged copy of the specified bug number, but no: 385would just give you an unmerged copy of the specified bug number, but no:
372 386
373http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=474742 387https://bugs.debian.org/474742
374 388
375You must unmerge, clone, then re-merge. 389You must unmerge, clone, then re-merge.
376 390
@@ -407,21 +421,21 @@ reassign 1234 emacs
407Note that reassigning clears the list of found versions, even if the 421Note that reassigning clears the list of found versions, even if the
408new packages includes the original one. 422new packages includes the original one.
409 423
410** To remove spam from the tracker, move it to the 'spam' pseudo-package: 424*** To remove spam from the tracker, move it to the 'spam' pseudo-package:
411reassign 123 spam 425reassign 123 spam
412 426
413(Should not be necessary any more, now that the input is moderated.) 427(Should not be necessary any more, now that the input is moderated.)
414 428
415** To change the title of a bug: 429*** To change the title of a bug:
416retitle 123 Some New Title 430retitle 123 Some New Title
417 431
418** To change the submitter address: 432*** To change the submitter address:
419submitter 123 none@example.com 433submitter 123 none@example.com
420 434
421Note that it does not seem to work to specify "Submitter:" in the 435Note that it does not seem to work to specify "Submitter:" in the
422pseudo-header when first reporting a bug. 436pseudo-header when first reporting a bug.
423 437
424** How does archiving work? 438*** How does archiving work?
425You can still send mail to a bug after it is closed. After 28 days with 439You can still send mail to a bug after it is closed. After 28 days with
426no activity, the bug is archived, at which point no more changes can 440no activity, the bug is archived, at which point no more changes can
427be made. If you try to send mail to the bug after that (or merge with 441be made. If you try to send mail to the bug after that (or merge with
@@ -484,7 +498,7 @@ the bug web-pages.
484 498
485*** Debian stuff 499*** Debian stuff
486 500
487https://lists.gnu.org/archive/html/emacs-devel/2009-11/msg00440.html 501https://lists.gnu.org/r/emacs-devel/2009-11/msg00440.html
488 502
489** Gnus-specific voodoo 503** Gnus-specific voodoo
490 504
@@ -507,8 +521,8 @@ reference, you don't need to read these as a user of the system.
507Getting mail from the Emacs bug list into the tracker requires the 521Getting mail from the Emacs bug list into the tracker requires the
508assistance of sysadmin at gnu.org. The test tracker set-up was, I 522assistance of sysadmin at gnu.org. The test tracker set-up was, I
509think, [gnu.org #359140]: 523think, [gnu.org #359140]:
510https://lists.gnu.org/archive/html/savannah-hackers/2008-03/msg00074.html 524https://lists.gnu.org/r/savannah-hackers/2008-03/msg00074.html
511https://lists.gnu.org/archive/html/savannah-hackers/2008-04/msg00034.html 525https://lists.gnu.org/r/savannah-hackers/2008-04/msg00034.html
512 526
513** The debbugs.gnu.org setup was handled in [gnu.org #510605]. 527** The debbugs.gnu.org setup was handled in [gnu.org #510605].
514There are two pieces (replace AT with @ in the following): 528There are two pieces (replace AT with @ in the following):
@@ -552,7 +566,7 @@ https://savannah.nongnu.org/projects/listhelper
552 566
553An "X-Debbugs-Envelope-To" header is used to keep track of where the 567An "X-Debbugs-Envelope-To" header is used to keep track of where the
554mail was actually bound for: 568mail was actually bound for:
555https://lists.gnu.org/archive/html/emacs-devel/2009-11/msg01211.html 569https://lists.gnu.org/r/emacs-devel/2009-11/msg01211.html
556 570
557** Mailing list recipient/sender filters. 571** Mailing list recipient/sender filters.
558The following mailman filters are useful to stop messages being 572The following mailman filters are useful to stop messages being