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