X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=html%2FReporting.html.in;h=caf81ef9a7d1351d859839d47c5b92ae414407f0;hb=64d0fa452631c6e228fad18f8ae469582e3734b3;hp=4e31b8b067fd826714bade38b3735a999d5d75ab;hpb=7efcdc08506f27b1441a20554817781653cae7a0;p=debbugs.git diff --git a/html/Reporting.html.in b/html/Reporting.html.in index 4e31b8b..caf81ef 100644 --- a/html/Reporting.html.in +++ b/html/Reporting.html.in @@ -4,6 +4,7 @@ $gReportingHtml = < $gProject $gBugs - how to report a $gBug + @@ -11,8 +12,9 @@ $gReportingHtml = <Important things to note before sending -

Please don't report several unrelated $gBugs - especially ones in -different packages - in a single $gBug report. +

Please don't report multiple unrelated $gBugs - especially ones in +different packages - in a single $gBug report. It makes our lives much +easier if you send separate reports.

You should check if your $gBug report has already been filed by someone else before submitting it. Lists of currently outstanding $gBugs are @@ -37,10 +39,16 @@ headers, but a different method, described below.

There is a program that was developed in Debian to help reporting $gBug reports, it's called -reportbug. +reportbug. It will guide you through the bug reporting process step by step, and probably ease filing bugs that way.

+

Emacs users can also use the debian-bug command provided by the + +debbugs-el package. When called with M-x +debian-bug, it will ask for all necessary information in a +similar way to reportbug.

+

Sending the bug report via e-mail

@@ -70,7 +78,10 @@ has the $gBug.

Version: <something> -

Replace <something> with the version of the package.

+

Replace <something> with the version of the package. +Please don't include any text here other than the version itself, as the +$gBug tracking system relies on this field to work out which releases are +affected by the bug.

You need to supply a correct Package line in the pseudo-header in order for the $gBug tracking system to deliver the message @@ -159,6 +170,12 @@ This will cause the $gBug tracking system to send a copy of your report to the address(es) in the X-Debbugs-CC line as well as to any mailing list. +

Avoid sending such copies to the addresses of other $gBug reports, as +they will be caught by the checks that prevent mail loops. There is +relatively little point in using X-Debbugs-CC for this +anyway, as the $gBug number added by that mechanism will just be +replaced by a new one; use an ordinary CC header instead. +

This feature can often be combined usefully with mailing quiet - see below. @@ -199,6 +216,17 @@ Tags: <tags>

Replace <tags> with one or more of the available tags, as described in the developers' documentation. +Separate multiple tags with commas, spaces, or both. + +

+User: <username>
+Usertags: <usertags>
+
+ +

Replace <usertags> with one or more usertags. +Separate multiple tags with commas, spaces, or both. If you specify a +username, that users tags will be set. Otherwise, the email address of +the sender will be used as the username

Not forwarding to the mailing list - minor $gBug reports

@@ -218,6 +246,23 @@ only a summary). any forwarded message so that replies will by default be processed in the same way as the original report. + +

Acknowledgements

+ +

Normally, the $gBug system will return an acknowledgement to you by +e-mail when you report a new bug or submit additional information to an +existing bug. If you want to suppress this acknowledgement, include an +X-Debbugs-No-Ack header in your e-mail (the contents of this +header do not matter; however, it must be in the mail header and +not in the pseudo-header with the Package field). If +you report a new $gBug with this header, you will need to check the web +interface yourself to find the $gBug number.

+ +

Note that this header will not suppress acknowledgements from the +control\@$gEmailDomain mailserver, since those acknowledgements +may contain error messages which should be read and acted upon.

+ +

$gBug reports against unknown packages

If the $gBug tracking system doesn't know who the maintainer of the