UPGRADE

   1
   2                             Debbugs upgrade notes
   3                            +=====================+
   4
   5 From 2.4.1 to 2.4.2
   6 -------------------
   7
   8 The file format used to store the status of a bug (package, severity, etc.)
   9 has changed; it is now in an RFC822-like format in order to be more
  10 extensible, and is written to .summary files rather than the old .status
  11 files. Before accepting any mail with the new version of debbugs, you must
  12 run the 'debbugs-upgradestatus' program over your bug spool. The old .status
  13 files will be left intact, and will continue to be written in sync with the
  14 .summary files for compatibility with external tools.
  15
  16 There is a new standalone spam-scanning script called spamscan, which uses
  17 the SpamAssassin modules. To use it, set the $gSpamScan variable in
  18 /etc/debbugs/config to a true value and $gSpamMailbox to an mbox file to
  19 which detected spam should be appended, add /usr/lib/debbugs/spamscan to
  20 your crontab as per the example, and optionally set $gSpamRulesDir and
  21 $gSpamLocalTestsOnly as desired.
  22
  23 From 2.4 to 2.4.1
  24 -----------------
  25
  26 Add the following variables to the /etc/debbugs/config file:
  27
  28 $gHTMLSuffix = ".html";
  29
  30 The use of $gCGIDomain has been cleaned up; formerly, it needed to begin
  31 with "http://", which was confusingly inconsistent with all the other domain
  32 variables. If you worked around this in your configuration, you will need to
  33 recheck it.
  34
  35 From 2.3 to 2.4
  36 ---------------
  37
  38 Add the following variables to the /etc/debbugs/config file:
  39
  40 $gWebHost = "localhost";                                # e.g. www.debian.org
  41 $gWebHostBugDir = "Bugs";                               # e.g. Bugs
  42 # For now, don't change this one manually!
  43 $gWebDomain = "$gWebHost/$gWebHostBugDir";
  44 $gCGIDomain = "$gWebDomain/Bugs/cgi";                   # e.g. cgi.debian.org
  45 $gPackagePages = "packages.debian.org";                 # e.g. packages.debian.org
  46 $gSubscriptionDomain = "packages.something";            # e.g. packages.qa.debian.org
  47 $gMaintainerFileOverride = "$gConfigDir/Maintainers.override";
  48 $gUnknownMaintainerEmail = "$gMaintainerEmail";
  49 $gPackageSource = "$gConfigDir/indices/sources";
  50
  51 $gWebDomain will probably exist already; change it as shown above.
  52
  53 $gSubscriptionDomain is optional.
  54
  55 $gMaintainerFileOverride is the name of a file used to manually override the
  56 Maintainers file (which is often automatically generated).
  57
  58 $gUnknownMaintainerEmail is the address to mail when a bug report arrives
  59 for a package with no maintainer in $gMaintainerFile or
  60 $gMaintainerFileOverride.
  61
  62 $gPackageSource is a file containing three tab-separated columns: package
  63 name, component (e.g. main, contrib, non-free), and the corresponding source
  64 package name.
  65
  66 Add the following variable to the /etc/debbugs/text file:
  67
  68 ############################################################################
  69 # Description of the tags
  70 ############################################################################
  71 $gHTMLTagDesc = "
  72 <dt><code>patch</code>
  73   <dd>A patch or some other easy procedure for fixing the $gBug is included in
  74   the $gBug logs. If there\'s a patch, but it doesn\'t resolve the $gBug
  75   adequately or causes some other problems, this tag should not be used.
  76
  77 <dt><code>wontfix</code>
  78   <dd>This $gBug won\'t be fixed. Possibly because this is a choice between two
  79   arbitrary ways of doing things and the maintainer and submitter prefer
  80   different ways of doing things, possibly because changing the behaviour
  81   will cause other, worse, problems for others, or possibly for other
  82   reasons.
  83
  84 <dt><code>moreinfo</code>
  85   <dd>This $gBug can\'t be addressed until more information is provided by the
  86   submitter. The $gBug will be closed if the submitter doesn\'t provide ore
  87   information in a reasonable (few months) timeframe. This is for $gBugs like
  88   \"It doesn\'t work\". What doesn\'t work?
  89
  90 <dt><code>unreproducible</code>
  91   <dd>This $gBug can\'t be reproduced on the maintainer\'s system.  Assistance
  92   from third parties is needed in diagnosing the cause of the problem.
  93
  94 <dt><code>fixed</code>
  95   <dd>This $gBug is fixed or worked around, but there\'s still an issue that
  96   needs to be resolved. (This will eventually replace the \"fixed\" severity)
  97
  98 <dt><code>stable</code>
  99   <dd>This $gBug affects the stable distribution in particular.  This is only
 100   intended to be used for ease in identifying release critical $gBugs that
 101   affect the stable distribution.  It\'ll be replaced eventually with
 102   something a little more flexible, probably.
 103 ";
 104
 105 The bug database is now stored in a hashed directory format (db-h).  You
 106 will need to migrate your database to this new format.  The
 107 /usr/sbin/debbugs-dbhash program is provided to help you perform this
 108 migration.
 109
 110 From 2.2 to 2.3
 111 ---------------
 112
 113 There are three new scripts that have to be installed in CGI and the front
 114 page (or any other search you have set up) needs to be changed to use these
 115 scripts.  They are:
 116         * bugreport.cgi
 117         * common.pl
 118         * pkgreport.cgi
 119
 120 Add the following variables to the /etc/debbugs/config file:
 121 (the /usr/share/doc/debbugs/examples/config file can be used as a
 122 reference)
 123
 124 $gSummaryList = "summary.list";         #debian-bugs-report@lists
 125 $gSaveOldBugs = 1;
 126
 127 Make sure you do not have a double ,, as shown here if you're using the
 128 default severities.  Also, 'fixed' was added to the default severities:
 129 -                                       'normal',"Normal $gBugs",,
 130 +                                       'normal',"Normal $gBugs",
 131 +                                                       'fixed',"NMU Fixed $gBugs",
 132
 133 These have been added to the /etc/debbugs/text file:
 134 +############################################################################
 135 +#  Here is a blurb to point people to ftp archive of directions.  It is
 136 +#  used by the receive script when bouncing a badly formatted email
 137 +#
 138 +# $gTextInstructions = "$gBadEmailPrefix
 139 +# $gBadEmailPrefix Instructions are available from ftp.debian.org in /debian
 140 +# $gBadEmailPrefix and at all Debian mirror sites, in the files:
 141 +# $gBadEmailPrefix  doc/bug-reporting.txt
 142 +# $gBadEmailPrefix  doc/bug-log-access.txt
 143 +# $gBadEmailPrefix  doc/bug-maint-info.txt
 144 +# $gBadEmailPrefix";
 145 +############################################################################
 146 +$gTextInstructions = "$gBadEmailPrefix";
 147 +
 148 +
 149
 150 $gHTMLStart = "<BODY TEXT=#0F0F0F>";    #this is used by HTML generation to create the "uniform look"
 151
 152 The following code was added to /etc/debbugs/text if you use the new fixed
 153 severity
 154
 155         <DT><CODE>wishlist</CODE>
 156 -       <DD>for any feature request, and also for any $gBugs that are very difficult
 157 -       to fix due to major design considerations.";
 158 +       <DD>for any feature request, and also for any $gBugs that are very
 159 +       difficult to fix due to major design considerations.";
 160 +
 161 +       <DT><CODE>fixed</CODE>
 162 +       <DD>fixed in the current version in the unstable archive but the fix has
 163 +       not been fixed by the person responsible.
 164
 165  In All such entries in /etc/debbugs/text, if you replace <BODY> with
 166  $gHTMLStart, all html pages will have the same look (as specified in
 167  $gHTMLStart):
 168
 169  $gSummaryIndex = "<HTML><HEAD><TITLE>$gProject $gBug report logs - summary index</TITLE>
 170  $gPackageLog = "<HTML><HEAD><TITLE>$gProject $gBug report logs - index by package</TITLE>