upgrading-checklist.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
   2 <html>
   3   <head>
   4  <!--                             -*- Mode: Sgml -*-
   5     -->
   6
   7
   8     <title>Policy checklist for upgrading your packages</title>
   9   </head>
  10   <body>
  11
  12     <h1>Policy checklist for upgrading your packages</h1>
  13
  14     <h2>About the checklist</h2>
  15
  16 <p>
  17 The checklist below has been created to simplify the upgrading process
  18 of old packages.  Note that this list is not `official'; it simply
  19 gives an indication of what has changed and whether you are likely to
  20 need to make changes to your package in light of this.  If you have
  21 doubts about a certain topic, if you need more details, or if you
  22 think some other package does not comply with policy, please refer to
  23 the Policy Manual itself.  All of the changes from version 3.0.0
  24 onwards indicate which section of the Policy Manual discusses the
  25 issue: [3.4] means section 3.4.  The section numbering changed when
  26 the packaging manual was incorporated into policy; the section numbers
  27 used below refer to the current version.
  28 </p>
  29
  30 <p>
  31 Here is how the check list works: Check which policy version your
  32 package complies with currently (indicated in the "Standards-Version"
  33 field of the source package).  Then move upwards until the top and
  34 check which of the items on the list might concern your package.  Note
  35 which sections of policy discuss this, and then check out the Policy
  36 Manual for details.  If you are upgrading from Policy version < 2.5.0,
  37 it may be easier to check through the whole of policy instead of
  38 picking your way through this list.
  39 </p>
  40
  41 <h2>The checklist</h2>
  42
  43 <pre>
  44 3.8.2.0                        Jun 2009
  45
  46      * The list of archive sections has been significantly expanded.  See
  47        http://lists.debian.org/debian-devel-announce/2009/03/msg00010.html
  48        for the list of new sections and rules for how to categorize
  49        packages.                                                 [2.4]
  50      * All packages must use debconf or equivalent for user prompting,
  51        though essential packages or their dependencies may also fall
  52        back on other methods.                                    [3.9.1]
  53      * Legacy XFree86 servers no longer get a special exception from the
  54        FHS permitting /etc/X11/XF86Config-4.                     [9.1]
  55      * Removed obsolete dependency requirements for packages that use
  56        /var/mail.                                                [9.1.3]
  57      * Speedo fonts are now deprecated.  The X backend was disabled
  58        starting in lenny.                                        [11.8.5]
  59      * The GNU Free Documentation License version 1.3 is included in
  60        common-licenses and should be referenced from there.      [12.5]
  61      * The requirements for source package names are now explicitly
  62        spelled out.                                              [5.6.1]
  63
  64 3.8.1.0                        Mar 2009
  65
  66      * Care should be taken when adding functionality to essential and
  67        such additions create an obligation to support that functionality
  68        in essential forever unless significant work is done.     [3.8]
  69      * Changelog files must be encoded in UTF-8.                 [4.4]
  70      * Tighten some format requirements for changelog files from a should
  71        to a must.                                                [4.4]
  72      * Remove alternative changelog formats.  Debian only supports one
  73        changelog format for the Debian Archive.                  [4.4.1]
  74      * New nocheck option for DEB_BUILD_OPTIONS indicating any build-time
  75        test suite provided by the package should not be run.     [4.9.1]
  76      * All control files must be encoded in UTF-8.               [5.1]
  77      * debian/control allows comment lines starting with # with no
  78        preceding whitespace.                                     [5.2]
  79      * Init scripts ending in .sh are not handled specially.  They are not
  80        sourced and are not guaranteed to be run by /bin/sh regardless of
  81        the #! line.  This brings Policy in line with the long-standing
  82        behavior of the init system in Debian.                    [9.3]
  83      * The start action of an init script must exit successfully and not
  84        start the daemon again if it's already running.           [9.3.2]
  85      * /var/run and /var/lock may be mounted as temporary filesystems, and
  86        init scripts must therefore create any necessary subdirectories
  87        dynamically.                                              [9.3.2]
  88      * /bin/sh scripts may assume that local can take multiple variable
  89        arguments and supports assignment.                        [10.4]
  90      * User mailboxes may be mode 600 and owned by the user rather than
  91        mode 660, owned by user, and group mail.                  [11.6]
  92
  93 3.8.0.0                        Jun 2008
  94
  95      * The base section has been removed.  contrib and non-free have been
  96        removed from the section list; they are only categories.  The base
  97        system is now defined by priority.                        [2.4, 3.7]
  98      * If dpkg-source -x doesn't provide the source that will be compiled,
  99        a debian/rules patch target is recommended and should do whatever
 100        else is necessary.                                        [4.9]
 101      * Standardized the format of DEB_BUILD_OPTIONS.  Specified permitted
 102        characters for tags, required that tags be whitespace-separated,
 103        allowed packages to assume non-conflicting tags, and required
 104        unknown flags be ignored.                                 [4.9.1, 10.1]
 105      * Added parallel=n to the standardized DEB_BUILD_OPTIONS tags,
 106        indicating that a package should be built using up to n parallel
 107        processes if the package supports it                      [4.9.1]
 108      * Debian packages should not use convenience copies of code from other
 109        packages unless the included package is explicitly intended to be
 110        used that way.                                            [4.13]
 111      * If dpkg-source -x doesn't produce source ready for editing and
 112        building with dpkg-buildpackage, packages should include a
 113        debian/README.source file explaining how to generate the patched
 114        source, add a new modification, and remove an existing
 115        modification.  This file may also be used to document packaging a
 116        new upstream release and any other complexity of the Debian build
 117        process.                                                  [4.14]
 118      * The Uploaders field in debian/control may be wrapped.     [5.6.3]
 119      * An empty Debian revision is equivalent to a Debian revision of 0 in
 120        a version number.                                         [5.6.12]
 121      * New Homepage field for upstream web sites.                [5.6.23]
 122      * The Breaks field declares that this package breaks another and
 123        prevents installation of the breaking package unless the package
 124        named in Breaks is deconfigured first.  This field should not be
 125        used until the dpkg in Debian stable supports it.         [6.5, 6.6, 7]
 126      * Clarify which files should go into a shared library package, into a
 127        separate package, or into the -dev package.  Suggest -tools instead
 128        of -runtime for runtime support programs, since that naming is more
 129        common in Debian.                                         [8.1, 8.2]
 130      * Files in /etc/cron.{hourly,daily,weekly,monthly} must be
 131        configuration files (upgraded from should).  Mention the hourly
 132        directory.                                                [9.5]
 133      * Packages providing /etc/X11/Xresources files need not conflict with
 134        xbase (<< 3.3.2.3a-2), which is long-obsolete.            [11.8.6]
 135      * Manual pages in locale-specific directories should use either the
 136        legacy encoding for that directory or UTF-8.  Country names should
 137        not be included in locale-specific manual page directories unless
 138        indicating a significant difference in the language.  All
 139        characters in the manual page source should be representable in the
 140        legacy encoding for a locale even if the man page is encoded in
 141        UTF-8.                                                    [12.1]
 142      * The Apache 2.0 license is now in common-licenses and should be
 143        referenced rather than quoted in debian/copyright.        [12.5]
 144      * Packages in contrib and non-free should state in the copyright file
 145        that the package is not part of Debian GNU/Linux and briefly
 146        explain why.                                              [12.5]
 147      * Underscore (_) is allowed in debconf template names.      [debconf]
 148
 149 3.7.3.0                        Dec 2007
 150
 151      * Package version numbers may contain tildes, which sort before
 152        anything, even the end of a part.                         [5.6.12]
 153      * Scripts may assume that /bin/sh supports local (at a basic level)
 154        and that its test builtin (if any) supports -a and -o binary
 155        logical operators.                                        [10.4]
 156      * The substitution variable ${binary:Version} should be used in place
 157        of ${Source-Version} for dependencies between packages of the same
 158        library.                                                  [8.5]
 159      * Substantial reorganization and renaming of sections in the Debian
 160        menu structure.  Packages with menu entries should be reviewed to
 161        see if the menu section has been renamed or if one of the new
 162        sections would be more appropriate.                       [menu policy]
 163      * The Source field in a .changes file may contain a version number
 164        in parentheses.                                           [5.6.1]
 165      * The acceptable values for the Urgency field are low, medium, high,
 166        critical, or emergency.                                   [5.6.17]
 167      * The shlibs file now allows an optional type field, indicating the
 168        type of package for which the line is valid.  The only currently
 169        supported type is udeb, used with packages for the Debian
 170        Installer.                                                [8.6]
 171      * Packages following the Debian Configuration management
 172        specification must allow for translation of their messages by using
 173        a gettext-based system such as po-debconf.                [3.9.1]
 174      * GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
 175        be referenced rather than quoted in debian/copyright.     [12.5]
 176
 177 3.7.2.2                        Oct 2006
 178
 179      * Maintainer scripts must not be world writeable (up from a
 180        should to a must)                                         [6.1]
 181
 182 3.7.2.0                        Apr 2006
 183
 184      * Revert the cgi-lib change.                                [11.5]
 185
 186 3.7.1.0                        Apr 2006
 187
 188      * It is now possible to create shared libraries without
 189        relocatable code (using -fPIC) in certain exceptional cases,
 190        provided some procedures are followed, and for creating static
 191        libraries with relocatable code (again, using -fPIC).
 192        Discussion on debian-devel@lists.debian.org, getting a rough
 193        consensus, and documenting it in README.Debian constitute most
 194        of the process.                                           [10.2]
 195      * Packages should install any relevant files into the directories
 196        /usr/include/X11/and /usr/lib/X11/, but if they do so, they
 197        must  pre-depend on x11-common (>= 1:7.0.0)              [11.8.7]
 198
 199 3.7.0.0                        Apr 2006
 200
 201      * Packages shipping web server CGI files are expected to install
 202        them in /usr/lib/cgi-lib/ directories.  This location change
 203        perhaps should be documented in NEWS                      [11.5]
 204      * Web server packages should include a standard scriptAlias of
 205        cgi-lib to /usr/lib/cgi-lib.                              [11.5]
 206      * The version of FHS mandated by policy has been upped to
 207        2.3. There should be no changes required for most packages,
 208        though new top level directories /media, /srv, etc may be of
 209        interest.                                                 [9.1.1]
 210      * All fields, apart from the Uploaders field, in the control file
 211        are supposed to be a single logical line, which may be spread
 212        over multiple physical  lines (newline followed by space is
 213        elided).  However, any parser for the control file must allow
 214        the Uploaders field to be spread over multiple physical lines
 215        as well, to prepare for future changes.                 [ 5.1, 5.6.3 ]
 216      * When scripts are installed into a directory in the system
 217        PATH, the script name should not include an extension that
 218        denotes the scripting language currently used to implement it.
 219                                                               [ 10.4 ]
 220      * packages that invoke initscripts now must use invoke-rc.d to do
 221        so since it also pays attention to run levels and other local
 222        constraints.                                                [ 9.3.3.2 ]
 223      * We no longer use /usr/X11R6, since we have migrated away to
 224        using Xorg paths. This means, for one thing, fonts live in
 225        /usr/share/fonts/X11/ now, and /usr/X11R6 is gone.
 226                                                       [ 11.8.5.2, 11.8.7, etc]
 227
 228 3.6.2.0                        2005
 229
 230      * Recommend doc-base, and not menu, for registering package documentation.
 231      * Run time support programs should live in subdirectories of
 232        /usr/lib/ or /usr/share, and preferably the shared lib is named
 233        the same as the package name (to avoid name collisions). [8.1]
 234      * It is recommended that HTTP servers provide an alias /images to
 235        allow packages to share image files with the web server [11.5]
 236
 237 3.6.1.0                    Aug 2003
 238
 239      + Prompting the user should be done using debconf. Non debconf
 240        user prompts are now deprecated. [3.10.1]
 241
 242 3.6.0                      Jul 2003
 243
 244      - Restructuring causing shifts in section numbers and bumping of
 245        the minor version number:
 246      + Many packaging manual appendices that were integrated into policy
 247        sections are now empty, and replaced with links to the Policy.
 248        In particular, the appendices that included the list of control
 249        fields were updated (new fields like Closes, Changed-By were added)
 250        and the list of fields for each of control, .changes and .dsc files
 251        is now in Policy, and they're marked mandatory, recommended or
 252        optional based on the current practice and the behavior of the
 253        deb-building tool-chain.
 254      + Elimination of needlessly deep section levels, primarily in the
 255        chapter Debian Archive, from which two new chapters were split out,
 256        Binary packages and Source packages. What remained was reordered
 257        properly, that is, some sect1s became sects etc.
 258      + Several sections that were redundant, crufty or simply not designed
 259        with any sort of vision, were rearranged according to the formula that
 260        everything should be either in the same place or properly interlinked.
 261        Some things remained split up between different chapters when they
 262        talked about different aspects of files: their content, their syntax,
 263        and their placement in the file system. In particular, see the new
 264        sections about changelog files.
 265      - Added Games/Simulation and Apps/Education to menu sub-policy
 266        [menu policy]
 267      - Debian changelogs should be UTF-8 encoded. [C.2.2]
 268      - shared libraries must be linked against all libraries that they
 269        use symbols from in the same way that binaries are. [10.2]
 270      - build-depends-indep need not be satisfied during clean
 271        target. [7.6]
 272
 273 3.5.10                     May 2003
 274
 275      - packages providing the x-terminal-emulator virtual package
 276        ought to ensure that they interpret the command line exactly
 277        like xterm does. [11.8.3]
 278      - Window managers compliant with the Window Manager Specification
 279        Project may add 40 points for ranking in the alternatives [11.8.4]
 280
 281 3.5.9.0                    Mar 2003
 282
 283      - The section describing the Description: package field once again has
 284        full details of the long description format. [3.4.2]
 285      - Clarified that if a package has non-build-essential
 286        build-dependencies, it should have them listed in the Build-Depends
 287        and related fields (i.e. it's not merely optional). [4.2]
 288      - When asked to restart a service that isn't already running,
 289        the init script should start the service. [9.3.2]
 290      - If the purpose of a package is to provide examples, then the
 291        example files can be installed into <tt>/usr/share/doc/package</tt>
 292        (rather than <tt>/usr/share/doc/package/examples</tt>). [12.6]
 293
 294 3.5.8.0                    Nov 2002
 295
 296      - It is no longer necessary to keep a log of changes to the upstream
 297        sources in the copyright file. Instead, all such changes should be
 298        documented in the changelog file. [12.7]
 299      - <tt>Build-Depends</tt>,  <tt>Build-Conflicts</tt>,
 300        <tt>Build-Depends-Indep</tt>, and
 301        <tt>Build-Conflicts-Indep</tt> must also be satisfied when the
 302        clean target is called. [7.6]
 303      - A new Apps/Science menu section is available [menu policy]
 304      - debconf specification cleared up, various changes. [debconf
 305        policy]
 306      - It is no longer recommended to create symlinks from nonexistent
 307        manual pages to undocumented(7). Missing manual pages for programs
 308        are still a bug. [12.1]
 309
 310 3.5.7.0                    Aug 2002
 311
 312      - Packages no longer have to ask permission to call MAKEDEV in
 313        postinst, merely notifying the user ought to be enough. [10.6]
 314      - cryptographic software may now be included in the main
 315        archive. [2.2.4]
 316      - task packages are no longer permitted; tasks are now created by a
 317        special Tasks: field in the control file. [3.9]
 318      - window managers that support netwm can now add 20 points when
 319        they add themselves as an alternative for
 320        /usr/bin/x-window-manager [11.8.4]
 321      - The default compilation options have now changed, one should
 322        provide debugging symbols in all cases, and optionally step
 323        back optimization to -O0, depending on the DEB_BUILD_OPTIONS
 324        environment variable. [10.1]
 325      - Added mention of build-arch, build-indep, etc, in describing
 326        the relationships with `Build-Depends', `Build-Conflicts',
 327        `Build-Depends-Indep', and `Build-Conflicts-Indep'. May need to
 328        review the new rules.  [7.6, 4.8]
 329      - Changed rules on how, and when, to invoke ldconfig in maintainer
 330        scripts. Long rationale. [8]
 331      - [Added the last note in 3.5.6 upgrading checklist item regarding
 332        build rules, please see below]
 333
 334 3.5.6.0                    Jul 2001
 335
 336      - Emacs and TeX are no longer mandated by policy to be priority
 337        standard packages [2.5]
 338      - Programs that access docs need to do so via /usr/share/doc, and
 339        not via /usr/doc/ as was the policy previously [11.5]
 340      - Putting documentation in /usr/doc versus /usr/share/doc is now
 341        a ``serious'' policy violation. [12.3]
 342      - For web servers, one should not provide non-local access to the
 343        /usr/share/doc hierarchy. If one can't provide access controls for
 344        the http://localhost/doc/ directory, then it is preferred that one
 345        ask permission to expose that information during the install. [11.5]
 346      - There are new rules for build-indep/build-arch targets and
 347        there is a new Build-Depend-Indep semantic. [7]
 348
 349 3.5.5.0                    May 2001
 350
 351      - Manpages should not rely on header information to have
 352        alternative manpage names available; it should only use
 353        symlinks or .so pages to do this [12.1]
 354      - [Clarified note in 3.5.3.0 upgrading checklist regarding
 355         examples and templates: this refers only to those examples used
 356         by scripts; see section 10.7.3 for the whole story]
 357      - Included a new section 10.9.1 describing the use of
 358        dpkg-statoverride; this does not have the weight of policy
 359      - Clarify Standards-Version: you don't need to rebuild your
 360        packages just to change the Standards-Version!
 361      - Plugins are no longer bound by all the rules of shared
 362        libraries [10.2]
 363      - X Windows related things:
 364        * Clarification of priority levels of X Window System related
 365          packages [11.8.1]
 366        * Rules for defining x-terminal-emulator improved [11.8.3]
 367        * X Font policy rewritten: you must read this if you provide
 368          fonts for the X Window System [11.8.5]
 369        * Packages must not ship /usr/X11R6/lib/X11/app-defaults/ [11.8.6]
 370        * X-related packages should usually use the regular FHS
 371          locations; imake-using packages are exempted from this [11.8.7]
 372        * OpenMotif linked binaries have the same rules as
 373          OSF/Motif-linked ones [11.8.8]
 374
 375 3.5.4.0                    Apr 2001
 376
 377      - The system-wide mail directory is now /var/mail, no longer
 378        /var/spool/mail.  Any packages accessing the mail spool should
 379        access it via /var/mail and include a suitable Depends field;
 380        details in [11.6]
 381      - The perl policy is now part of Debian policy proper. Perl
 382        programs and modules should follow the current Perl policy
 383        [11.9; perl-policy]
 384
 385 3.5.3.0                    Apr 2001
 386
 387      - Build-Depends arch syntax has been changed to be less
 388        ambiguous. This should not affect any current packages [7.1]
 389      - Examples and templates files for use by scripts should now live
 390        in /usr/share/&lt;package&gt; or /usr/lib/&lt;package&gt;, with
 391        symbolic links from /usr/share/doc/&lt;package&gt;/examples as
 392        needed [10.7.3]
 393
 394 3.5.2.0                    Feb 2001
 395
 396      - X app-defaults directory has moved from
 397        /usr/X11R6/lib/X11/app-defaults to /etc/X11/app-defaults [11.8.6]
 398
 399 3.5.1.0                    Feb 2001
 400
 401      - dpkg-shlibdeps now uses objdump, so shared libraries have to be
 402        run through dpkg-shlibdeps as well as executables [8.1]
 403
 404 3.5.0.0                    Jan 2001
 405
 406      - Font packages for the X Window System must now declare a
 407        dependency on xutils (>= 4.0.2) [11.8.5]
 408
 409 3.2.1.1                    Jan 2001
 410
 411      - Daemon startup scripts in /etc/init.d/ should not contain
 412        modifiable parameters; these should be moved to a file in
 413        /etc/default/; see [9.3.2] for details
 414      - Files in /usr/share/doc must not be referenced by any
 415        program.  If such files are needed, they must be placed in
 416        /usr/share/&lt;package&gt;/, and symbolic links created as required
 417        in /usr/share/doc/&lt;package&gt;/ [12.3]
 418      - Much of the packaging manual has now been imported into the
 419        policy document
 420
 421 3.2.1.0                    Aug 00
 422
 423      - A package of priority standard or higher may provide two
 424        binaries, one compiled with support for the X Window System,
 425        and the other without [11.8.1]
 426
 427 3.2.0.0                    Aug 00
 428
 429      - By default executables should not be built with the debugging
 430        option -g. Instead, it is recommended to support building the
 431        package with debugging information optionally.  Details in [10.1]
 432      - Policy for packages where the upstream uses HTML changelog
 433        files has been expanded.  In short, a plain text changelog file
 434        should always be generated for the upstream changes [12.8]
 435      - Please note that the new release of the X window system (3.2)
 436        shall probably need sweeping changes in policy
 437      - Policy for packages providing the following X-based features
 438        has been codified:
 439        - X server (virtual package xserver) [11.8.2]
 440        - X terminal emulator (virtual package x-terminal-emulator) [11.8.3]
 441        - X window manager (virtual package x-window-manager, and
 442          /usr/bin/x-window-manager alternative, with priority
 443          calculation guidelines) [11.8.4]
 444        - X fonts (this section has been written from scratch) [12.8.5]
 445        - X application defaults [11.8.6]
 446      - Policy for packages using the X Window System and FHS issues
 447        has been clarified; see [11.8.7]
 448      - No package may contain or make hard links to conffiles [11.7.3]
 449      - Noted that newer dpkg versions do not require extreme care in
 450        always creating the shared lib before the symlink, so the unpack
 451        order be correct [8]
 452
 453 3.1.1.0                    Nov 1999
 454
 455      - Correction to semantics of architecture lists in Build-Depends
 456        etc.  Should not affect many packages [7.1]
 457
 458 3.1.0.0                    Oct 1999
 459
 460      - /usr/doc/&lt;package&gt; has to be a symlink pointing to
 461        /usr/share/doc/&lt;package&gt;, to be maintained by postinst
 462        and prerm scripts.  Details are in [defunct]
 463      - Introduced source dependencies (Build-Depends, etc.) [7.1, 7.6]
 464      - /etc/rc.boot has been deprecated in favour of /etc/rcS.d.
 465        (Packages should not be touching this directory, but should use
 466        update-rc.d instead) [9.3.4]
 467      - update-rc.d is now the *only* allowable way of accessing the
 468        /etc/rc?.d/[SK]??* links.  Any scripts which manipulate them
 469        directly must be changed to use update-rc.d instead.  (This is
 470        because the file-rc package handles this information in an
 471        incompatible way.) [9.3.3]
 472      - Architecture-specific examples go in /usr/lib/&lt;package&gt;/examples
 473        with symlinks from /usr/share/doc/&lt;package&gt;/examples/* or from
 474        /usr/share/doc/&lt;package&gt;/examples itself [12.7]
 475      - Updated FHS to a 2.1 draft; this reverts /var/state to
 476        /var/lib [9.1.1]
 477      - Added MIME sub-policy document [9.7; mime-policy]
 478      - VISUAL is allowed as a (higher priority) alternative to EDITOR [12.4]
 479      - Modified liblockfile description, which affects
 480        mailbox-accessing programs.  Please see the policy document for
 481        details [11.6]
 482      - If a package provides a changelog in HTML format, a text-only
 483        version should also be included.  (Such a version may be prepared
 484        using lynx -dump -nolist.) [12.7]
 485      - Description of how to handle version numbers based on dates
 486        added [3.2.1]
 487
 488 3.0.1.0                    Jul 1999
 489
 490     -  Added the clarification that the .la files are essential for the
 491        packages using libtool's libltdl library, in which case the
 492        .la files must go in the run-time library package [10.2]
 493
 494 3.0.0.0                    Jun 1999
 495
 496     - Debian formally moves from the FSSTND to the FHS. This is a
 497       major change, and the implications of this move are probably
 498       not all known. [9.1]
 499     - Only 3 digits of the Standards version need be included in
 500       control files, though all four digits are still permitted. [4.1]
 501     - The location of the GPL has changed to
 502       /usr/share/common-licenses. This may require changing the
 503       copyright files to point to the correct location of the GPL and
 504       other major licenses [12.6]
 505     - Packages that use libtool to create shared libraries must
 506       include the .la files in the -dev packages [10.2]
 507     - Use logrotate to rotate log files [10.8]
 508     - section 5.8 has been rewritten (Programs for the X Window
 509       System) [now 11.8]
 510     - There is now an associated menu policy, in a separate document,
 511       that carries the full weight of Debian policy [9.6; menu-policy]
 512     - Programs which need to modify the files /var/run/utmp,
 513       /var/log/wtmp and /var/log/lastlog must be installed setgid utmp [11.3]
 514
 515
 516 ** Please note that section numbers below this point may not be up to date **
 517
 518
 519 2.5.0.0                         Oct 1998
 520
 521   Policy Manual:
 522     - Rearranged the manual to create a new Section 4, Files
 523       + Section 3.3 ("Files") was moved to Section 4. The Sections
 524         that  were Section 4 and Section 5 were  moved down to become
 525         Section 5 and Section 6.
 526       + What was Section 5.5 ("Log files") is now a subsection of the
 527         new Section 4 ("Files"), becoming section 4.8, placed after
 528         "Configuration files", moving the Section 4.8 ("Permissions
 529         and owners") to Section 4.9.  All subsections of the old
 530         Section 5 after 5.5  were moved down to fill in the number
 531         gap.
 532     - Modified the section about changelog files to accommodate
 533       upstream changelogs which were formatted as HTML/ These
 534       upstream changelog files should now be accessible as
 535       /usr/doc/package/changelog.html.gz
 536       + Symlinks are permissible to link the real, or upstream,
 537         changelog name to the Debian mandated name.
 538     - Clarified that HTML documentation should be present in some
 539       package, though not necessarily the main binary package.
 540     - Corrected all references to the location of the copyright
 541       files. The correct location is /usr/doc/package/copyright
 542     - Ratified the architecture specification strings to cater to the
 543       HURD.
 544
 545 2.4.1.0                         Apr 1998
 546
 547   Policy Manual:
 548     - Updated section 3.3.5 Symbolic links:
 549       + symbolic links within a toplevel directory should be relative,
 550         symbolic links between toplevel directories should be absolute
 551         (cf., Policy Weekly Issue#6, topic 2)
 552
 553     - Updated section 4.9 Games:
 554       + manpages for games should be installed in /usr/man/man6
 555         (cf., Policy Weekly Issue#6, topic 3)
 556
 557   Packaging Manual:
 558     - Updated prefix of chapter 12, Shared Libraries:
 559       ldconfig must be called in the postinst script if the package
 560       installs shared libraries
 561       (cf., Policy Weekly Issue #6, fixes:bug#20515)
 562
 563 2.4.0.0                         Jan 1998
 564
 565     - Updated section 3.3.4 Scripts:
 566       + /bin/sh may be any POSIX compatible shell
 567       + scripts including bashisms have to specify /bin/bash as
 568         interpreter
 569       + scripts which create files in world-writable directories
 570         (e.g., in /tmp) should use tempfile or mktemp for creating
 571         the directory
 572
 573     - Updated section 3.3.5 Symbolic Links:
 574       + symbolic links referencing compressed files must have the same
 575         file extension as the referenced file
 576
 577     - Updated section 3.3.6 Device files:
 578       + /dev/tty* serial devices should be used instead of /dev/cu*
 579
 580     - Updated section 3.4.2 Writing the scripts [in /etc/init.d]:
 581       + all /etc/init.d scripts have to provide the following options:
 582         start, stop, restart, force-reload
 583       + the reload option is optional and must never stop and restart
 584         the service
 585
 586     - Updated section 3.5 Cron jobs:
 587       + cron jobs that need to be executed more often than daily should
 588         be installed into /etc/cron.d
 589
 590     - Updated section 3.7 Menus:
 591       + removed section about how to register HTML docs to `menu'
 592         (the corresponding section in 4.4, Web servers and applications,
 593         has been removed in policy 2.2.0.0 already, so this one was
 594         obsolete)
 595
 596     - New section 3.8 Keyboard configuration:
 597       + details about how the backspace and delete keys should be
 598         handled
 599
 600     - New section 3.9 Environment variables:
 601       + no program must depend on environment variables to get a
 602         reasonable default configuration
 603
 604     - New section 4.6 News system configuration:
 605       + /etc/news/organization and /etc/news/server should be supported
 606         by all news servers and clients
 607
 608     - Updated section 4.7 Programs for the X Window System:
 609       + programs requiring a non-free Motif library should be provided
 610         as foo-smotif and foo-dmotif package
 611       + if lesstif works reliably for such program, it should be linked
 612         against lesstif and not against a non-free Motif library
 613
 614     - Updated section 4.9 Games:
 615       + games for X Windows have to be installed in /usr/games, just as
 616         non-X games
 617
 618 2.3.0.1, 2.3.0.0                Sep 1997
 619
 620         * new section `4.2 Daemons' including rules for
 621           /etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
 622
 623         * updated section about `Configuration files':
 624           packages may not touch other packages' configuration files
 625
 626         * MUAs and MTAs have to use liblockfile
 627
 628 2.2.0.0                         Jul 1997
 629
 630         * added section 4.1 `Architecture specification strings':
 631           use
 632                &lt;arch&gt;-linux
 633           where &lt;arch&gt; is one of the following:
 634                i386, alpha, arm, m68k, powerpc, sparc.
 635
 636         * detailed rules for /usr/local
 637
 638         * user ID's
 639
 640         * editor/pager policy
 641
 642         * cron jobs
 643
 644         * device files
 645
 646         * don't install shared libraries as executable
 647
 648         * app-defaults files may not be conffiles
 649
 650 2.1.3.2, 2.1.3.1, 2.1.3.0       Mar 1997
 651
 652         * two programs with different functionality must not have the
 653           same name
 654
 655         * "Webstandard 3.0"
 656
 657         * "Standard for Console Messages"
 658
 659         * Libraries should be compiled with `-D_REENTRANT'
 660
 661         * Libraries should be stripped with "strip --strip-unneeded"
 662
 663 2.1.2.2, 2.1.2.1, 2.1.2.0       Nov 1996
 664
 665         * Some changes WRT shared libraries
 666
 667 2.1.1.0                         Sep 1996
 668
 669         * No hard links in source packages
 670
 671         * Do not use dpkg-divert or update-alternatives without consultation
 672
 673         * Shared libraries must be installed stripped
 674
 675 2.1.0.0                         Aug 1996
 676
 677         * Upstream changelog must be installed too
 678 </pre>
 679
 680     <hr>
 681
 682   </body>
 683 </html>
 684
 685 <!-- Keep this comment at the end of the file
 686 Local variables:
 687 mode: sgml
 688 sgml-indent-data: t
 689 sgml-live-element-indicator: t
 690 sgml-set-face: t
 691 End:
 692 -->