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