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: (see below).
  19
  20 Once your report is filed and assigned a number, it is sent out to the
  21 bug mailing list.  In some cases, it may be appropriate to just file a
  22 bug, without sending out a copy.  To do this, send mail to
  23 quiet@emacsbugs.donarmstrong.com.
  24
  25 ** How do I reply to an existing bug report?
  26 Reply to 123@emacsbugs.donarmstrong.com, replacing 123 with the number
  27 of the bug you are interested in.  Cc anyone you like.  Do NOT send
  28 a copy to the bug list, since this may generate a new report.  The
  29 only time to send mail to the bug list is to create a new report.
  30
  31 ** When reporting a bug, to send a Cc to another address
  32 (e.g. bug-cc-mode@gnu.org), do not just use a Cc: header.
  33 Instead, use "X-Debbugs-CC:".  This ensures the Cc address will get a
  34 mail with the bug report number in.
  35
  36 ** To not get acknowledgement mail from the tracker,
  37 add an "X-Debbugs-No-Ack:" header (with any value).
  38
  39 ** To record a bug in the tracker without sending mail to the bug list.
  40 This can be useful to make a note of something discussed on
  41 emacs-devel that needs fixing.  In other words, this can be the
  42 equivalent of adding something to FOR-RELEASE.
  43
  44 To: quiet@emacsbugs.donarmstrong.com
  45 [headers end]
  46 Package: emacs
  47 Version: 23.0.60
  48 Severity: minor
  49
  50 Remember to fix FOO, as discussed on emacs-devel at http://... .
  51
  52 ** Not interested in tracker control messages (tags being set, etc)?
  53 Discard mails matching:
  54
  55 ^X-Emacs-PR-Message: transcript
  56
  57 When you close a bug, you get a message matching:
  58
  59 ^X-Emacs-PR-Message: closed
  60
  61 ** How to avoid multiple copies of mails.
  62 When you reply to a bug, respect the Reply-To address, ie send mail
  63 only to the submitter address and the numbered bug address.  Do not
  64 send mail direct to bug-gnu-emacs or emacs-pretest-bug unless you are
  65 reporting a new bug.
  66
  67 ** To close bug #123 (for example), send mail
  68
  69 To: 123-done@emacsbugs.donarmstrong.com
  70
  71 with a brief explanation in the body as to why the bug was closed.
  72
  73 ** Setting bug parameters.
  74 There are two ways to set the parameters of bugs in the database
  75 (tags, severity level, etc).  When you report a new bug, you can
  76 provide a "pseudo-header" at the start of the report, eg:
  77
  78 Package: emacs
  79 Version: 23.0.60
  80 Severity: minor
  81
  82 Optionally, add a sub-package, eg Package: emacs,calendar.
  83 This can include tags.  Some things (e.g. submitter) don't seem to
  84 work here.
  85
  86 Otherwise, send mail to the control server, control@emacsbugs.donarmstrong.com.
  87 At the start of the message body, supply the desired commands, one per
  88 line:
  89
  90 command bug-number [arguments]
  91 ...
  92 quit|stop|thank|thanks|thankyou|thank you
  93
  94 The control server ignores anything after the last line above.  So you
  95 can place control commands at the beginning of a reply to a bug
  96 report, and Bcc: the control server (note the commands have no effect
  97 if you just send them to the bug-report number).  Bcc: is better than Cc:
  98 in case people use Reply-to-All in response.
  99
 100 Some useful control commands:
 101
 102 *** To reopen a closed bug:
 103 reopen 123
 104
 105 *** Bugs can be tagged in various ways (eg wontfix, patch, etc).
 106 The available tags are:
 107 patch wontfix moreinfo unreproducible fixed notabug
 108 Note that the list at http://emacsbugs.donarmstrong.com/Developer#tags
 109 is incorrect, at least for Emacs.
 110 The list of tags can be prefixed with +, - or =, meaning to add (the
 111 default), remove, or reset the tags. E.g.:
 112
 113 tags 123 + wontfix
 114
 115 *** To merge bugs:
 116 Eg when bad replies create a bunch of new bugs for the same report.
 117 Bugs must all be in the same state (e.g. same package(s) and severity),
 118 but need not have the same tags (tags are merged). E.g.:
 119
 120 merge 123 124 125 ...
 121
 122 Note that merging does not affect titles.  In particular, a "retitle"
 123 of merged bugs only affects individual bugs, not all of them.
 124
 125 *** Forcing a merge:
 126 Like `merge', but bugs need not be in the same state.  The packages
 127 must still match though.  The first one listed is the master.  E.g.:
 128
 129 forcemerge 123 124 125 ...
 130
 131 *** To unmerge bugs:
 132 To disconnect a bug from all bugs it is merged with:
 133
 134 unmerge 123
 135
 136 This command accepts only one bug number.
 137
 138 *** To set severity:
 139 severity 123 critical|grave|serious|important|normal|minor|wishlist
 140
 141 See http://emacsbugs.donarmstrong.com/Developer#severities for the meanings.
 142
 143 *** To set the owner of a bug:
 144 owner 123 A Hacker <none@example.com>
 145
 146 The shorthand `!' means your own address.
 147
 148 *** To remove the owner of a bug:
 149 noowner 123
 150
 151 *** To mark a bug as fixed in a particular version:
 152 fixed 123 23.0.60
 153
 154 *** To remove a "fixed" mark:
 155 notfixed 123 23.0.60
 156
 157 ** To remove spam from the tracker, move it to the `spam' pseudo-package:
 158 reassign 123 spam
 159
 160 ** To change the title of a bug:
 161 retitle 123 Some New Title
 162
 163 ** To change the submitter address:
 164 submitter 123 none@example.com
 165
 166 Note that it does not seem to work to specify "Submitter:" in the
 167 pseudo-header when first reporting a bug.