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