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