serve_cache is not exported by Debbugs::Libravatar

[debbugs.git] / UPGRADE

diff --git a/UPGRADE b/UPGRADE
index 8dd1f5a27479f4399bf10fc37ad3cbbdaac39792..b4ab626b93ee6d30347a9a6aa24d2bdd03ec3e26 100644 (file)
--- a/UPGRADE
+++ b/UPGRADE
@@ -2,9 +2,67 @@
                             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:
 
 ############################################################################
@@ -44,6 +102,11 @@ $gHTMLTagDesc = "
   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
 ---------------