]> git.donarmstrong.com Git - debian/debian-policy.git/blob - upgrading-checklist.html
f3bf0af135ee466b01dcef9983b78a2dabdf903d
[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 : Sat Jun 18 00:16:40 2005
11     Last Machine Used: glaurung.internal.golden-gryphon.com
12     Update Count     : 51
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'; it simply
31 gives an indication of what has changed and whether you are likely to
32 need to make changes to your package in light of this.  If you have
33 doubts about a certain topic, if you need more details, or if you
34 think some other package does not comply with policy, please refer to
35 the Policy Manual itself.  All of the changes from version 3.0.0
36 onwards indicate which section of the Policy Manual discusses the
37 issue: [3.4] means section 3.4.  The section numbering changed when
38 the packaging manual was incorporated into policy; the section numbers
39 used below refer to the current version.
40 </p>
41
42 <p>
43 Here is how the check list works: Check which policy version your
44 package complies with currently (indicated in the "Standards-Version"
45 field of the source package).  Then move upwards until the top and
46 check which of the items on the list might concern your package.  Note
47 which sections of policy discuss this, and then check out the Policy
48 Manual for details.  If you are upgrading from Policy version < 2.5.0,
49 it may be easier to check through the whole of policy instead of
50 picking your way through this list.
51 </p>
52
53 <h2>The checklist</h2>
54
55 <pre>
56 3.7.3.0                        unreleased
57      * Package version numbers may contain tildes, which sort before
58        anything, even the end of a part.                         [5.6.12]
59      * Scripts may assume that /bin/sh supports local (at a basic level)
60        and that its test builtin (if any) supports -a and -o binary
61        logical operators.                                        [10.4]
62      * The substitution variable ${binary:Version} should be used in place
63        of ${Source-Version} for dependencies between packages of the same
64        library.                                                  [8.5]
65      * Substantial reorganization and renaming of sections in the Debian
66        menu structure.  Packages with menu entries should be reviewed to
67        see if the menu section has been renamed or if one of the new
68        sections would be more appropriate.                       [menu policy]
69 3.7.2.2                        Oct 2006
70      * Maintainer scripts must not be world writeable (up from a
71        should to a must)                                         [6.1]
72 3.7.2.0                        Apr 2006
73      * Revert the cgi-lib change.                                [11.5]
74
75 3.7.1.0                        Apr 2006
76      * It is now possible to create shared libraries without
77        relocatable code (using -fPIC) in certain exceptional cases,
78        provided some procedures are followed, and for creating static
79        libraries with relocatable code (again, using -fPIC).
80        Discussion on debian-devel@lists.debian.org, getting a rough
81        consensus, and documenting it in README.Debian constitute most
82        of the process.                                           [10.2]    
83      * Packages should install any relevant files into the directories
84        /usr/include/X11/and /usr/lib/X11/, but if they do so, they
85        must  pre-depend on x11-common (>= 1:7.0.0)              [11.8.7] 
86
87 3.7.0.0                        Apr 2006
88      * Packages shipping web server CGI files are expected to install
89        them in /usr/lib/cgi-lib/ directories.  This location change
90        perhaps should be documented in NEWS                      [11.5]
91      * Web server packages should include a standard scriptAlias of
92        cgi-lib to /usr/lib/cgi-lib.                              [11.5]
93      * The version of FHS mandated by policy has been upped to
94        2.3. There should be no changes required for most packages,
95        though new top level directories /media, /srv, etc may be of
96        interest.                                                 [9.1.1]
97      * All fields, apart from the Uploaders field, in the control file
98        are supposed to be a single logical line, which may be spread
99        over multiple physical  lines (newline followed by space is
100        elided).  However, any parser for the control file must allow
101        the Uploaders field to be spread over multiple physical lines
102        as well, to prepare for future changes.                 [ 5.1, 5.6.3 ]
103      * When scripts are installed into a directory in the system
104        PATH, the script name should not include an extension that
105        denotes the scripting language currently used to implement it.
106                                                               [ 10.4 ]
107      * packages that invoke initscripts now must use invoke-rc.d to do
108        so since it also pays attention to run levels and other local
109        constraints.                                                [ 9.3.3.2 ]
110      * We no longer use /usr/X11R6, since we have migrated away to
111        using Xorg paths. This means, for one thing, fonts live in
112        /usr/share/fonts/X11/ now, and /usr/X11R6 is gone.
113                                                       [ 11.8.5.2, 11.8.7, etc]
114
115
116 3.6.2.0                        2005
117      * Recommend doc-base, and not menu, for registering package documentation.
118      * Run time support programs should live in subdirectories of
119        /usr/lib/ or /usr/share, and preferably the shared lib is named
120        the same as the package name (to avoid name collisions). [8.1]
121      * It is recommended that HTTP servers provide an alias /images to
122        allow packages to share image files with the web server [11.5]
123
124 3.6.1.0                    Aug 2003
125      + Prompting the user should be done using debconf. Non debconf
126        user prompts are now deprecated. [3.10.1]
127
128 3.6.0                      Jul 2003
129
130      - Restructuring causing shifts in section numbers and bumping of
131        the minor version number:
132      + Many packaging manual appendices that were integrated into policy
133        sections are now empty, and replaced with links to the Policy.
134        In particular, the appendices that included the list of control
135        fields were updated (new fields like Closes, Changed-By were added)
136        and the list of fields for each of control, .changes and .dsc files
137        is now in Policy, and they're marked mandatory, recommended or
138        optional based on the current practice and the behavior of the
139        deb-building tool-chain.
140      + Elimination of needlessly deep section levels, primarily in the
141        chapter Debian Archive, from which two new chapters were split out,
142        Binary packages and Source packages. What remained was reordered
143        properly, that is, some sect1s became sects etc.
144      + Several sections that were redundant, crufty or simply not designed
145        with any sort of vision, were rearranged according to the formula that
146        everything should be either in the same place or properly interlinked.
147        Some things remained split up between different chapters when they
148        talked about different aspects of files: their content, their syntax,
149        and their placement in the file system. In particular, see the new
150        sections about changelog files.
151      - Added Games/Simulation and Apps/Education to menu sub-policy
152        [menu policy]
153      - Debian changelogs should be UTF-8 encoded. [C.2.2]
154      - shared libraries must be linked against all libraries that they
155        use symbols from in the same way that binaries are. [10.2]
156      - build-depends-indep need not be satisfied during clean
157        target. [7.6] 
158
159 3.5.10                     May 2003
160
161      - packages providing the x-terminal-emulator virtual package
162        ought to ensure that they interpret the command line exactly
163        like xterm does. [11.8.3]
164      - Window managers compliant with the Window Manager Specification
165        Project may add 40 points for ranking in the alternatives [11.8.4]
166
167
168 3.5.9.0                    Mar 2003
169
170      - The section describing the Description: package field once again has
171        full details of the long description format. [3.4.2]
172      - Clarified that if a package has non-build-essential
173        build-dependencies, it should have them listed in the Build-Depends
174        and related fields (i.e. it's not merely optional). [4.2]
175      - When asked to restart a service that isn't already running,
176        the init script should start the service. [9.3.2]
177      - If the purpose of a package is to provide examples, then the
178        example files can be installed into <tt>/usr/share/doc/package</tt>
179        (rather than <tt>/usr/share/doc/package/examples</tt>). [12.6]
180
181
182 3.5.8.0                    Nov 2002
183
184      - It is no longer necessary to keep a log of changes to the upstream
185        sources in the copyright file. Instead, all such changes should be
186        documented in the changelog file. [12.7]
187      - <tt>Build-Depends</tt>,  <tt>Build-Conflicts</tt>,
188        <tt>Build-Depends-Indep</tt>, and
189        <tt>Build-Conflicts-Indep</tt> must also be satisfied when the
190        clean target is called. [7.6]
191      - A new Apps/Science menu section is available [menu policy]
192      - debconf specification cleared up, various changes. [debconf
193        policy]
194      - It is no longer recommended to create symlinks from nonexistent
195        manual pages to undocumented(7). Missing manual pages for programs
196        are still a bug. [12.1]
197
198 3.5.7.0                    Aug 2002
199
200      - Packages no longer have to ask permission to call MAKEDEV in
201        postinst, merely notifying the user ought to be enough. [10.6]
202      - cryptographic software may now be included in the main
203        archive. [2.2.4]
204      - task packages are no longer permitted; tasks are now created by a
205        special Tasks: field in the control file. [3.9]
206      - window managers that support netwm can now add 20 points when
207        they add themselves as an alternative for
208        /usr/bin/x-window-manager [11.8.4]
209      - The default compilation options have now changed, one should
210        provide debugging symbols in all cases, and optionally step
211        back optimization to -O0, depending on the DEB_BUILD_OPTIONS
212        environment variable. [10.1]
213      - Added mention of build-arch, build-indep, etc, in describing
214        the relationships with `Build-Depends', `Build-Conflicts',
215        `Build-Depends-Indep', and `Build-Conflicts-Indep'. May need to
216        review the new rules.  [7.6, 4.8]
217      - Changed rules on how, and when, to invoke ldconfig in maintainer
218        scripts. Long rationale. [8]
219      - [Added the last note in 3.5.6 upgrading checklist item regarding
220        build rules, please see below]
221
222 3.5.6.0                    Jul 2001
223
224      - Emacs and TeX are no longer mandated by policy to be priority
225        standard packages [2.5]
226      - Programs that access docs need to do so via /usr/share/doc, and
227        not via /usr/doc/ as was the policy previously [11.5]
228      - Putting documentation in /usr/doc versus /usr/share/doc is now
229        a ``serious'' policy violation. [12.3]
230      - For web servers, one should not provide non-local access to the
231        /usr/share/doc hierarchy. If one can't provide access controls for
232        the http://localhost/doc/ directory, then it is preferred that one
233        ask permission to expose that information during the install. [11.5]
234      - There are new rules for build-indep/build-arch targets and
235        there is a new Build-Depend-Indep semantic. [7]
236
237
238 3.5.5.0                    May 2001
239
240      - Manpages should not rely on header information to have
241        alternative manpage names available; it should only use
242        symlinks or .so pages to do this [12.1]
243      - [Clarified note in 3.5.3.0 upgrading checklist regarding
244         examples and templates: this refers only to those examples used
245         by scripts; see section 10.7.3 for the whole story]
246      - Included a new section 10.9.1 describing the use of
247        dpkg-statoverride; this does not have the weight of policy
248      - Clarify Standards-Version: you don't need to rebuild your
249        packages just to change the Standards-Version!
250      - Plugins are no longer bound by all the rules of shared
251        libraries [10.2]
252      - X Windows related things:
253        * Clarification of priority levels of X Window System related
254          packages [11.8.1]
255        * Rules for defining x-terminal-emulator improved [11.8.3]
256        * X Font policy rewritten: you must read this if you provide
257          fonts for the X Window System [11.8.5]
258        * Packages must not ship /usr/X11R6/lib/X11/app-defaults/ [11.8.6]
259        * X-related packages should usually use the regular FHS
260          locations; imake-using packages are exempted from this [11.8.7]
261        * OpenMotif linked binaries have the same rules as
262          OSF/Motif-linked ones [11.8.8]
263
264
265 3.5.4.0                    Apr 2001
266
267      - The system-wide mail directory is now /var/mail, no longer
268        /var/spool/mail.  Any packages accessing the mail spool should
269        access it via /var/mail and include a suitable Depends field;
270        details in [11.6]
271      - The perl policy is now part of Debian policy proper. Perl
272        programs and modules should follow the current Perl policy
273        [11.9; perl-policy]
274
275
276 3.5.3.0                    Apr 2001
277
278      - Build-Depends arch syntax has been changed to be less
279        ambiguous. This should not affect any current packages [7.1]
280      - Examples and templates files for use by scripts should now live
281        in /usr/share/&lt;package&gt; or /usr/lib/&lt;package&gt;, with
282        symbolic links from /usr/share/doc/&lt;package&gt;/examples as
283        needed [10.7.3]
284
285
286 3.5.2.0                    Feb 2001
287
288      - X app-defaults directory has moved from
289        /usr/X11R6/lib/X11/app-defaults to /etc/X11/app-defaults [11.8.6]
290
291
292 3.5.1.0                    Feb 2001
293
294      - dpkg-shlibdeps now uses objdump, so shared libraries have to be
295        run through dpkg-shlibdeps as well as executables [8.1]
296
297
298 3.5.0.0                    Jan 2001
299
300      - Font packages for the X Window System must now declare a
301        dependency on xutils (>= 4.0.2) [11.8.5]
302
303
304 3.2.1.1                    Jan 2001
305
306      - Daemon startup scripts in /etc/init.d/ should not contain
307        modifiable parameters; these should be moved to a file in
308        /etc/default/; see [9.3.2] for details
309      - Files in /usr/share/doc must not be referenced by any
310        program.  If such files are needed, they must be placed in
311        /usr/share/&lt;package&gt;/, and symbolic links created as required
312        in /usr/share/doc/&lt;package&gt;/ [12.3]
313      - Much of the packaging manual has now been imported into the
314        policy document
315
316
317 3.2.1.0                    Aug 00
318
319      - A package of priority standard or higher may provide two
320        binaries, one compiled with support for the X Window System,
321        and the other without [11.8.1]
322
323
324 3.2.0.0                    Aug 00
325
326      - By default executables should not be built with the debugging
327        option -g. Instead, it is recommended to support building the
328        package with debugging information optionally.  Details in [10.1]
329      - Policy for packages where the upstream uses HTML changelog
330        files has been expanded.  In short, a plain text changelog file
331        should always be generated for the upstream changes [12.8]
332      - Please note that the new release of the X window system (3.2)
333        shall probably need sweeping changes in policy
334      - Policy for packages providing the following X-based features
335        has been codified:
336        - X server (virtual package xserver) [11.8.2]
337        - X terminal emulator (virtual package x-terminal-emulator) [11.8.3]
338        - X window manager (virtual package x-window-manager, and
339          /usr/bin/x-window-manager alternative, with priority
340          calculation guidelines) [11.8.4]
341        - X fonts (this section has been written from scratch) [12.8.5]
342        - X application defaults [11.8.6]
343      - Policy for packages using the X Window System and FHS issues
344        has been clarified; see [11.8.7]
345      - No package may contain or make hard links to conffiles [11.7.3]
346      - Noted that newer dpkg versions do not require extreme care in
347        always creating the shared lib before the symlink, so the unpack
348        order be correct [8]
349
350
351 3.1.1.0                    Nov 1999
352
353      - Correction to semantics of architecture lists in Build-Depends
354        etc.  Should not affect many packages [7.1]
355
356
357 3.1.0.0                    Oct 1999
358
359      - /usr/doc/&lt;package&gt; has to be a symlink pointing to
360        /usr/share/doc/&lt;package&gt;, to be maintained by postinst
361        and prerm scripts.  Details are in [defunct]
362      - Introduced source dependencies (Build-Depends, etc.) [7.1, 7.6]
363      - /etc/rc.boot has been deprecated in favour of /etc/rcS.d.
364        (Packages should not be touching this directory, but should use
365        update-rc.d instead) [9.3.4]
366      - update-rc.d is now the *only* allowable way of accessing the
367        /etc/rc?.d/[SK]??* links.  Any scripts which manipulate them
368        directly must be changed to use update-rc.d instead.  (This is
369        because the file-rc package handles this information in an
370        incompatible way.) [9.3.3]
371      - Architecture-specific examples go in /usr/lib/&lt;package&gt;/examples
372        with symlinks from /usr/share/doc/&lt;package&gt;/examples/* or from
373        /usr/share/doc/&lt;package&gt;/examples itself [12.7]
374      - Updated FHS to a 2.1 draft; this reverts /var/state to
375        /var/lib [9.1.1]
376      - Added MIME sub-policy document [9.7; mime-policy]
377      - VISUAL is allowed as a (higher priority) alternative to EDITOR [12.4]
378      - Modified liblockfile description, which affects
379        mailbox-accessing programs.  Please see the policy document for
380        details [11.6]
381      - If a package provides a changelog in HTML format, a text-only
382        version should also be included.  (Such a version may be prepared
383        using lynx -dump -nolist.) [12.7]
384      - Description of how to handle version numbers based on dates
385        added [3.2.1]
386
387
388 3.0.1.0                    Jul 1999
389
390     -  Added the clarification that the .la files are essential for the
391        packages using libtool's libltdl library, in which case the
392        .la files must go in the run-time library package [10.2]
393
394
395 3.0.0.0                    Jun 1999
396
397     - Debian formally moves from the FSSTND to the FHS. This is a
398       major change, and the implications of this move are probably
399       not all known. [9.1]
400     - Only 3 digits of the Standards version need be included in
401       control files, though all four digits are still permitted. [4.1]
402     - The location of the GPL has changed to
403       /usr/share/common-licenses. This may require changing the
404       copyright files to point to the correct location of the GPL and
405       other major licenses [12.6]
406     - Packages that use libtool to create shared libraries must
407       include the .la files in the -dev packages [10.2]
408     - Use logrotate to rotate log files [10.8]
409     - section 5.8 has been rewritten (Programs for the X Window
410       System) [now 11.8]
411     - There is now an associated menu policy, in a separate document,
412       that carries the full weight of Debian policy [9.6; menu-policy]
413     - Programs which need to modify the files /var/run/utmp,
414       /var/log/wtmp and /var/log/lastlog must be installed setgid utmp [11.3]
415
416
417 ** Please note that section numbers below this point may not be up to date **
418
419
420 2.5.0.0                         Oct 1998
421
422   Policy Manual:
423     - Rearranged the manual to create a new Section 4, Files
424       + Section 3.3 ("Files") was moved to Section 4. The Sections
425         that  were Section 4 and Section 5 were  moved down to become
426         Section 5 and Section 6.
427       + What was Section 5.5 ("Log files") is now a subsection of the
428         new Section 4 ("Files"), becoming section 4.8, placed after
429         "Configuration files", moving the Section 4.8 ("Permissions
430         and owners") to Section 4.9.  All subsections of the old
431         Section 5 after 5.5  were moved down to fill in the number
432         gap.
433     - Modified the section about changelog files to accommodate
434       upstream changelogs which were formatted as HTML/ These
435       upstream changelog files should now be accessible as
436       /usr/doc/package/changelog.html.gz
437       + Symlinks are permissible to link the real, or upstream,
438         changelog name to the Debian mandated name.
439     - Clarified that HTML documentation should be present in some
440       package, though not necessarily the main binary package.
441     - Corrected all references to the location of the copyright
442       files. The correct location is /usr/doc/package/copyright
443     - Ratified the architecture specification strings to cater to the
444       HURD.
445
446 2.4.1.0                         Apr 1998
447
448   Policy Manual:
449     - Updated section 3.3.5 Symbolic links:
450       + symbolic links within a toplevel directory should be relative,
451         symbolic links between toplevel directories should be absolute
452         (cf., Policy Weekly Issue#6, topic 2)
453
454     - Updated section 4.9 Games:
455       + manpages for games should be installed in /usr/man/man6
456         (cf., Policy Weekly Issue#6, topic 3)
457
458   Packaging Manual:
459     - Updated prefix of chapter 12, Shared Libraries:
460       ldconfig must be called in the postinst script if the package
461       installs shared libraries
462       (cf., Policy Weekly Issue #6, fixes:bug#20515)
463
464 2.4.0.0                         Jan 1998
465
466     - Updated section 3.3.4 Scripts:
467       + /bin/sh may be any POSIX compatible shell
468       + scripts including bashisms have to specify /bin/bash as
469         interpreter
470       + scripts which create files in world-writable directories
471         (e.g., in /tmp) should use tempfile or mktemp for creating
472         the directory
473
474     - Updated section 3.3.5 Symbolic Links:
475       + symbolic links referencing compressed files must have the same
476         file extension as the referenced file
477
478     - Updated section 3.3.6 Device files:
479       + /dev/tty* serial devices should be used instead of /dev/cu*
480
481     - Updated section 3.4.2 Writing the scripts [in /etc/init.d]:
482       + all /etc/init.d scripts have to provide the following options:
483         start, stop, restart, force-reload
484       + the reload option is optional and must never stop and restart
485         the service
486
487     - Updated section 3.5 Cron jobs:
488       + cron jobs that need to be executed more often than daily should
489         be installed into /etc/cron.d
490
491     - Updated section 3.7 Menus:
492       + removed section about how to register HTML docs to `menu'
493         (the corresponding section in 4.4, Web servers and applications,
494         has been removed in policy 2.2.0.0 already, so this one was
495         obsolete)
496
497     - New section 3.8 Keyboard configuration:
498       + details about how the backspace and delete keys should be
499         handled
500
501     - New section 3.9 Environment variables:
502       + no program must depend on environment variables to get a
503         reasonable default configuration
504
505     - New section 4.6 News system configuration:
506       + /etc/news/organization and /etc/news/server should be supported
507         by all news servers and clients
508
509     - Updated section 4.7 Programs for the X Window System:
510       + programs requiring a non-free Motif library should be provided
511         as foo-smotif and foo-dmotif package
512       + if lesstif works reliably for such program, it should be linked
513         against lesstif and not against a non-free Motif library
514
515     - Updated section 4.9 Games:
516       + games for X Windows have to be installed in /usr/games, just as
517         non-X games
518
519 2.3.0.1, 2.3.0.0                Sep 1997
520
521         * new section `4.2 Daemons' including rules for
522           /etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
523
524         * updated section about `Configuration files':
525           packages may not touch other packages' configuration files
526
527         * MUAs and MTAs have to use liblockfile
528
529 2.2.0.0                         Jul 1997
530
531         * added section 4.1 `Architecture specification strings':
532           use
533                &lt;arch&gt;-linux
534           where &lt;arch&gt; is one of the following:
535                i386, alpha, arm, m68k, powerpc, sparc.
536
537         * detailed rules for /usr/local
538
539         * user ID's
540
541         * editor/pager policy
542
543         * cron jobs
544
545         * device files
546
547         * don't install shared libraries as executable
548
549         * app-defaults files may not be conffiles
550
551 2.1.3.2, 2.1.3.1, 2.1.3.0       Mar 1997
552
553         * two programs with different functionality must not have the
554           same name
555
556         * "Webstandard 3.0"
557
558         * "Standard for Console Messages"
559
560         * Libraries should be compiled with `-D_REENTRANT'
561
562         * Libraries should be stripped with "strip --strip-unneeded"
563
564 2.1.2.2, 2.1.2.1, 2.1.2.0       Nov 1996
565
566         * Some changes WRT shared libraries
567
568 2.1.1.0                         Sep 1996
569
570         * No hard links in source packages
571
572         * Do not use dpkg-divert or update-alternatives without consultation
573
574         * Shared libraries must be installed stripped
575
576 2.1.0.0                         Aug 1996
577
578         * Upstream changelog must be installed too
579 </pre>
580
581     <hr>
582
583   </body>
584 </html>
585
586 <!-- Keep this comment at the end of the file
587 Local variables:
588 mode: sgml
589 sgml-indent-data: t
590 sgml-live-element-indicator: t
591 sgml-set-face: t
592 End:
593 -->