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