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