diff options
Diffstat (limited to 'admin/notes/bugtracker')
| -rw-r--r-- | admin/notes/bugtracker | 89 |
1 files changed, 55 insertions, 34 deletions
diff --git a/admin/notes/bugtracker b/admin/notes/bugtracker index e253cb6d1b4..1a9f6f2bd4c 100644 --- a/admin/notes/bugtracker +++ b/admin/notes/bugtracker | |||
| @@ -35,15 +35,16 @@ So you need to explicitly CC him/her (and anyone else you like). | |||
| 35 | (Many people think the submitter SHOULD be automatically subscribed | 35 | (Many people think the submitter SHOULD be automatically subscribed |
| 36 | to subsequent discussion, but this does not seem to be implemented. | 36 | to subsequent discussion, but this does not seem to be implemented. |
| 37 | See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=37078) | 37 | See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=37078) |
| 38 | See also http://debbugs.gnu.org/5439 | ||
| 38 | 39 | ||
| 39 | Do NOT send a separate copy to the bug list, since this may generate a | 40 | Do NOT send a separate copy to the bug list address, since this may |
| 40 | new report. The only time to send mail to the bug list is to create a | 41 | generate a new report. The only time to send mail to the bug list |
| 41 | new report. | 42 | address is to create a new report. |
| 42 | 43 | ||
| 43 | Gnus users can add the following to message-dont-reply-to-names; | 44 | Gnus users can add the following to message-dont-reply-to-names; |
| 44 | similarly with Rmail and rmail-dont-reply-to-names: | 45 | similarly with Rmail and rmail-dont-reply-to-names: |
| 45 | 46 | ||
| 46 | "\\(emacs-pretest-bug\\|bug-gnu-emacs\\)@gnu\\.org\\|\ | 47 | "\\(emacs-pretest-bug\\|bug-gnu-emacs\\|bug-\\(e\\|gnu\\)macs\\)@gnu\\.org\\|\ |
| 47 | \\(submit\\|control\\|owner\\)@debbugs\\.gnu\\.org" | 48 | \\(submit\\|control\\|owner\\)@debbugs\\.gnu\\.org" |
| 48 | 49 | ||
| 49 | The "owner@debbugs.gnu.org" entry is there because it appears in the | 50 | The "owner@debbugs.gnu.org" entry is there because it appears in the |
| @@ -58,27 +59,23 @@ reporting.) | |||
| 58 | (e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header. | 59 | (e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header. |
| 59 | Instead, use "X-Debbugs-CC:". This ensures the Cc address will get a | 60 | Instead, use "X-Debbugs-CC:". This ensures the Cc address will get a |
| 60 | mail with the bug report number in. If you do not do this, each reply | 61 | mail with the bug report number in. If you do not do this, each reply |
| 61 | in the subsequent discussion will end up creating a new bug. This is | 62 | in the subsequent discussion will end up creating a new bug. |
| 62 | annoying. | 63 | This is annoying. |
| 63 | 64 | ||
| 64 | Note that the way this feature works is perhaps not ideal (Bug#1720). | 65 | If a new report contains X-Debbugs-CC in the input, this is |
| 65 | If X-Debbugs-CC: was specifed by a real header, that header is removed | 66 | converted to a real Cc header in the output. (See Bug#1720). |
| 66 | in the mail sent out to the bug list, and the addresses merged into | 67 | It is also merged into the Resent-CC header (see below). |
| 67 | the Resent-CC header (see below). They don't appear as an explicit CC: | ||
| 68 | header, nor do they appear in the Reply-To: header. So people you | ||
| 69 | X-Debbugs-CC are not included in any following discussion unless they are | ||
| 70 | manually cc'd. So this feature really only serves to notify them that | ||
| 71 | a bug has been filed. It's then up to them to follow any subsequent | ||
| 72 | discussion. | ||
| 73 | |||
| 74 | If X-Debbugs-CC were merged into the Reply-To header, this might work | ||
| 75 | more the way people expect. | ||
| 76 | 68 | ||
| 77 | ** How does Debbugs send out mails? | 69 | ** How does Debbugs send out mails? |
| 78 | 70 | ||
| 79 | The mails are sent out to the bug list with From: and To: unchanged. | 71 | The mails are sent out to the bug list by being resent. The From: |
| 80 | Eg if you file a bug with "submit@debbugs.gnu.org", that | 72 | header is unchanged. In new reports only (at present), the To: |
| 81 | remains in the To: address. They reach the bug list by being resent. | 73 | address is altered as follows. Any "bug-gnu-emacs", |
| 74 | "emacs-pretest-bug", or "submit@debbugs" address is replaced by | ||
| 75 | 123@debbugs in the mail that gets sent out. (This also applies to any | ||
| 76 | Cc: header, though you should be using X-Debbugs-CC instead in new | ||
| 77 | reports). The original header is stored as X-Debbugs-Original-To, if | ||
| 78 | it was changed. Any X-Debbugs-CC is merged into the Cc. | ||
| 82 | 79 | ||
| 83 | Mails arriving at the bug list have the following Resent-* headers: | 80 | Mails arriving at the bug list have the following Resent-* headers: |
| 84 | 81 | ||
| @@ -88,10 +85,6 @@ Resent-CC: maintainer email address, plus any X-Debbugs-CC: entries | |||
| 88 | 85 | ||
| 89 | The "maintainer email address" is "bug-gnu-emacs@gnu.org" in most cases. | 86 | The "maintainer email address" is "bug-gnu-emacs@gnu.org" in most cases. |
| 90 | 87 | ||
| 91 | A new report also has: | ||
| 92 | |||
| 93 | Mail-Followup-To: bug submitter, 123@debbugs.gnu.org | ||
| 94 | |||
| 95 | ** To not get acknowledgement mail from the tracker, | 88 | ** To not get acknowledgement mail from the tracker, |
| 96 | add an "X-Debbugs-No-Ack:" header (with any value). If you use Gnus, | 89 | 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: | 90 | you can add an element to gnus-posting-styles to do this automatically, eg: |
| @@ -124,10 +117,10 @@ When you close a bug, you get a message matching: | |||
| 124 | ^X-Emacs-PR-Message: closed | 117 | ^X-Emacs-PR-Message: closed |
| 125 | 118 | ||
| 126 | ** How to avoid multiple copies of mails. | 119 | ** How to avoid multiple copies of mails. |
| 127 | When you reply to a bug, respect the Reply-To address, ie send mail | 120 | If you reply to reports in the normal way, this should work fine. |
| 128 | only to the submitter address and the numbered bug address. Do not | 121 | Basically, reply only to the numbered bug address (and any individual |
| 129 | send mail direct to bug-gnu-emacs or emacs-pretest-bug unless you are | 122 | people's addresses). Do not send mail direct to bug-gnu-emacs or |
| 130 | reporting a new bug. | 123 | emacs-pretest-bug unless you are reporting a new bug. |
| 131 | 124 | ||
| 132 | ** To close bug #123 (for example), send mail | 125 | ** To close bug #123 (for example), send mail |
| 133 | 126 | ||
| @@ -195,8 +188,7 @@ tag:tag # all bugs with given tag | |||
| 195 | See <http://wiki.debian.org/bugs.debian.org/usertags> | 188 | See <http://wiki.debian.org/bugs.debian.org/usertags> |
| 196 | 189 | ||
| 197 | "Usertags" are very similar to tags: a set of labels that can be added | 190 | "Usertags" are very similar to tags: a set of labels that can be added |
| 198 | to a bug. There are two differences between normal tags and user | 191 | to a bug. There are two differences between normal tags and user tags: |
| 199 | tags: | ||
| 200 | 192 | ||
| 201 | 1) Anyone can define any valid usertag they like. In contrast, only a | 193 | 1) Anyone can define any valid usertag they like. In contrast, only a |
| 202 | limited, predefined set of normal tags are available (see above). | 194 | limited, predefined set of normal tags are available (see above). |
| @@ -362,7 +354,7 @@ bug number. | |||
| 362 | 354 | ||
| 363 | Similarly, when you close a bug, it can be helpful to include the | 355 | Similarly, when you close a bug, it can be helpful to include the |
| 364 | relevant ChangeLog entry in the message to the bug tracker, so people | 356 | relevant ChangeLog entry in the message to the bug tracker, so people |
| 365 | can see eaxctly what the fix was. | 357 | can see exactly what the fix was. |
| 366 | 358 | ||
| 367 | *** bug-reference-mode | 359 | *** bug-reference-mode |
| 368 | 360 | ||
| @@ -373,6 +365,17 @@ the bug web-pages. | |||
| 373 | 365 | ||
| 374 | http://lists.gnu.org/archive/html/emacs-devel/2009-11/msg00440.html | 366 | http://lists.gnu.org/archive/html/emacs-devel/2009-11/msg00440.html |
| 375 | 367 | ||
| 368 | ** Bazaar stuff | ||
| 369 | |||
| 370 | *** You can use `bzr commit --fixes emacs:123' to mark that a commit fixes | ||
| 371 | Emacs bug 123. You will first need to add a line to your bazaar.conf | ||
| 372 | (untested): | ||
| 373 | |||
| 374 | bugtracker_emacs_url = http://debbugs.gnu.org/{id} | ||
| 375 | |||
| 376 | Note that all this does is add some metadata to the commit, it doesn't | ||
| 377 | actually mark the bug as closed in the tracker. | ||
| 378 | |||
| 376 | ** Gnus-specific voodoo | 379 | ** Gnus-specific voodoo |
| 377 | 380 | ||
| 378 | *** Put point on a bug-number and try: M-x gnus-read-ephemeral-emacs-bug-group | 381 | *** Put point on a bug-number and try: M-x gnus-read-ephemeral-emacs-bug-group |
| @@ -448,7 +451,10 @@ needlessly held for moderation: | |||
| 448 | *** debbugs-submit | 451 | *** debbugs-submit |
| 449 | (quiet|control|submit)@(debbugs\.gnu\.org|emacsbugs\.donarmstrong\.com) | 452 | (quiet|control|submit)@(debbugs\.gnu\.org|emacsbugs\.donarmstrong\.com) |
| 450 | [0-9]+(-done|-quiet|-subscribe)?@(debbugs\.gnu\.org|emacsbugs\.donarmstrong\.com) | 453 | [0-9]+(-done|-quiet|-subscribe)?@(debbugs\.gnu\.org|emacsbugs\.donarmstrong\.com) |
| 451 | (bug-gnu-emacs|emacs-pretest-bug)@gnu\.org | 454 | (bug-gnu-emacs|emacs-pretest-bug|bug-(e|gnu)macs)@gnu\.org |
| 455 | |||
| 456 | bug-emacs and bug-gnumacs are lesser-used aliases from fencepost's | ||
| 457 | /etc/aliases file. | ||
| 452 | 458 | ||
| 453 | *** emacs-bug-tracker | 459 | *** emacs-bug-tracker |
| 454 | sender: bug-gnu-emacs AT gnu.org | 460 | sender: bug-gnu-emacs AT gnu.org |
| @@ -456,3 +462,18 @@ recipient: emacs-bug-tracker AT debbugs\.gnu\.org | |||
| 456 | 462 | ||
| 457 | The latter is because that is the address that debbugs actually sends to. | 463 | The latter is because that is the address that debbugs actually sends to. |
| 458 | An /etc/aliases entry redirects it to the real emacs-bug-tracker address. | 464 | An /etc/aliases entry redirects it to the real emacs-bug-tracker address. |
| 465 | |||
| 466 | ** Administrivia | ||
| 467 | |||
| 468 | The debbugs-submit list should have the administrivia option off, | ||
| 469 | else it can by mistake filter out requests to subscribe to bugs. | ||
| 470 | But, this feature doesn't work anyway (see bug#5439). | ||
| 471 | |||
| 472 | ** How to test changes | ||
| 473 | |||
| 474 | Add an entry to /etc/debbugs/Maintainers like: | ||
| 475 | |||
| 476 | mytest my.email.address | ||
| 477 | |||
| 478 | Then if you do all your testing with 'Package: mytest', the resulting | ||
| 479 | mails should only go to your email address. | ||