From c6a6851404beaa5a763fa655303e9b620af04877 Mon Sep 17 00:00:00 2001 From: cjwatson <> Date: Mon, 18 Jul 2005 01:09:17 -0800 Subject: [PATCH] [project @ 2005-07-18 02:09:17 by cjwatson] Document mail interface changes for version tracking. --- html/Developer.html.in | 10 ++++++++-- html/Reporting.html.in | 5 ++++- html/server-control.html.in | 35 +++++++++++++++++++++++++++++++++-- html/server-refcard.html.in | 4 +++- 4 files changed, 48 insertions(+), 6 deletions(-) diff --git a/html/Developer.html.in b/html/Developer.html.in index 2c3fa41..ab4ea80 100644 --- a/html/Developer.html.in +++ b/html/Developer.html.in @@ -36,6 +36,11 @@ and then edit the To field to say included in the default To field, because the $gBug system included it in the Reply-To. +

Where applicable, please supply a Version line in the +pseudo-header of your message when +closing a bug, so that the $gBug tracking system knows which releases of the +package contain the fix.

+

`Done' messages are automatically forwarded to the $gDoneList mailing list, if the mailing list has been set up. @@ -164,8 +169,9 @@ $gBadMaintHtml

It is possible to reassign $gBug reports to other packages, to reopen erroneously-closed ones, to modify the information saying to where, if anywhere, a $gBug report has been forwarded, to change the severities -and titles of reports, to set the ownership of bugs and to merge and -unmerge $gBug reports. This is done by sending mail to +and titles of reports, to set the ownership of bugs, to merge and unmerge +$gBug reports, and to record the versions of packages in which bugs were +found and in which they were fixed. This is done by sending mail to control\@$gEmailDomain.

The format of these messages is diff --git a/html/Reporting.html.in b/html/Reporting.html.in index 01a1db0..62dd09a 100644 --- a/html/Reporting.html.in +++ b/html/Reporting.html.in @@ -77,7 +77,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 diff --git a/html/server-control.html.in b/html/server-control.html.in index bbdcd2a..2683d8a 100644 --- a/html/server-control.html.in +++ b/html/server-control.html.in @@ -37,6 +37,7 @@ mailservers is available via the WWW, in

reassign bugnumber package + [ version ]
Records that $gBug #${gBug}number is a $gBug in package. This can be used to set the package if the user forgot the @@ -44,6 +45,9 @@ mailservers is available via the WWW, in are sent to anyone (other than the usual information in the processing transcript). +

If you supply a version, the $gBug tracking system will note + that the $gBug affects that version of the newly-assigned package. +

reopen bugnumber [ originator-address | = | ! ] @@ -68,6 +72,29 @@ mailservers is available via the WWW, in use the submitter command; note that this will inform the original submitter of the change. +

If the $gBug was recorded as being closed in a particular version of a + package but recurred in a later version, it is better to use the + found command instead. + +

found bugnumber [ version ] + +
Record that #bugnumber has been encountered in the given + version of the package to which it is assigned. + +

The $gBug tracking system uses this information, in conjunction with + fixed versions recorded when closing $gBugs, to display lists of $gBugs + open in various versions of each package. It considers a $gBug to be open + when it has no fixed version, or when it has been found more recently than + it has been fixed. + +

If no version is given, then the list of fixed versions for + the $gBug is cleared. This is identical to the behaviour of + reopen. + +

This command was introduced in preference to reopen + because it was difficult to add a version to that command's + syntax without suffering ambiguity. +

submitter bugnumber originator-address | ! @@ -219,7 +246,8 @@ mailservers is available via the WWW, in

For their meanings please consult the general developers' documentation for the $gBug system. -

close bugnumber (deprecated) +
close bugnumber [ fixed-version ] + (deprecated)
Close $gBug report #bugnumber. @@ -231,6 +259,9 @@ mailservers is available via the WWW, in who reported the $gBug knows why it is being closed. The use of this command is therefore deprecated. +

If you supply a fixed-version, the $gBug tracking system + will note that the $gBug was fixed in that version of the package. +

package [ packagename ... ]
Limits the following commands so that they will only apply to bugs @@ -243,7 +274,7 @@ mailservers is available via the WWW, in 
         package foo
-        reassign 123456 bar
+        reassign 123456 bar 1.0-1
 
         package bar
         retitle 123456 bar: bar sucks
diff --git a/html/server-refcard.html.in b/html/server-refcard.html.in
index b60fd08..3fcd49b 100644
--- a/html/server-refcard.html.in
+++ b/html/server-refcard.html.in
@@ -54,12 +54,14 @@ sending the word help to each mailserver.
 
Synopsis of extra commands available at control mailserver

 
 
    
-  
  • close bugnumber
+  
  • close bugnumber [ fixed-version ]
       (you must separately tell originator why)
   
  • reassign bugnumber package
+      [ version ]
   
  • severity bugnumber severity
   
  • reopen bugnumber
       [ originator-address | = | ! ]
+  
  • found bugnumber [ version ]
   
  • submitter bugnumber
       originator-address | !
   
  • forwarded bugnumber address
-- 
2.39.2