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