admin/notes/bugtracker

   1 NOTES ON THE EMACS BUG TRACKER   -*- outline -*-
   2
   3 The Emacs Bug Tracker can be found at http://emacsbugs.donarmstrong.com/
   4
   5 For a list of all bugs, see http://emacsbugs.donarmstrong.com/emacs
   6
   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
  18 iii) If you want to CC: someone, use X-Debbugs-CC: (this is important;
  19 see below).
  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
  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.
  39
  40 ** When reporting a bug, to send a Cc to another address
  41 (e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header.
  42 Instead, use "X-Debbugs-CC:".  This ensures the Cc address will get a
  43 mail with the bug report number in.  If you do not do this, each reply
  44 in the subsequent discussion will end up creating a new bug.  This is
  45 annoying.
  46
  47 ** To not get acknowledgement mail from the tracker,
  48 add an "X-Debbugs-No-Ack:" header (with any value).  If you use Gnus,
  49 you can add an element to gnus-posting-styles to do this automatically, eg:
  50
  51 ("gnu-emacs\\(-pretest\\)?-bug"
  52    ("X-Debbugs-No-Ack" "yes"))
  53
  54 (adjust the regexp according to the name you use for the bug lists)
  55
  56 ** To record a bug in the tracker without sending mail to the bug list.
  57 This can be useful to make a note of something discussed on
  58 emacs-devel that needs fixing.  In other words, this can be the
  59 equivalent of adding something to FOR-RELEASE.
  60
  61 To: quiet@emacsbugs.donarmstrong.com
  62 [headers end]
  63 Package: emacs
  64 Version: 23.0.60
  65 Severity: minor
  66
  67 Remember to fix FOO, as discussed on emacs-devel at http://... .
  68
  69 ** Not interested in tracker control messages (tags being set, etc)?
  70 Discard mails matching:
  71
  72 ^X-Emacs-PR-Message: transcript
  73
  74 When you close a bug, you get a message matching:
  75
  76 ^X-Emacs-PR-Message: closed
  77
  78 ** How to avoid multiple copies of mails.
  79 When you reply to a bug, respect the Reply-To address, ie send mail
  80 only to the submitter address and the numbered bug address.  Do not
  81 send mail direct to bug-gnu-emacs or emacs-pretest-bug unless you are
  82 reporting a new bug.
  83
  84 ** To close bug #123 (for example), send mail
  85
  86 To: 123-done@emacsbugs.donarmstrong.com
  87
  88 with a brief explanation in the body as to why the bug was closed.
  89
  90 ** Setting bug parameters.
  91 There are two ways to set the parameters of bugs in the database
  92 (tags, severity level, etc).  When you report a new bug, you can
  93 provide a "pseudo-header" at the start of the report, eg:
  94
  95 Package: emacs
  96 Version: 23.0.60
  97 Severity: minor
  98
  99 Optionally, add a sub-package, eg Package: emacs,calendar.
 100 This can include tags.  Some things (e.g. submitter) don't seem to
 101 work here.
 102
 103 Otherwise, send mail to the control server, control@emacsbugs.donarmstrong.com.
 104 At the start of the message body, supply the desired commands, one per
 105 line:
 106
 107 command bug-number [arguments]
 108 ...
 109 quit|stop|thank|thanks|thankyou|thank you
 110
 111 The control server ignores anything after the last line above.  So you
 112 can place control commands at the beginning of a reply to a bug
 113 report, and Bcc: the control server (note the commands have no effect
 114 if you just send them to the bug-report number).  Bcc: is better than Cc:
 115 in case people use Reply-to-All in response.
 116
 117 Some useful control commands:
 118
 119 *** To reopen a closed bug:
 120 reopen 123
 121
 122 *** Bugs can be tagged in various ways (eg wontfix, patch, etc).
 123 The available tags are:
 124 patch wontfix moreinfo unreproducible fixed notabug
 125 Note that the list at http://emacsbugs.donarmstrong.com/Developer#tags
 126 is incorrect, at least for Emacs.
 127 The list of tags can be prefixed with +, - or =, meaning to add (the
 128 default), remove, or reset the tags. E.g.:
 129
 130 tags 123 + wontfix
 131
 132 *** To merge bugs:
 133 Eg when bad replies create a bunch of new bugs for the same report.
 134 Bugs must all be in the same state (e.g. same package(s) and severity),
 135 but need not have the same tags (tags are merged). E.g.:
 136
 137 merge 123 124 125 ...
 138
 139 Note that merging does not affect titles.  In particular, a "retitle"
 140 of merged bugs only affects individual bugs, not all of them.
 141
 142 *** Forcing a merge:
 143 Like `merge', but bugs need not be in the same state.  The packages
 144 must still match though.  The first one listed is the master.  E.g.:
 145
 146 forcemerge 123 124 125 ...
 147
 148 *** To unmerge bugs:
 149 To disconnect a bug from all bugs it is merged with:
 150
 151 unmerge 123
 152
 153 This command accepts only one bug number.
 154
 155 *** To clone bugs:
 156 Useful when one report refers to more than one bug.
 157
 158 clone 123 -1 [-2 ...]
 159 retitle -1 second bug
 160 retitle -2 third bug
 161
 162 The negative numbers provide a way to refer to the cloned bugs (which
 163 will be assigned proper numbers).
 164
 165 *** To set severity:
 166 severity 123 critical|grave|serious|important|normal|minor|wishlist
 167
 168 See http://emacsbugs.donarmstrong.com/Developer#severities for the meanings.
 169
 170 *** To set the owner of a bug:
 171 owner 123 A Hacker <none@example.com>
 172
 173 The shorthand `!' means your own address.
 174
 175 *** To remove the owner of a bug:
 176 noowner 123
 177
 178 *** To mark a bug as fixed in a particular version:
 179 fixed 123 23.0.60
 180
 181 *** To remove a "fixed" mark:
 182 notfixed 123 23.0.60
 183
 184 ** To remove spam from the tracker, move it to the `spam' pseudo-package:
 185 reassign 123 spam
 186
 187 ** To change the title of a bug:
 188 retitle 123 Some New Title
 189
 190 ** To change the submitter address:
 191 submitter 123 none@example.com
 192
 193 Note that it does not seem to work to specify "Submitter:" in the
 194 pseudo-header when first reporting a bug.