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