annotate admin/notes/bugtracker @ 97713:5f641e3c827d

*** empty log message ***
author Glenn Morris <rgm@gnu.org>
date Tue, 26 Aug 2008 02:54:26 +0000
parents 675709b2568f
children dc98fbae8129
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
1 NOTES ON THE EMACS BUG TRACKER -*- outline -*-
95445
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
3 The Emacs Bug Tracker can be found at http://emacsbugs.donarmstrong.com/
95445
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
5 For a list of all bugs, see http://emacsbugs.donarmstrong.com/emacs
95445
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
8 ** When reporting a bug, to send a Cc to another address
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
9 (e.g. bug-cc-mode@gnu.org), do not just use a Cc: header.
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
10 Instead, use "X-Debbugs-CC:". This ensures the Cc address will get a
95486
23898c5b8565 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95474
diff changeset
11 mail with the bug report number in.
23898c5b8565 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95474
diff changeset
12
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
13 ** To not get acknowledgement mail from the tracker,
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
14 add an "X-Debbugs-No-Ack:" header (with any value).
95486
23898c5b8565 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95474
diff changeset
15
96467
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
16 ** To record a bug in the tracker without sending mail to the bug list.
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
17 This can be useful to make a note of something discussed on
96468
5c93e68f7620 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96467
diff changeset
18 emacs-devel that needs fixing. In other words, this can be the
5c93e68f7620 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96467
diff changeset
19 equivalent of adding something to FOR-RELEASE.
96467
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
20
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
21 To: quiet@emacsbugs.donarmstrong.com
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
22 [headers end]
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
23 Package: emacs
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
24 Version: 23.0.60
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
25 Severity: minor
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
26
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
27 Remember to fix FOO, as discussed on emacs-devel at http://... .
2f224124246c *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96447
diff changeset
28
96401
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
29 ** Not interested in tracker control messages (tags being set, etc)?
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
30 Discard mails matching:
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
31
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
32 ^X-Emacs-PR-Message: transcript
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
33
96402
7f88a1df4a80 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96401
diff changeset
34 When you close a bug, you get a message matching:
7f88a1df4a80 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96401
diff changeset
35
7f88a1df4a80 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96401
diff changeset
36 ^X-Emacs-PR-Message: closed
7f88a1df4a80 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96401
diff changeset
37
96401
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
38 ** How to avoid multiple copies of mails.
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
39 When you reply to a bug, respect the Reply-To address, ie send mail
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
40 only to the submitter address and the numbered bug address. Do not
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
41 send mail direct to bug-gnu-emacs or emacs-pretest-bug unless you are
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
42 reporting a new bug.
e29fc647bad3 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96389
diff changeset
43
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
44 ** To close bug #123 (for example), send mail
95486
23898c5b8565 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95474
diff changeset
45
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
46 To: 123-done@emacsbugs.donarmstrong.com
95445
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 with a brief explanation in the body as to why the bug was closed.
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
50 ** Setting bug parameters.
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
51 There are two ways to set the parameters of bugs in the database
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
52 (tags, severity level, etc). When you report a new bug, you can
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
53 provide a "pseudo-header" at the start of the report, eg:
95445
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
55 Package: emacs
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
56 Version: 23.0.60
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
57 Severity: minor
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
58
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
59 Otherwise, send mail to the control server, control@emacsbugs.donarmstrong.com.
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
60 At the start of the message body, supply the desired commands, one per
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
61 line:
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
62
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
63 command bug-number [arguments]
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
64 ...
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
65 quit|stop|thank|thanks|thankyou|thank you
95473
762c4fbf32b0 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95446
diff changeset
66
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
67 The control server ignores anything after the last line above. So you
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
68 can place control commands at the beginning of a reply to a bug
96506
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
69 report, and Bcc: the control server (note the commands have no effect
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
70 if you just send them to the bug-report number). Bcc: is better than Cc:
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
71 in case people use Reply-to-All in response.
95473
762c4fbf32b0 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95446
diff changeset
72
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
73 Some useful control commands:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
74
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
75 *** To reopen a closed bug:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
76 reopen 123
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
77
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
78 *** Bugs can be tagged in various ways (eg wontfix, patch, etc).
96506
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
79 The available tags are:
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
80 patch wontfix moreinfo unreproducible fixed notabug
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
81 Note that the list at http://emacsbugs.donarmstrong.com/Developer#tags
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
82 is incorrect, at least for Emacs.
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
83 The list of tags can be prefixed with +, - or =, meaning to add (the
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
84 default), remove, or reset the tags. E.g.:
95445
f93f13f7bef5 New file.
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85
96506
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
86 tags 123 + wontfix
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
87
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
88 *** To merge bugs:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
89 Eg when bad replies create a bunch of new bugs for the same report.
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
90 Bugs must all be in the same state, but need not have the same tags. E.g.:
95505
e80f4eb078ee Massage.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95486
diff changeset
91
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
92 merge 123 124 125 ...
96389
c859b77bcd7f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95505
diff changeset
93
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
94 *** Forcing a merge:
96469
40d413a9e07b *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96468
diff changeset
95 Like `merge', but bugs need not be in the same state. The first one
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
96 listed is the master. E.g.:
96469
40d413a9e07b *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96468
diff changeset
97
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
98 forcemerge 123 124 125 ...
96469
40d413a9e07b *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96468
diff changeset
99
97713
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
100 *** To unmerge bugs:
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
101 To disconnect a bug from all bugs it is merged with:
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
102
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
103 unmerge 123
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
104
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
105 This command accepts only one bug number.
5f641e3c827d *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96506
diff changeset
106
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
107 *** To set severity:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
108 severity 123 critical|grave|serious|important|normal|minor|wishlist
96389
c859b77bcd7f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95505
diff changeset
109
c859b77bcd7f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 95505
diff changeset
110 See http://emacsbugs.donarmstrong.com/Developer#severities for the meanings.
96447
12698b05a698 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96402
diff changeset
111
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
112 *** To set the onwer of a bug:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
113 owner 123 A Hacker <none@example.com>
96447
12698b05a698 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96402
diff changeset
114
12698b05a698 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96402
diff changeset
115 The shorthand `!' means your own address.
12698b05a698 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96402
diff changeset
116
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
117 *** To mark a bug as fixed in a particular version:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
118 fixed 123 23.0.60
96447
12698b05a698 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96402
diff changeset
119
96506
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
120 *** To remove a "fixed" mark:
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
121 notfixed 123 23.0.60
675709b2568f *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96482
diff changeset
122
96482
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
123 ** To remove spam from the tracker, move it to the `spam' pseudo-package:
33f362ef6010 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 96469
diff changeset
124 reassign 123 spam