]> git.donarmstrong.com Git - debian/debian-policy.git/blob - upgrading-checklist.html
final edits
[debian/debian-policy.git] / upgrading-checklist.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
2 <html>
3   <head>
4  <!--                             -*- Mode: Sgml -*- 
5     upgrading-checklist.html
6     Author           : Manoj Srivastava ( srivasta@tiamat.datasync.com ) 
7     Created On       : Thu Oct 29 20:54:48 1998
8     Created On Node  : tiamat.datasync.com
9     Last Modified By : Manoj Srivastava
10     Last Modified On : Wed Jun 30 12:35:32 1999
11     Last Machine Used: glaurung.green-gryphon.com
12     Update Count     : 7
13     Status           : Unknown, Use with caution!
14     HISTORY          : 
15     Description      : 
16
17     -->
18
19
20     <title>Policy checklist for upgrading your packages</title>
21   </head>
22   <body>
23
24     <h1>Policy checklist for upgrading your packages</h1>
25
26     <h2>About the checklist</h2>
27
28 <p>
29 The checklist below has been created to simplify the upgrading process
30 of old packages. Note, that this list is not `official.' If you have
31 doubts about a certain topic, if you need more details, or if you
32 think some other package does not comply with policy, please refer to
33 the Policy Manual.
34 </p>
35
36 <p>
37 Here is how the check list works: Check out which policy version your
38 packages complies with currently. Than move upwards until the top and
39 check which of the items on the list might concern your package. If an
40 item does not give you enough details, please check out the Policy
41 Manual.
42 </p>
43
44 <h2>The checklist</h2>
45
46 <pre>
47 3.0.0.0                    Jun 99
48
49   Policy Manual:
50      - Debian formally moves from the FSSTND to the FHS. This is a
51        major change, and the implications of this move are probably
52        not all know.
53     - Only 3 digits of the Standards version need be included in
54       control files, though all four digits are still permitted. 
55     - The location of the GPL has changed to
56       /usr/share/common-licenses. This may require changing the
57       copyright files to point to the correct location of the GPL and
58       other major licences
59     - Packages that use libtool to create shared libraries must
60       include the .la files in the -dev packages.
61     - Use logrotate to rotate log files
62     - section 5.8 has been rewritten (Programs for the X Window
63       System) 
64     - There is now anassi=ociated menu policy, in a separate document,
65       that carries the full weight of Debian policy. 
66     - The files `/var/run/utmp', `/var/log/wtmp' and
67       `/var/log/lastlog' must be installed writeable by group
68       utmp. Programs who need to modify those files must be installed
69       install setgid utmp.
70
71
72 2.5.0.0                         Oct 98
73
74   Policy Manual:
75     - Rearranged the manual to create a new Section 4, Files
76       + Section 3.3 ("Files") was moved to Section 4. The Sections
77         that  were Section 4 and Section 5 were  moved down to become
78         Section 5 and Section 6.
79       + What was Section 5.5 ("Log files") is now a subsection of the
80         new Section 4 ("Files"), becoming section 4.8, placed after
81         "Configuration files", moving the Section 4.8 ("Permissions
82         and owners") to Section 4.9.  All subsections of the old
83         Section 5 after 5.5  were moved down to fill in the number
84         gap. 
85     - Modified the section about changelog files to accomodate
86       upstream changelogs which were formatted as HTML/ These
87       upstream chagelog files should now be accessible as
88       /usr/doc/package/changelog.html.gz 
89       + Symlinks are permissible to link the real, or upstream,
90         changelog name to the Debian mandated name.
91     - Clarified that HTML documentation should be present in some
92       package, though not necessarily the main binary package.
93     - Corrected all references to the location of the copyright
94       files. The correct location is /usr/doc/package/copyright
95     - Ratified the architecture specification strings to cater to the
96       HURD. 
97
98 2.4.1.0                         Apr 98
99
100   Policy Manual:
101     - Updated section 3.3.5 Symbolic links:
102       + symbolic links within a toplevel directory should be relative,
103         symbolic links between toplevel directories should be absolute
104         (cf., Policy Weekly Issue#6, topic 2)
105
106     - Updated section 4.9 Games:
107       + manpages for games should be installed in /usr/man/man6
108         (cf., Policy Weekly Issue#6, topic 3)
109
110   Packaging Manual:
111     - Updated prefix of chapter 12, Shared Libraries:
112       ldconfig must be called in the postinst script if the package
113       installs shared libraries
114       (cf., Policy Weekly Issue #6, fixes:bug#20515)
115   
116 2.4.0.0                         Jan 98
117
118     - Updated section 3.3.4 Scripts:
119       + /bin/sh may be any POSIX compatible shell
120       + scripts including bashisms have to specify /bin/bash as
121         interpreter
122       + scripts which create files in world-writable directories
123         (e.g., in /tmp) should use tempfile or mktemp for creating
124         the directory
125
126     - Updated section 3.3.5 Symbolic Links:
127       + symbolic links referencing compressed files must have the same
128         file extension as the referenced file
129
130     - Updated section 3.3.6 Device files:
131       + /dev/tty* serial devices should be used instead of /dev/cu*
132
133     - Updated section 3.4.2 Writing the scripts [in /etc/init.d]:
134       + all /etc/init.d scripts have to provide the following options:
135         start, stop, restart, force-reload
136       + the reload option is optional and must never stop and restart
137         the service
138
139     - Updated section 3.5 Cron jobs:
140       + cron jobs that need to be executed more often than daily should
141         be installed into /etc/cron.d
142
143     - Updated section 3.7 Menus:
144       + removed section about how to register HTML docs to `menu'
145         (the corresponding section in 4.4, Web servers and applications,
146         has been removed in policy 2.2.0.0 already, so this one was
147         obsolete)
148
149     - New section 3.8 Keyboard configuration:
150       + details about how the backspace and delete keys should be
151         handled
152
153     - New section 3.9 Environment variables:
154       + no program must depend on environment variables to get a
155         reasonable default configuration
156
157     - New section 4.6 News system configuration:
158       + /etc/news/organization and /etc/news/server should be supported
159         by all news servers and clients
160
161     - Updated section 4.7 Programs for the X Windows system:
162       + programs requiring a non-free Motif library should be provided
163         as foo-smotif and foo-dmotif package
164       + if lesstif works reliably for such program, it should be linked
165         against lesstif and not against a non-free Motif library
166
167     - Updated section 4.9 Games:
168       + games for X Windows have to be installed in /usr/games, just as
169         non-X games
170
171 2.3.0.1, 2.3.0.0                Sep 97
172
173         * new section `4.2 Daemons' including rules for
174           /etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
175
176         * updated section about `Configuration files':
177           packages may not touch other packages' configuration files  
178
179         * MUAs and MTAs have to use liblockfile
180
181 2.2.0.0                         Jul 97
182
183         * added section 4.1 `Architecture specification strings':
184           use
185                &lt;arch&gt;-linux 
186           where &lt;arch&gt; is one of the following:
187                i386, alpha, arm, m68k, powerpc, sparc.
188
189         * detailed rules for /usr/local
190
191         * user ID's
192
193         * editor/pager policy
194
195         * cron jobs
196
197         * device files
198
199         * don't install shared libraries as executable
200
201         * app-defaults files may not be conffiles
202
203 2.1.3.2, 2.1.3.1, 2.1.3.0       Mar 97
204
205         * two programs with different functionality must not have the
206           same name
207
208         * "Webstandard 3.0"
209
210         * "Standard for Console Messages"
211
212         * Libraries should be compiled with `-D_REENTRANT'
213
214         * Libraries should be stripped with "strip --strip-unneeded"
215
216 2.1.2.2, 2.1.2.1, 2.1.2.0       Nov 96
217
218         * Some changes WRT shared libraries
219
220 2.1.1.0                         Sep 96
221
222         * No hard links in source packages
223         
224         * Do not use dpkg-divert or update-alternatives without consultation
225
226         * Shared libraries must be installed stripped
227
228 2.1.0.0                         Aug 96
229
230         * Upstream changelog must be installed too
231 </pre>
232
233     <hr>
234
235   </body>
236 </html>
237
238
239
240
241
242
243
244
245
246
247 <!-- Keep this comment at the end of the file
248 Local variables:
249 mode: sgml
250 sgml-indent-data: t
251 sgml-live-element-indicator: t
252 sgml-set-face: t
253 End:
254 -->