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