]> git.donarmstrong.com Git - debbugs.git/blobdiff - UPGRADE
assume unknown encodings are UTF-8
[debbugs.git] / UPGRADE
diff --git a/UPGRADE b/UPGRADE
index 607d698b4cd6190aa3bf06d9cf6832ebf81412ef..b4ab626b93ee6d30347a9a6aa24d2bdd03ec3e26 100644 (file)
--- a/UPGRADE
+++ b/UPGRADE
@@ -1,3 +1,115 @@
+
+                            Debbugs upgrade notes
+                           +=====================+
+
+From 2.4.1 to 2.4.2
+-------------------
+
+The file format used to store the status of a bug (package, severity, etc.)
+has changed; it is now in an RFC822-like format in order to be more
+extensible, and is written to .summary files rather than the old .status
+files. Before accepting any mail with the new version of debbugs, you must
+run the 'debbugs-upgradestatus' program over your bug spool. The old .status
+files will be left intact, and will continue to be written in sync with the
+.summary files for compatibility with external tools.
+
+There is a new standalone spam-scanning script called spamscan, which uses
+the SpamAssassin modules. To use it, set the $gSpamScan variable in
+/etc/debbugs/config to a true value and $gSpamMailbox to an mbox file to
+which detected spam should be appended, add /usr/lib/debbugs/spamscan to
+your crontab as per the example, and optionally set $gSpamRulesDir and
+$gSpamLocalTestsOnly as desired.
+
+From 2.4 to 2.4.1
+-----------------
+
+Add the following variables to the /etc/debbugs/config file:
+
+$gHTMLSuffix = ".html";
+
+The use of $gCGIDomain has been cleaned up; formerly, it needed to begin
+with "http://", which was confusingly inconsistent with all the other domain
+variables. If you worked around this in your configuration, you will need to
+recheck it.
+
+From 2.3 to 2.4
+---------------
+
+Add the following variables to the /etc/debbugs/config file:
+
+$gWebHost = "localhost";                               # e.g. www.debian.org
+$gWebHostBugDir = "Bugs";                              # e.g. Bugs
+# For now, don't change this one manually!
+$gWebDomain = "$gWebHost/$gWebHostBugDir";
+$gCGIDomain = "$gWebDomain/Bugs/cgi";                  # e.g. cgi.debian.org
+$gPackagePages = "packages.debian.org";                 # e.g. packages.debian.org
+$gSubscriptionDomain = "packages.something";           # e.g. packages.qa.debian.org
+$gMaintainerFileOverride = "$gConfigDir/Maintainers.override";
+$gUnknownMaintainerEmail = "$gMaintainerEmail";
+$gPackageSource = "$gConfigDir/indices/sources";
+
+$gWebDomain will probably exist already; change it as shown above.
+
+$gSubscriptionDomain is optional.
+
+$gMaintainerFileOverride is the name of a file used to manually override the
+Maintainers file (which is often automatically generated).
+
+$gUnknownMaintainerEmail is the address to mail when a bug report arrives
+for a package with no maintainer in $gMaintainerFile or
+$gMaintainerFileOverride.
+
+$gPackageSource is a file containing three tab-separated columns: package
+name, component (e.g. main, contrib, non-free), and the corresponding source
+package name.
+
+Add the following variable to the /etc/debbugs/text file:
+
+############################################################################
+# Description of the tags
+############################################################################
+$gHTMLTagDesc = "
+<dt><code>patch</code>
+  <dd>A patch or some other easy procedure for fixing the $gBug is included in
+  the $gBug logs. If there\'s a patch, but it doesn\'t resolve the $gBug
+  adequately or causes some other problems, this tag should not be used.
+
+<dt><code>wontfix</code>
+  <dd>This $gBug won\'t be fixed. Possibly because this is a choice between two
+  arbitrary ways of doing things and the maintainer and submitter prefer
+  different ways of doing things, possibly because changing the behaviour
+  will cause other, worse, problems for others, or possibly for other
+  reasons.
+
+<dt><code>moreinfo</code>
+  <dd>This $gBug can\'t be addressed until more information is provided by the
+  submitter. The $gBug will be closed if the submitter doesn\'t provide ore
+  information in a reasonable (few months) timeframe. This is for $gBugs like
+  \"It doesn\'t work\". What doesn\'t work?
+
+<dt><code>unreproducible</code>
+  <dd>This $gBug can\'t be reproduced on the maintainer\'s system.  Assistance
+  from third parties is needed in diagnosing the cause of the problem.
+
+<dt><code>fixed</code>
+  <dd>This $gBug is fixed or worked around, but there\'s still an issue that
+  needs to be resolved. (This will eventually replace the \"fixed\" severity)
+
+<dt><code>stable</code>
+  <dd>This $gBug affects the stable distribution in particular.  This is only
+  intended to be used for ease in identifying release critical $gBugs that
+  affect the stable distribution.  It\'ll be replaced eventually with
+  something a little more flexible, probably.
+";
+
+The bug database is now stored in a hashed directory format (db-h).  You
+will need to migrate your database to this new format.  The
+/usr/sbin/debbugs-dbhash program is provided to help you perform this
+migration.
+
+From 2.2 to 2.3
+---------------
+
 There are three new scripts that have to be installed in CGI and the front
 page (or any other search you have set up) needs to be changed to use these
 scripts.  They are: