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