html/Developer.html.in

   1 $gDeveloperHtml = <<HTML_END
   2 <!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html>
   4 <head>
   5   <title>$gProject - Developers' information</title>
   6   <link rev="made" href="mailto:$gMaintainerEmail">
   7   <link rel="stylesheet" href="$gWebHostBugDir/css/bugs.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <h1><A name="developers">Developers' information regarding the $gBug processing system</a></h1>
  12
  13 <p>Initially, a $gBug report is submitted by a user as an ordinary mail
  14 message to <code>submit\@$gEmailDomain</code>.  This will then be
  15 given a number, acknowledged to the user, and forwarded to a mailing
  16 list (if configured).  If the submitter included a <code>Package</code>
  17 line listing a package with a known maintainer the maintainer will get
  18 a copy too.
  19
  20 <p>The <code>Subject</code> line will have
  21 <code>$gBug#</code><var>nnn</var><code>:</code> added, and the
  22 <code>Reply-To</code> will be set to include both the submitter of the
  23 report and <var>nnn</var><code>\@$gEmailDomain</code>.
  24
  25 <h2>Closing $gBug reports</h2>
  26
  27 <p>A developer who receives a $gBug from the tracking system, or sees it on
  28 the mailing list, and takes responsibility for it should hit Reply in
  29 their favourite mailreader,
  30 and then edit the <code>To</code> field to say
  31 <var>nnn</var><code>-done\@$gEmailDomain</code> instead of
  32 <var>nnn</var><code>\@$gEmailDomain</code>
  33 (<var>nnn</var><code>-close</code> is provided as an alias for
  34 <var>nnn</var><code>-done</code>).
  35
  36 <p>The address of the original submitter of the $gBug report will be
  37 included in the default <code>To</code> field, because the $gBug system
  38 included it in the <code>Reply-To</code>.
  39
  40 <p>Where applicable, please supply a <code>Version</code> line in the
  41 <a href="Reporting.html#pseudoheader">pseudo-header</a> of your message when
  42 closing a $gBug, so that the $gBug tracking system knows which releases of the
  43 package contain the fix.</p>
  44
  45 <p>`Done' messages are automatically forwarded to the <code>$gDoneList</code>
  46 mailing list, if the mailing list has been set up.
  47
  48 <p>The person closing the $gBug and the person who submitted it will each
  49 get a notification about the change in status of the report.
  50
  51 <h2>Followup messages</h2>
  52
  53 <p>If a developer wishes to reply to a $gBug report they may simply reply
  54 to the message (that will <b>not</b> mark the bug as done). Their reply will
  55 (by default, if they respect the Reply-To: header) go to
  56 <var>nnn</var><code>\@$gEmailDomain</code>, and to the original submitter of
  57 the $gBug report (note: this is two distinct addresses). The $gBug tracking
  58 system will receive the message at <var>nnn</var><code>\@$gEmailDomain</code>,
  59 pass it on to the package maintainer, file the reply with the rest of the
  60 logs for that bug report and forward it to a designated mailing list
  61 (<code>$gSubmitList\@$gEmailDomain</code>).
  62
  63 <p>A developer may explicitly mail the bug's submitter with an email to
  64 <var>nnn</var><code>-submitter\@$gEmailDomain</code>.
  65
  66 <p>If you wish to send a followup message which is not appropriate for
  67 any mailing list you can do so by sending it to
  68 <var>nnn</var><code>-quiet\@$gEmailDomain</code> or
  69 <var>nnn</var><code>-maintonly\@$gEmailDomain</code>.
  70 Mail to <var>nnn</var><code>-quiet\@$gEmailDomain</code> is filed in the
  71 $gBug Tracking System but is not delivered to any individuals or mailing
  72 lists. Mail to <var>nnn</var><code>-maintonly\@$gEmailDomain</code> is
  73 filed in the $gBug Tracking System and is delivered only to the maintainer
  74 of the package in question.
  75
  76 <p>Do <em>not</em> use the `reply to all recipients' or `followup'
  77 feature of your mailer unless you intend to edit down the recipients
  78 substantially.  In particular, see that you don't send followup messages
  79 both to <var>nnn</var><code>\@$gEmailDomain</code> and to
  80 <code>submit\@$gEmailDomain</code>, because the $gBug system will then
  81 get two copies of it and each one will be forwarded to the designated
  82 mailing list separately.
  83
  84 <h2><A name="severities">Severity levels</a></h2>
  85
  86 <p>The $gBug system records a severity level with each $gBug report.  This
  87 is set to <code>$gDefaultSeverity</code> by default, but can be overridden
  88 either by supplying a <code>Severity</code> line in the pseudo-header when
  89 the $gBug is submitted (see the
  90 <a href="Reporting.html#pseudoheader">instructions for reporting $gBugs</a>),
  91 or by using the <code>severity</code> command with the
  92 <a href="#requestserv">control request server</a>.
  93 Separate multiple tags with commas, spaces, or both.
  94
  95 <p>The severity levels are:
  96
  97 <dl>
  98 $gHTMLSeverityDesc
  99 </dl>
 100
 101 <H2><a name="tags">Tags for $gBug reports</a></H2>
 102
 103 <p>Each $gBug can have zero or more of a set of given tags. These tags are
 104 displayed in the list of $gBugs when you look at a package's page, and when
 105 you look at the full $gBug log.
 106
 107 <p>Tags can be set by supplying a <code>Tags</code> line in the
 108 pseudo-header when the $gBug is submitted (see the
 109 <a href="Reporting.html#pseudoheader">instructions for reporting $gBugs</a>),
 110 or by using the <code>tags</code> command with the
 111 <a href="#requestserv">control request server</a>.
 112
 113 <p>The current $gBug tags are:
 114
 115 <dl>
 116 $gHTMLTagDesc
 117 </dl>
 118
 119 <h2><A name="forward">Recording that you have passed on a $gBug report</a></h2>
 120
 121 <p>When a developer forwards a $gBug report to the developer of the
 122 upstream source package from which the $gProject package is derived,
 123 they should note this in the $gBug tracking system as follows:
 124
 125 <p>Make sure that the <code>To</code> field of your message to the author
 126 has only the author(s) address(es) in it; put both the person who
 127 reported the $gBug,
 128 <var>nnn</var><code>-forwarded\@$gEmailDomain</code> and
 129 <var>nnn</var><code>\@$gEmailDomain</code> in the
 130 <code>CC</code> field.
 131
 132 <p>Ask the author to preserve the <code>CC</code> to
 133 <var>nnn</var><code>-forwarded\@$gEmailDomain</code>
 134 and <var>nnn</var><code>\@$gEmailDomain</code> when they reply, so
 135 that the $gBug tracking system will file their reply with the original
 136 report. These messages are only filed and are not sent on; to send a
 137 message as normal, send them
 138 to <var>nnn</var><code>\@$gEmailDomain</code> as well.</p>
 139
 140
 141 <p>When the $gBug tracking system gets a message at
 142 <var>nnn</var><code>-forwarded</code> it will mark the relevant $gBug as
 143 having been forwarded to the address(es) in the <code>To</code> field
 144 of the message it gets, if the $gBug is not already marked as forwarded.
 145
 146 <p>You can also manipulate the `forwarded to' information by sending
 147 messages to <a href="server-control.html"><code>control\@$gEmailDomain</code></a>.
 148
 149 <h2><a name="owner">Changing $gBug ownership</a></h2>
 150
 151 <p>In cases where the person responsible for fixing a $gBug is not the
 152 assigned maintainer for the associated package (for example, when the
 153 package is maintained by a team), it may be useful to record this fact
 154 in the $gBug tracking system. To help with this, each $gBug may
 155 optionally have an owner.
 156
 157 <p>The owner can be set by supplying an <code>Owner</code> line in the
 158 pseudo-header when the $gBug is submitted (see the
 159 <a href="Reporting.html#pseudoheader">instructions for reporting
 160 $gBugs</a>),
 161 or by using the <code>owner</code> and <code>noowner</code> commands
 162 with the <a href="#requestserv">control request server</a>.
 163
 164 <h2>Summary postings</h2>
 165
 166 <p>Every Friday, a list of outstanding $gBug reports is posted to a summary
 167 mailing list (if set up), sorted by age of report. Every Tuesday, a list of
 168 $gBug reports that have gone unanswered too long is posted, sorted by
 169 package maintainer.
 170
 171 $gBadMaintHtml
 172
 173 <h2><A name="requestserv">Reopening, reassigning and manipulating $gBugs</a></h2>
 174
 175 <p>It is possible to reassign $gBug reports to other packages, to reopen
 176 erroneously-closed ones, to modify the information saying to where, if
 177 anywhere, a $gBug report has been forwarded, to change the severities
 178 and titles of reports, to set the ownership of $gBugs, to merge and unmerge
 179 $gBug reports, and to record the versions of packages in which $gBugs were
 180 found and in which they were fixed.  This is done by sending mail to
 181 <code>control\@$gEmailDomain</code>.
 182
 183 <p>The <a href="server-control.html">format of these messages</a> is
 184 described in another document available on the World Wide Web or in
 185 the file <code>bug-maint-mailcontrol.txt</code>.  A plain text version
 186 can also be obtained by mailing the word <code>help</code> to the
 187 server at the address above.
 188
 189 <h2>More-or-less obsolete subject-scanning feature</h2>
 190
 191 <!-- (this is likely to be removed the next version?) -->
 192
 193 <p>Messages that arrive at <code>submit</code> or <code>$gBugs</code> whose
 194 Subject starts <code>Bug#</code><var>nnn</var> will be treated as
 195 having been sent to <var>nnn</var><code>\@$gEmailDomain</code>.  This is both
 196 for backwards compatibility with mail forwarded from the old
 197 addresses, and to catch followup mail sent to <code>submit</code> by
 198 mistake (for example, by using reply to all recipients).
 199
 200 <p>A similar scheme operates for <code>maintonly</code>,
 201 <code>done</code>, <code>quiet</code> and <code>forwarded</code>,
 202 which treat mail arriving with a Subject tag as having been sent to
 203 the corresponding <var>nnn-whatever</var><code>\@$gEmailDomain</code> address.
 204
 205 <p>Messages arriving at plain <code>forwarded</code> and
 206 <code>done</code> - ie, with no $gBug report number in the address - and
 207 without a $gBug number in the Subject will be filed under `junk' and
 208 kept for a few weeks, but otherwise ignored.
 209
 210 <hr>
 211
 212 <p>Other pages:
 213 <ul>
 214   <li><a href="./">$gBug tracking system main contents page.</a>
 215   <li><a href="Reporting.html">Instructions for reporting $gBugs.</a>
 216   <li><a href="Access.html">Accessing the $gBug tracking logs other than by WWW.</a>
 217   <li><a href="server-refcard.html">Mailservers' reference card.</a>
 218   <li><a href="db/ix/full.html">Full list of outstanding and recent $gBug reports.</a>
 219   <li><a href="db/ix/packages.html">Packages with $gBug reports.</a>
 220   <li><a href="db/ix/maintainers.html">Maintainers of packages with $gBug reports.</a>
 221 $gHTMLOtherPageList
 222 </ul>
 223
 224 $gHTMLTail
 225
 226 HTML_END