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