upgrading-checklist.sgml

   1 <!doctype debiandoc system>
   2
   3 <debiandoc>
   4   <book>
   5     <title> Policy checklist for upgrading your packages </title>
   6       <author> Bill Allombert <email/ballombe@debian.org/ </author>
   7       <author> Josip Rodin </author>
   8       <author> Julian Gilbey </author>
   9       <author> Russ Allbery </author>
  10       <author> Manoj Srivastava <email/srivasta@debian.org/
  11
  12 <chapt> About the checklist
  13 <p>
  14 The checklist below has been created to simplify the upgrading process
  15 of old packages.  Note that this list is not "official"; it simply
  16 gives an indication of what has changed and whether you are likely to
  17 need to make changes to your package in light of this.  If you have
  18 doubts about a certain topic, if you need more details, or if you
  19 think some other package does not comply with policy, please refer to
  20 the Policy Manual itself.  All of the changes from version 3.0.0
  21 onwards indicate which section of the Policy Manual discusses the
  22 issue: [3.4] means section 3.4.  The section numbering changed when
  23 the packaging manual was incorporated into policy; the section numbers
  24 used below refer to the current version.
  25 <p>
  26 Here is how the check list works: Check which policy version your
  27 package was checked against last (indicated in the "Standards-Version"
  28 field of the source package).  Then move upwards until the top and
  29 check which of the items on the list might concern your package.  Note
  30 which sections of policy discuss this, and then check out the Policy
  31 Manual for details.  If you are upgrading from Policy version &lt; 2.5.0,
  32 it may be easier to check through the whole of policy instead of
  33 picking your way through this list.
  34
  35 <chapt> The checklist
  36
  37 <sect> Version 3.8.5.0
  38 <p>
  39
  40 Release Jun 2010.
  41
  42 </p><p><taglist>
  43 <tag>4.4, 5.6.15</tag>
  44   <item>The required format for the date in a changelog entry and in the
  45   Date control field is now precisely specified.
  46   </item>
  47 <tag>5.4, 5.5, 5.6.24</tag>
  48   <item>Document and recommend the <tt>Checksums-Sha1</tt>
  49   and <tt>Checksums-Sha256</tt> fields in <file>*.dsc</file>
  50   and <file>*.changes</file> files.
  51   </item>
  52 <tag>5.6.8, 7.1, 11.1.1</tag>
  53   <item>Architecture wildcards may be used in addition to specific
  54   architectures in <file>debian/control</file> and <file>*.dsc</file>
  55   Architecture fields, and in architecture restrictions in build
  56   relationships.
  57   </item>
  58 <tag>6.3</tag>
  59   <item>Maintainer scripts are no longer guaranteed to run with a
  60   controlling terminal and must be able to fall back to noninteractive
  61   behavior (debconf handles this).  Maintainer scripts may abort if there
  62   is no controlling terminal and no reasonable default for a high-priority
  63   question, but should avoid this if possible.
  64   </item>
  65 <tag>9.2.2</tag>
  66   <item>The UID range of user accounts is extended to 1000-59999.
  67   </item>
  68 <tag>9.3.2, 10.4</tag>
  69   <item><file>init.d</file> scripts are a possible exception from the
  70   normal requirement to use <tt>set -e</tt> in each shell script.
  71   </item>
  72 <tag>12.5</tag>
  73   <item>The UCB BSD license was removed from the list of licenses that
  74   should be referenced from <file>/usr/share/common-licenses/BSD</file>.
  75   It should instead be included directly
  76   in <file>debian/copyright</file>, although it will still be in
  77   common-licenses for the time being.
  78   </item>
  79 <tag>perl</tag>
  80   <item><package>perl-base</package> now
  81   provides <package>perlapi-<var>abiname</var></package> instead of a
  82   package based solely on the Perl version.  Perl packages must now depend
  83   on <package>perlapi-$Config{debian_abi}</package>, falling back
  84   on <tt>$Config{version}</tt> if <tt>$Config{debian_abi}</tt> is not set.
  85   </item>
  86 <tag>perl</tag>
  87   <item>Packages using <file>Makefile.PL</file> should use
  88   <tt>DESTDIR</tt> rather than <tt>PREFIX</tt> to install into the package
  89   staging area.  <tt>PREFIX</tt> only worked due to a Debian-local patch.
  90   </item>
  91 </taglist></p>
  92
  93 <sect> Version 3.8.4.0
  94 <p>
  95
  96 Release Jan 2010.
  97
  98 </p><p><taglist>
  99 <tag>9.1.1</tag>
 100   <item> An FHS exception has been granted for multiarch libraries.
 101   Permitting files to instead be installed to <file>/lib/triplet</file> and
 102   <file>/usr/lib/triplet</file> directories.
 103   </item>
 104 <tag>10.6</tag>
 105   <item>Explicitly state that packages may not contain named pipes and
 106   should instead create them in postinst and remove them in prerm or postrm.
 107   </item>
 108 <tag>9.1.1</tag>
 109   <item><file>/sys</file> and <file>/selinux</file> directories are explicitly
 110   allowed as an exception to the FHS.
 111   </item>
 112 </taglist></p>
 113
 114 <sect> Version 3.8.3.0
 115 <p>
 116 Released Aug 2009.
 117
 118 </p><p><taglist>
 119 <tag>4.9</tag>
 120   <item>Add DEB_*_ARCH_CPU and DEB_*_ARCH_OS variables and
 121   recommend them over GNU-style variables for that information.
 122   </item>
 123 <tag>5.6.8</tag>
 124   <item>Source package Architecture fields may contain <em/all/ in
 125   combination with other architectures.  Clarify when <em/all/ and <em/any/
 126   may be used in different versions of the field.
 127   </item>
 128 <tag>5.6.14</tag>
 129   <item>The Debian archive software does not support uploading
 130   to multiple distributions with one <file>*.changes</file> file.
 131   </item>
 132 <tag>5.6.19</tag>
 133   <item>The Binary field may span multiple lines.
 134   </item>
 135 <tag>10.2</tag>
 136   <item>Remove the permission for shared library packages to
 137   install libraries in a non-standard location and modify <file/ld.so.conf/.
 138   Packages should either be installed in a standard library directory
 139   or packages using them should be built with RPATH.
 140   </item>
 141 <tag>11.8.7</tag>
 142   <item>Clarify installation directories for X programs and
 143   remove the requirement to pre-depend on x11-common before installing
 144   into <file>/usr/include/X11</file> and <file>/usr/lib/X11</file>.
 145   </item>
 146 <tag>12.1</tag>
 147   <item>Remove the requirement that all characters in a manual
 148   page be representable in the legacy encoding for that language.
 149   </item>
 150 <tag>12.1</tag>
 151   <item>Localized man pages should either be kept up-to-date with
 152   the original version or warn that they're not up-to-date, either
 153   with warning text or by showing missing or changed portions in the
 154   original language.
 155   </item>
 156 <tag>12.2</tag>
 157   <item>install-info is now handled via triggers so packages no
 158   longer need to invoke it in maintainer scripts.  Info documents
 159   should now have directory sections and entries in the document.
 160   Packages containing info documents should add a dependency to
 161   support partial upgrades.
 162   </item>
 163 <tag>perl</tag>
 164   <item>The requirement for Perl modules to have a versioned
 165   Depend and Build-Depend on <tt>perl &gt;= 5.6.0-16</tt> has been removed.
 166   </item>
 167 </taglist></p>
 168
 169 <sect> Version 3.8.2.0
 170 <p>
 171
 172 Released Jun 2009.
 173
 174 </p><p><taglist>
 175 <tag>2.4</tag>
 176   <item>The list of archive sections has been significantly expanded.  See
 177   <url id="http://lists.debian.org/debian-devel-announce/2009/03/msg00010.html"
 178   name="this debian-devel-announce message">
 179   for the list of new sections and rules for how to categorize
 180   packages.
 181   </item>
 182 <tag>3.9.1</tag>
 183   <item>All packages must use debconf or equivalent for user prompting,
 184   though essential packages or their dependencies may also fall
 185   back on other methods.
 186   </item>
 187 <tag>5.6.1</tag>
 188   <item>The requirements for source package names are now explicitly
 189   spelled out.
 190   </item>
 191 <tag>9.1</tag>
 192   <item>Legacy XFree86 servers no longer get a special exception from the
 193   FHS permitting <file>/etc/X11/XF86Config-4</file>.
 194   </item>
 195 <tag>9.1.3</tag>
 196   <item>Removed obsolete dependency requirements for packages that use
 197   <file>/var/mail</file>.
 198   </item>
 199 <tag>11.8.5</tag>
 200   <item>Speedo fonts are now deprecated.  The X backend was disabled
 201   starting in lenny.
 202   </item>
 203 <tag>12.5</tag>
 204   <item>The GNU Free Documentation License version 1.3 is included in
 205   common-licenses and should be referenced from there.
 206   </item>
 207 </taglist></p>
 208
 209 <sect> Version 3.8.1.0
 210 <p>
 211
 212 Released  Mar 2009.
 213
 214 </p><p><taglist>
 215 <tag>3.8</tag>
 216   <item>Care should be taken when adding functionality to essential and
 217   such additions create an obligation to support that functionality
 218   in essential forever unless significant work is done.
 219   </item>
 220 <tag>4.4</tag>
 221   <item>Changelog files must be encoded in UTF-8.
 222   </item>
 223 <tag>4.4</tag>
 224   <item>Tighten some format requirements for changelog files from a should
 225   to a must.
 226   </item>
 227 <tag>4.4.1</tag>
 228   <item>Remove alternative changelog formats.  Debian only supports one
 229   changelog format for the Debian Archive.
 230   </item>
 231 <tag>4.9.1</tag>
 232   <item>New nocheck option for DEB_BUILD_OPTIONS indicating any build-time
 233   test suite provided by the package should not be run.
 234   </item>
 235 <tag>5.1</tag>
 236   <item>All control files must be encoded in UTF-8.
 237   </item>
 238 <tag>5.2</tag>
 239   <item>debian/control allows comment lines starting with # with no
 240   preceding whitespace.
 241   </item>
 242 <tag>9.3</tag>
 243   <item>Init scripts ending in .sh are not handled specially.  They are not
 244   sourced and are not guaranteed to be run by <prgn>/bin/sh</prgn> regardless
 245   of the #! line.  This brings Policy in line with the long-standing
 246   behavior of the init system in Debian.
 247   </item>
 248 <tag>9.3.2</tag>
 249   <item>The start action of an init script must exit successfully and not
 250   start the daemon again if it's already running.
 251   </item>
 252 <tag>9.3.2</tag>
 253   <item><file>/var/run</file> and <file>/var/lock</file> may be mounted as
 254   temporary filesystems, and init scripts must therefore create any necessary
 255   subdirectories dynamically.
 256   </item>
 257 <tag>10.4</tag>
 258   <item> <file>/bin/sh</file> scripts may assume that local can take multiple
 259    variable arguments and supports assignment.
 260   </item>
 261 <tag>11.6</tag>
 262   <item>User mailboxes may be mode 600 and owned by the user rather than
 263   mode 660, owned by user, and group mail.
 264   </item>
 265 </taglist></p>
 266
 267 <sect> Version 3.8.0.0
 268 <p>
 269
 270 Released  Jun 2008.
 271
 272 </p><p><taglist>
 273 <tag>2.4, 3.7</tag>
 274 <item>The base section has been removed.  contrib and non-free have been
 275   removed from the section list; they are only categories.  The base
 276   system is now defined by priority.
 277 <tag>4.9</tag>
 278 <item>If <prgn>dpkg-source -x</prgn> doesn't provide the source that will be
 279   compiled, a debian/rules patch target is recommended and should do whatever
 280   else is necessary.
 281 <tag>4.9.1, 10.1</tag>
 282 <item>Standardized the format of DEB_BUILD_OPTIONS.  Specified permitted
 283   characters for tags, required that tags be whitespace-separated,
 284   allowed packages to assume non-conflicting tags, and required
 285   unknown flags be ignored.
 286 <tag>4.9.1</tag>
 287 <item>Added parallel=n to the standardized DEB_BUILD_OPTIONS tags,
 288   indicating that a package should be built using up to n parallel
 289   processes if the package supports it
 290 <tag>4.13</tag>
 291 <item>Debian packages should not use convenience copies of code from other
 292   packages unless the included package is explicitly intended to be
 293   used that way.
 294 <tag>4.14</tag>
 295 <item>If dpkg-source -x doesn't produce source ready for editing and
 296   building with dpkg-buildpackage, packages should include a
 297   <file>debian/README.source</file> file explaining how to generate
 298   the patched source, add a new modification, and remove an existing
 299   modification.  This file may also be used to document packaging a
 300   new upstream release and any other complexity of the Debian build
 301   process.
 302 <tag>5.6.3</tag>
 303 <item>The Uploaders field in debian/control may be wrapped.
 304 <tag>5.6.12</tag>
 305 <item>An empty Debian revision is equivalent to a Debian revision of 0 in
 306   a version number.
 307 <tag>5.6.23</tag>
 308 <item>New Homepage field for upstream web sites.
 309 <tag>6.5, 6.6, 7</tag>
 310 <item>The Breaks field declares that this package breaks another and
 311   prevents installation of the breaking package unless the package
 312   named in Breaks is deconfigured first.  This field should not be
 313   used until the dpkg in Debian stable supports it.
 314 <tag>8.1, 8.2</tag>
 315 <item>Clarify which files should go into a shared library package, into a
 316   separate package, or into the -dev package.  Suggest -tools instead
 317   of -runtime for runtime support programs, since that naming is more
 318   common in Debian.
 319 <tag>9.5</tag>
 320 <item>Files in <file>/etc/cron.{hourly,daily,weekly,monthly}</file> must be
 321   configuration files (upgraded from should).  Mention the hourly
 322   directory.
 323 <tag>11.8.6</tag>
 324 <item>Packages providing <file>/etc/X11/Xresources</file> files need not
 325   conflict with  <tt> xbase (&lt;&lt; 3.3.2.3a-2)</tt>, which is
 326   long-obsolete.
 327 <tag>12.1</tag>
 328 <item>Manual pages in locale-specific directories should use either the
 329   legacy encoding for that directory or UTF-8.  Country names should
 330   not be included in locale-specific manual page directories unless
 331   indicating a significant difference in the language.  All
 332   characters in the manual page source should be representable in the
 333   legacy encoding for a locale even if the man page is encoded in
 334   UTF-8.
 335 <tag>12.5</tag>
 336 <item>The Apache 2.0 license is now in common-licenses and should be
 337   referenced rather than quoted in <file>debian/copyright</file>.
 338 <tag>12.5</tag>
 339 <item>Packages in contrib and non-free should state in the copyright file
 340   that the package is not part of Debian GNU/Linux and briefly
 341   explain why.
 342 <tag>debconf</tag>
 343 <item>Underscore (_) is allowed in debconf template names.
 344 </taglist></p>
 345
 346 <sect> Version 3.7.3.0
 347 <p>
 348
 349 Released  Dec 2007.
 350
 351 </p><p><taglist>
 352 <tag>5.6.12</tag>
 353 <item>Package version numbers may contain tildes, which sort before
 354   anything, even the end of a part.
 355 <tag>10.4</tag>
 356 <item>Scripts may assume that <file>/bin/sh</file> supports local (at a basic
 357   level) and that its test builtin (if any) supports -a and -o binary
 358   logical operators.
 359 <tag>8.5</tag>
 360 <item>The substitution variable ${binary:Version} should be used in place
 361   of ${Source-Version} for dependencies between packages of the same
 362   library.
 363 <tag>menu policy</tag>
 364 <item>Substantial reorganization and renaming of sections in the Debian
 365   menu structure.  Packages with menu entries should be reviewed to
 366   see if the menu section has been renamed or if one of the new
 367   sections would be more appropriate.
 368 <tag>5.6.1</tag>
 369 <item>The Source field in a .changes file may contain a version number
 370   in parentheses.
 371 <tag>5.6.17</tag>
 372 <item>The acceptable values for the Urgency field are low, medium, high,
 373   critical, or emergency.
 374 <tag>8.6</tag>
 375 <item>The shlibs file now allows an optional type field, indicating the
 376   type of package for which the line is valid.  The only currently
 377   supported type is udeb, used with packages for the Debian
 378   Installer.
 379 <tag>3.9.1</tag>
 380 <item>Packages following the Debian Configuration management
 381   specification must allow for translation of their messages by using
 382   a gettext-based system such as po-debconf.
 383 <tag>12.5</tag>
 384 <item>GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
 385   be referenced rather than quoted in debian/copyright.
 386 </taglist></p>
 387
 388 <sect> Version 3.7.2.2
 389 <p>
 390
 391 Released  Oct 2006.
 392
 393 </p><p><taglist>
 394 <tag>6.1</tag> <item>Maintainer scripts must not be world writeable (up from a
 395     should to a must)</item>
 396 </taglist></p>
 397
 398 <sect> Version 3.7.2.0
 399 <p>
 400
 401 Released  Apr 2006.
 402
 403 </p><p><taglist>
 404 <tag>11.5</tag> <item>Revert the cgi-lib change. </item>
 405 </taglist></p>
 406
 407 <sect> Version 3.7.1.0
 408 <p>
 409
 410 Released  Apr 2006.
 411
 412 </p><p><taglist>
 413 <tag>10.2</tag>
 414 <item>It is now possible to create shared libraries without
 415   relocatable code (using -fPIC) in certain exceptional cases,
 416   provided some procedures are followed, and for creating static
 417   libraries with relocatable code (again, using -fPIC).
 418   Discussion on debian-devel@lists.debian.org, getting a rough
 419   consensus, and documenting it in README.Debian constitute most
 420   of the process.
 421 <tag>11.8.7</tag>
 422 <item>Packages should install any relevant files into the directories
 423   <file>/usr/include/X11/</file> and <file>/usr/lib/X11/</file>, but if
 424   they do so, they must pre-depend on <tt>x11-common (&gt;= 1:7.0.0)</tt>
 425 </taglist></p>
 426
 427 <sect> Version 3.7.0.0
 428 <p>
 429
 430 Released  Apr 2006.
 431
 432 </p><p><taglist>
 433 <tag>11.5</tag>
 434 <item>Packages shipping web server CGI files are expected to install
 435   them in <file>/usr/lib/cgi-lib/</file> directories.  This location change
 436   perhaps should be documented in NEWS
 437 <tag>11.5</tag>
 438 <item>Web server packages should include a standard scriptAlias of
 439   cgi-lib to <file>/usr/lib/cgi-lib</file>.
 440 <tag>9.1.1</tag>
 441 <item>The version of FHS mandated by policy has been upped to
 442   2.3. There should be no changes required for most packages,
 443   though new top level directories <file>/media</file>, <file>/srv</file>,
 444   etc.  may be of interest.
 445 <tag>5.1, 5.6.3</tag>
 446 <item>All fields, apart from the Uploaders field, in the control file
 447   are supposed to be a single logical line, which may be spread
 448   over multiple physical  lines (newline followed by space is
 449   elided).  However, any parser for the control file must allow
 450   the Uploaders field to be spread over multiple physical lines
 451   as well, to prepare for future changes.
 452 <tag>10.4</tag>
 453 <item>When scripts are installed into a directory in the system
 454   PATH, the script name should not include an extension that
 455   denotes the scripting language currently used to implement it.
 456
 457 <tag>9.3.3.2</tag>
 458 <item>packages that invoke initscripts now must use invoke-rc.d to do
 459   so since it also pays attention to run levels and other local
 460   constraints.
 461 <tag>11.8.5.2, 11.8.7, etc</tag>
 462 <item>We no longer use <file>/usr/X11R6</file>, since we have
 463   migrated away to using Xorg paths. This means, for one thing, fonts
 464   live in <file>/usr/share/fonts/X11/</file> now, and <file>/usr/X11R6</file>
 465   is gone.
 466 </taglist></p>
 467
 468 <sect> Version 3.6.2.0
 469 <p>
 470
 471 Released  2005
 472
 473 </p><p><taglist>
 474 <tag></tag>
 475 <item>Recommend. doc-base, and not menu, for registering package documentation.
 476 </item>
 477 <tag>8.1</tag>
 478 <item>Run time support programs should live in subdirectories of
 479   <file>/usr/lib/</file> or <file>/usr/share</file>, and preferably the shared
 480   lib is named the same as the package name (to avoid name collisions).
 481 </item>
 482 <tag>11.5</tag>
 483 <item>It is recommended that HTTP servers provide an alias /images to
 484   allow packages to share image files with the web server
 485 </item>
 486 </taglist></p>
 487
 488 <sect> Version 3.6.1.0
 489 <p>
 490
 491 Released  Aug 2003.
 492
 493 </p><p><taglist>
 494 <tag>3.10.1</tag>
 495 <item>Prompting the user should be done using debconf. Non debconf
 496   user prompts are now deprecated.
 497 </taglist></p>
 498
 499 <sect> Version 3.6.0
 500 <p>
 501
 502 Released  Jul 2003.
 503
 504 </p><p><taglist>
 505 <tag></tag>
 506 <item>Restructuring causing shifts in section numbers and bumping of
 507   the minor version number:
 508 <tag></tag>
 509 <item>Many packaging manual appendices that were integrated into policy
 510   sections are now empty, and replaced with links to the Policy.
 511   In particular, the appendices that included the list of control
 512   fields were updated (new fields like Closes, Changed-By were added)
 513   and the list of fields for each of control, .changes and .dsc files
 514   is now in Policy, and they're marked mandatory, recommended or
 515   optional based on the current practice and the behavior of the
 516   deb-building tool-chain.
 517 <tag></tag>
 518 <item>Elimination of needlessly deep section levels, primarily in the
 519   chapter Debian Archive, from which two new chapters were split out,
 520   Binary packages and Source packages. What remained was reordered
 521   properly, that is, some sects became sects etc.
 522 <tag></tag>
 523 <item>Several sections that were redundant, crufty or simply not designed
 524   with any sort of vision, were rearranged according to the formula that
 525   everything should be either in the same place or properly interlinked.
 526   Some things remained split up between different chapters when they
 527   talked about different aspects of files: their content, their syntax,
 528   and their placement in the file system. In particular, see the new
 529   sections about changelog files.
 530 <tag>menu policy</tag>
 531 <item>Added Games/Simulation and Apps/Education to menu
 532   sub-policy
 533 <tag>C.2.2</tag>
 534 <item>Debian changelogs should be UTF-8 encoded.
 535 <tag>10.2</tag>
 536 <item>shared libraries must be linked against all libraries that they
 537   use symbols from in the same way that binaries are.
 538 <tag>7.6</tag>
 539 <item>build-depends-indep need not be satisfied during clean
 540   target.
 541 </taglist></p>
 542
 543 <sect> Version 3.5.10
 544 <p>
 545
 546 Released  May 2003.
 547
 548 </p><p><taglist>
 549 <tag>11.8.3</tag>
 550 <item>packages providing the x-terminal-emulator virtual package
 551   ought to ensure that they interpret the command line exactly
 552   like xterm does.
 553 <tag>11.8.4</tag>
 554 <item>Window managers compliant with the Window Manager Specification
 555   Project may add 40 points for ranking in the alternatives
 556 </taglist></p>
 557
 558 <sect> Version 3.5.9.0
 559 <p>
 560
 561 Released  Mar 2003.
 562
 563 </p><p><taglist>
 564 <tag>3.4.2</tag>
 565 <item>The section describing the Description: package field once again has
 566   full details of the long description format.
 567 <tag>4.2</tag>
 568 <item>Clarified that if a package has non-build-essential
 569   build-dependencies, it should have them listed in the Build-Depends
 570   and related fields (i.e. it's not merely optional).
 571 <tag>9.3.2</tag>
 572 <item>When asked to restart a service that isn't already running,
 573   the init script should start the service.
 574 <tag>12.6</tag>
 575 <item>If the purpose of a package is to provide examples, then the
 576   example files can be installed into <file>/usr/share/doc/package</file>
 577   (rather than <file>/usr/share/doc/package/examples</file>).
 578 </taglist></p>
 579
 580 <sect> Version 3.5.8.0
 581 <p>
 582
 583 Released  Nov 2002.
 584
 585 </p><p><taglist>
 586 <tag>12.7</tag>
 587 <item>It is no longer necessary to keep a log of changes to the upstream
 588   sources in the copyright file. Instead, all such changes should be
 589   documented in the changelog file.
 590 <tag>7.6</tag>
 591 <item><var/Build-Depends/, <var/Build-Conflicts/, <var/Build-Depends-Indep/,
 592   and <var/Build-Conflicts-Indep/ must also be satisfied when the clean
 593   target is called.
 594 <tag>menu policy</tag>
 595 <item>A new Apps/Science menu section is available
 596 <tag>debconf policy</tag>
 597 <item>debconf specification cleared up, various changes.
 598 <tag>12.1</tag>
 599 <item>It is no longer recommended to create symlinks from nonexistent
 600   manual pages to undocumented(7). Missing manual pages for programs
 601   are still a bug.
 602 </taglist></p>
 603
 604 <sect> Version 3.5.7.0
 605 <p>
 606
 607 Released  Aug 2002.
 608
 609 </p><p><taglist>
 610 <tag></tag>
 611 <item>Packages no longer have to ask permission to call MAKEDEV in
 612   postinst, merely notifying the user ought to be enough.
 613 <tag>2.2.4</tag>
 614 <item>cryptographic software may now be included in the main
 615   archive.
 616 <tag>3.9</tag>
 617 <item>task packages are no longer permitted; tasks are now created by a
 618   special Tasks: field in the control file.
 619 <tag>11.8.4</tag>
 620 <item>window managers that support netwm can now add 20 points when
 621   they add themselves as an alternative for
 622  <file>/usr/bin/x-window-manager</file>
 623 <tag>10.1</tag>
 624 <item>The default compilation options have now changed, one should
 625   provide debugging symbols in all cases, and optionally step
 626   back optimization to -O0, depending on the DEB_BUILD_OPTIONS
 627   environment variable.
 628 <tag>7.6, 4.8</tag>
 629 <item>Added mention of build-arch, build-indep, etc, in describing
 630   the relationships with `Build-Depends', `Build-Conflicts',
 631   `Build-Depends-Indep', and `Build-Conflicts-Indep'. May need to
 632   review the new rules.
 633 <tag>8</tag>
 634 <item>Changed rules on how, and when, to invoke ldconfig in maintainer
 635   scripts. Long rationale.
 636 </taglist></p>
 637
 638 <p><em>
 639 Added the last note in 3.5.6 upgrading checklist item regarding build
 640 rules, please see below
 641 </em></p>
 642
 643 <sect> Version 3.5.6.0
 644 <p>
 645
 646 Released  Jul 2001.
 647
 648 </p><p><taglist>
 649 <tag>2.5</tag>
 650 <item>Emacs and TeX are no longer mandated by policy to be priority
 651   standard packages
 652 <tag>11.5</tag>
 653 <item>Programs that access docs need to do so via <file>/usr/share/doc</file>,
 654   and not via <file>/usr/doc/</file> as was the policy previously
 655 <tag>12.3</tag>
 656 <item>Putting documentation in <file>/usr/doc</file> versus
 657  <file>/usr/share/doc</file> is now a ``serious'' policy violation.
 658 <tag>11.5</tag>
 659 <item>For web servers, one should not provide non-local access to the
 660   <file>/usr/share/doc</file> hierarchy. If one can't provide access
 661   controls for the http://localhost/doc/ directory, then it is preferred
 662   that one ask permission to expose that information during the install.
 663 <tag>7</tag>
 664 <item>There are new rules for build-indep/build-arch targets and
 665   there is a new Build-Depend-Indep semantic.
 666 </taglist></p>
 667
 668 <sect> Version 3.5.5.0
 669 <p>
 670
 671 Released  May 2001.
 672
 673 </p><p><taglist>
 674 <tag>12.1</tag>
 675 <item>Manpages should not rely on header information to have
 676   alternative manpage names available; it should only use
 677   symlinks or .so pages to do this
 678 </item>
 679 <tag></tag>
 680 <item><em> Clarified note in 3.5.3.0 upgrading checklist regarding
 681    examples and templates: this refers only to those examples used
 682    by scripts; see section 10.7.3 for the whole story</em>
 683 </item>
 684 <tag></tag>
 685 <item>Included a new section 10.9.1 describing the use of
 686   dpkg-statoverride; this does not have the weight of policy
 687 </item>
 688 <tag></tag>
 689 <item>Clarify Standards-Version: you don't need to rebuild your
 690   packages just to change the Standards-Version!
 691 </item>
 692 <tag>10.2</tag>
 693 <item>Plugins are no longer bound by all the rules of shared
 694   libraries
 695 </item>
 696 <tag>X Windows related things:</tag>
 697 <item><taglist>
 698   <tag>11.8.1</tag>
 699   <item>Clarification of priority levels of X Window System related
 700       packages
 701   </item>
 702   <tag>11.8.3</tag>
 703   <item>Rules for defining x-terminal-emulator improved </item>
 704   <tag>11.8.5</tag>
 705   <item>X Font policy rewritten: you must read this if you provide
 706       fonts for the X Window System
 707   </item>
 708   <tag>11.8.6</tag>
 709   <item>Packages must not ship <file>/usr/X11R6/lib/X11/app-defaults/</file>
 710   </item>
 711   <tag>11.8.7</tag>
 712   <item>X-related packages should usually use the regular FHS
 713       locations; imake-using packages are exempted from this
 714   </item>
 715   <tag>11.8.8</tag>
 716   <item>OpenMotif linked binaries have the same rules as
 717       OSF/Motif-linked ones
 718   </item>
 719   </taglist></item>
 720 </taglist></p>
 721
 722 <sect> Version 3.5.4.0
 723 <p> Released  Apr 2001.
 724
 725 </p><p><taglist>
 726 <tag>11.6</tag>
 727 <item>The system-wide mail directory is now /var/mail, no longer
 728   /var/spool/mail.  Any packages accessing the mail spool should
 729   access it via /var/mail and include a suitable Depends field;
 730   details in
 731 </item>
 732 <tag>11.9; perl-policy</tag>
 733 <item>The perl policy is now part of Debian policy
 734   proper. Perl programs and modules should follow the current Perl
 735   policy
 736 </item>
 737 </taglist></p>
 738
 739 <sect> Version 3.5.3.0
 740 <p> Released Apr 2001
 741
 742 </p><p><taglist>
 743 <tag>7.1</tag>
 744 <item>Build-Depends arch syntax has been changed to be less
 745   ambiguous. This should not affect any current packages
 746 </item>
 747 <tag>10.7.3</tag>
 748 <item>Examples and templates files for use by scripts should now live
 749   in <file>/usr/share/&lt;package&gt;</file> or
 750   <file>/usr/lib/&lt;package&gt;</file>, with symbolic links from
 751   <file>/usr/share/doc/&lt;package&gt;/examples</file> as needed
 752 </item>
 753 </taglist></p>
 754
 755 <sect> Version 3.5.2.0
 756
 757 <p> Released Feb 2001.
 758
 759 </p><p><taglist>
 760 <tag>11.8.6</tag>
 761 <item>X app-defaults directory has moved from
 762   <file>/usr/X11R6/lib/X11/app-defaults</file> to
 763   <file>/etc/X11/app-defaults</file>
 764 </item>
 765 </taglist></p>
 766
 767 <sect> Version 3.5.1.0
 768
 769 <p> Released Feb 2001.
 770
 771 </p><p><taglist>
 772 <tag>8.1</tag>
 773 <item>dpkg-shlibdeps now uses objdump, so shared libraries have to be
 774   run through dpkg-shlibdeps as well as executables
 775 </item>
 776 </taglist></p>
 777
 778 <sect> Version 3.5.0.0
 779
 780 <p> Released Jan 2001.
 781
 782 </p><p><taglist>
 783 <tag>11.8.5</tag>
 784 <item>Font packages for the X Window System must now declare a
 785   dependency on xutils (>= 4.0.2)
 786 </item>
 787 </taglist></p>
 788
 789 <sect> Version 3.2.1.1
 790
 791 <p> Released Jan 2001.
 792
 793 </p><p><taglist>
 794 <tag>9.3.2</tag>
 795 <item>Daemon startup scripts in <file>/etc/init.d/</file> should not contain
 796   modifiable parameters; these should be moved to a file in
 797   <file>/etc/default/</file>
 798 </item>
 799 <tag>12.3</tag>
 800 <item>Files in <file>/usr/share/doc</file> must not be referenced by any
 801   program.  If such files are needed, they must be placed in
 802   <file>/usr/share/&lt;package&gt;/</file>, and symbolic links
 803   created as required in <file>/usr/share/doc/&lt;package&gt;/</file>
 804 </item>
 805 <tag></tag>
 806 <item>Much of the packaging manual has now been imported into the
 807   policy document
 808 </item>
 809 </taglist></p>
 810
 811 <sect> Version 3.2.1.0
 812
 813 <p> Released Aug 00.
 814
 815 </p><p><taglist>
 816 <tag>11.8.1</tag>
 817 <item>A package of priority standard or higher may provide two
 818   binaries, one compiled with support for the X Window System,
 819   and the other without
 820 </item>
 821 </taglist></p>
 822
 823 <sect> Version 3.2.0.0
 824
 825 <p> Released Aug 00.
 826
 827 </p><p><taglist>
 828 <tag>10.1</tag>
 829 <item>By default executables should not be built with the debugging
 830   option -g. Instead, it is recommended to support building the
 831   package with debugging information optionally.  Details in
 832 </item>
 833 <tag>12.8</tag>
 834 <item>Policy for packages where the upstream uses HTML changelog
 835   files has been expanded.  In short, a plain text changelog file
 836   should always be generated for the upstream changes
 837 </item>
 838 <tag></tag>
 839 <item>Please note that the new release of the X window system (3.2)
 840   shall probably need sweeping changes in policy
 841 </item>
 842 <tag></tag>
 843 <item>Policy for packages providing the following X-based features
 844   has been codified:
 845   <taglist>
 846   <tag>11.8.2</tag>
 847   <item>X server (virtual package xserver) </item>
 848   <tag>11.8.3</tag>
 849   <item>X terminal emulator (virtual package x-terminal-emulator) </item>
 850   <tag>11.8.4</tag>
 851   <item>X window manager (virtual package x-window-manager, and
 852       <file>/usr/bin/x-window-manager</file> alternative, with priority
 853       calculation guidelines)
 854   </item>
 855   <tag>12.8.5</tag>
 856   <item>X fonts (this section has been written from scratch) </item>
 857   <tag>11.8.6</tag>
 858   <item>X application defaults </item>
 859   </taglist>
 860 </item>
 861 <tag>11.8.7</tag>
 862 <item>Policy for packages using the X Window System and FHS issues
 863   has been clarified;
 864 </item>
 865 <tag>11.7.3</tag>
 866 <item>No package may contain or make hard links to conffiles </item>
 867 <tag>8</tag>
 868 <item>Noted that newer dpkg versions do not require extreme care in
 869   always creating the shared lib before the symlink, so the unpack
 870   order be correct
 871 </item>
 872 </taglist></p>
 873
 874 <sect> Version 3.1.1.0
 875
 876 <p> Released Nov 1999.
 877
 878 </p><p><taglist>
 879 <tag>7.1</tag>
 880 <item>Correction to semantics of architecture lists in Build-Depends
 881   etc.  Should not affect many packages
 882 </item>
 883 </taglist></p>
 884
 885 <sect> Version 3.1.0.0
 886
 887 <p> Released Oct 1999.
 888
 889 </p><p><taglist>
 890 <tag>defunct</tag>
 891 <item><file>/usr/doc/&lt;package&gt;</file> has to be a symlink pointing to
 892   <file>/usr/share/doc/&lt;package&gt;</file>, to be maintained by postinst
 893   and prerm scripts.
 894 </item>
 895 <tag>7.1, 7.6</tag>
 896 <item>Introduced source dependencies (Build-Depends, etc.) </item>
 897 <tag>9.3.4</tag>
 898 <item><file>/etc/rc.boot</file> has been deprecated in favour of
 899   <file>/etc/rcS.d</file>.  (Packages should not be touching this directory,
 900   but should use update-rc.d instead)
 901 </item>
 902 <tag>9.3.3</tag>
 903 <item>update-rc.d is now the <em>only</em> allowable way of accessing the
 904   <file>/etc/rc?.d/[SK]??*</file> links.  Any scripts which manipulate them
 905   directly must be changed to use update-rc.d instead.  (This is
 906   because the file-rc package handles this information in an
 907   incompatible way.)
 908 </item>
 909 <tag>12.7</tag>
 910 <item>Architecture-specific examples go in
 911   <file>/usr/lib/&lt;package&gt;/examples</file>
 912   with symlinks from <file>/usr/share/doc/&lt;package&gt;/examples/*</file>
 913   or from <file>/usr/share/doc/&lt;package&gt;/examples</file> itself
 914 </item>
 915 <tag>9.1.1</tag>
 916 <item>Updated FHS to a 2.1 draft; this reverts <file>/var/state</file> to
 917   <file>/var/lib</file>
 918 </item>
 919 <tag>9.7; mime-policy</tag>
 920 <item>Added MIME sub-policy document </item>
 921 <tag>12.4</tag>
 922 <item>VISUAL is allowed as a (higher priority) alternative to EDITOR
 923 </item>
 924 <tag>11.6</tag>
 925 <item>Modified liblockfile description, which affects
 926   mailbox-accessing programs.  Please see the policy document for
 927   details
 928 </item>
 929 <tag>12.7</tag>
 930 <item>If a package provides a changelog in HTML format, a text-only
 931   version should also be included.  (Such a version may be prepared
 932   using <prgn>lynx -dump -nolist</prgn>.)
 933 </item>
 934 <tag>3.2.1</tag>
 935 <item>Description of how to handle version numbers based on dates
 936   added
 937 </item>
 938 </taglist></p>
 939
 940 <sect> Version 3.0.1.0
 941
 942 <p> Released Jul 1999.
 943
 944 </p><p><taglist>
 945 <tag>10.2</tag>
 946 <item>Added the clarification that the .la files are essential for
 947   the packages using libtool's libltdl library, in which case the .la
 948   files must go in the run-time library package
 949 </item>
 950 </taglist></p>
 951
 952 <sect> Version 3.0.0.0
 953
 954 <p> Released Jun 1999.
 955
 956 </p><p><taglist>
 957 <tag>9.1</tag>
 958 <item>Debian formally moves from the FSSTND to the FHS. This is a
 959   major change, and the implications of this move are probably
 960   not all known.
 961 </item>
 962 <tag>4.1</tag>
 963 <item>Only 3 digits of the Standards version need be included in
 964   control files, though all four digits are still permitted.
 965 </item>
 966 <tag>12.6</tag>
 967 <item>The location of the GPL has changed to
 968   <file>/usr/share/common-licenses</file>. This may require changing the
 969   copyright files to point to the correct location of the GPL and
 970   other major licenses
 971 </item>
 972 <tag>10.2</tag>
 973 <item>Packages that use libtool to create shared libraries must
 974   include the .la files in the -dev packages
 975 </item>
 976 <tag>10.8</tag>
 977 <item>Use logrotate to rotate log files
 978 </item>
 979 <tag>now 11.8</tag>
 980 <item>section 5.8 has been rewritten (Programs for the X Window
 981   System)
 982 </item>
 983 <tag>9.6; menu-policy</tag>
 984 <item>There is now an associated menu policy, in a separate document,
 985   that carries the full weight of Debian policy
 986 </item>
 987 <tag>11.3</tag>
 988 <item>Programs which need to modify the files <file>/var/run/utmp</file>,
 989   <file>/var/log/wtmp</file> and <file>/var/log/lastlog</file> must be
 990   installed setgid utmp
 991 </item>
 992 </taglist></p>
 993 <p><em>
 994    Please note that section numbers below this point may not be up to date
 995 </em></p>
 996
 997 <sect> Version 2.5.0.0
 998
 999 <p> Released Oct 1998.
1000
1001 Policy Manual:
1002 </p><p><list>
1003 <item>Rearranged the manual to create a new Section 4, Files
1004   <list>
1005   <item>Section 3.3 ("Files") was moved to Section 4. The Sections
1006     that  were Section 4 and Section 5 were  moved down to become
1007     Section 5 and Section 6.
1008   </item>
1009   <item>What was Section 5.5 ("Log files") is now a subsection of the
1010     new Section 4 ("Files"), becoming section 4.8, placed after
1011     "Configuration files", moving the Section 4.8 ("Permissions
1012     and owners") to Section 4.9.  All subsections of the old
1013     Section 5 after 5.5  were moved down to fill in the number
1014     gap.
1015   </item>
1016   </list></item>
1017 <item>Modified the section about changelog files to accommodate
1018   upstream changelogs which were formatted as HTML. These
1019   upstream changelog files should now be accessible as
1020   <file>/usr/doc/package/changelog.html.gz</file>
1021 </item>
1022 <item>Symlinks are permissible to link the real, or upstream,
1023     changelog name to the Debian mandated name.
1024 </item>
1025 <item>Clarified that HTML documentation should be present in some
1026   package, though not necessarily the main binary package.
1027   </item>
1028 <item>Corrected all references to the location of the copyright
1029   files. The correct location is <file>/usr/doc/package/copyright</file>
1030   </item>
1031 <item>Ratified the architecture specification strings to cater to the
1032   HURD.
1033   </item>
1034 </list></p>
1035
1036 <sect> Version 2.4.1.0
1037
1038 <p> Released Apr 1998.
1039 </p>
1040 <sect1> Policy Manual:
1041 <p><taglist>
1042 <tag>Updated section 3.3.5 Symbolic links:</tag>
1043   <item>symbolic links within a toplevel directory should be relative,
1044     symbolic links between toplevel directories should be absolute
1045     (cf., Policy Weekly Issue#6, topic 2)
1046   </item>
1047
1048 <tag>Updated section 4.9 Games:</tag>
1049   <item>manpages for games should be installed in <file>/usr/man/man6</file>
1050     (cf., Policy Weekly Issue#6, topic 3)
1051   </item>
1052 </taglist></p>
1053
1054 <sect1> Packaging Manual:
1055 <p><list>
1056 <item>Updated prefix of chapter 12, Shared Libraries:
1057   ldconfig must be called in the postinst script if the package
1058   installs shared libraries
1059   (cf., Policy Weekly Issue #6, fixes:bug#20515)
1060 </item>
1061 </list></p>
1062
1063 <sect> Version 2.4.0.0
1064
1065 <p> Released Jan 1998
1066
1067 </p><p><taglist>
1068 <tag>Updated section 3.3.4 Scripts:</tag>
1069   <item><list>
1070   <item>/bin/sh may be any POSIX compatible shell
1071   <item>scripts including bashisms have to specify <file>/bin/bash</file>
1072     as interpreter
1073   <item>scripts which create files in world-writable directories
1074     (e.g., in <file>/tmp</file>) should use tempfile or mktemp for creating
1075     the directory
1076   </list></item>
1077
1078 <tag>Updated section 3.3.5 Symbolic Links:</tag>
1079   <item>symbolic links referencing compressed files must have the same
1080     file extension as the referenced file
1081   </item>
1082
1083 <tag>Updated section 3.3.6 Device files:</tag>
1084   <item><file>/dev/tty*</file> serial devices should be used instead of
1085   <file>/dev/cu*</file>
1086   </item>
1087
1088 <tag>Updated section 3.4.2 Writing the scripts in <file>/etc/init.d</file>:
1089   <item><list>
1090   <item>all <file>/etc/init.d</file> scripts have to provide the following
1091   options: start, stop, restart, force-reload
1092   <item>the reload option is optional and must never stop and restart
1093     the service
1094   </list></item>
1095
1096 <tag>Updated section 3.5 Cron jobs:
1097   <item>cron jobs that need to be executed more often than daily should
1098     be installed into <file>/etc/cron.d</file>
1099   </item>
1100
1101 <tag>Updated section 3.7 Menus:
1102   <item>removed section about how to register HTML docs to `menu'
1103     (the corresponding section in 4.4, Web servers and applications,
1104     has been removed in policy 2.2.0.0 already, so this one was
1105     obsolete)
1106   </item>
1107
1108 <tag>New section 3.8 Keyboard configuration:
1109   <item>details about how the backspace and delete keys should be
1110     handled
1111   </item>
1112
1113 <tag>New section 3.9 Environment variables:
1114   <item>no program must depend on environment variables to get a
1115     reasonable default configuration
1116   </item>
1117
1118 <tag>New section 4.6 News system configuration:
1119   <item><file>/etc/news/organization</file> and <file>/etc/news/server</file>
1120     should be supported by all news servers and clients
1121   </item>
1122
1123 <tag>Updated section 4.7 Programs for the X Window System:
1124   <item><list>
1125   <item>programs requiring a non-free Motif library should be provided
1126     as foo-smotif and foo-dmotif package
1127   </item>
1128   <item>if lesstif works reliably for such program, it should be linked
1129     against lesstif and not against a non-free Motif library
1130   </item>
1131   </list></item>
1132
1133 <tag>Updated section 4.9 Games:
1134   <item>games for X Windows have to be installed in <file>/usr/games</file>,
1135   just as non-X games
1136   </item>
1137 </taglist></p>
1138
1139 <sect> Version 2.3.0.1, 2.3.0.0
1140
1141 <p> Released Sep 1997.
1142
1143 <p><list>
1144 <item>new section `4.2 Daemons' including rules for
1145   <file>/etc/services</file>, <file>/etc/protocols</file>,
1146   <file>/etc/rpc</file>, and <file>/etc/inetd.conf</file>
1147 </item>
1148
1149 <item>updated section about `Configuration files':
1150   packages may not touch other packages' configuration files
1151 </item>
1152
1153 <item>MUAs and MTAs have to use liblockfile</item>
1154 </list></p>
1155
1156 <sect> Version 2.2.0.0
1157
1158 <p> Released July 1997.
1159
1160 <p><list>
1161 <item>added section 4.1 `Architecture specification strings':
1162   use
1163        &lt;arch&gt;-linux
1164   where &lt;arch&gt; is one of the following:
1165        i386, alpha, arm, m68k, powerpc, sparc.
1166 </item>
1167
1168 <item>detailed rules for <file>/usr/local</file></item>
1169
1170 <item>user ID's</item>
1171
1172 <item>editor/pager policy</item>
1173
1174 <item>cron jobs</item>
1175
1176 <item>device files</item>
1177
1178 <item>don't install shared libraries as executable</item>
1179
1180 <item>app-defaults files may not be conffiles</item>
1181 </list></p>
1182
1183 <sect> Version 2.1.3.2, 2.1.3.1, 2.1.3.0
1184
1185 <p> Released Mar 1997.
1186
1187 <p><list>
1188 <item>two programs with different functionality must not have the
1189   same name </item>
1190
1191 <item>"Webstandard 3.0"</item>
1192
1193 <item>"Standard for Console Messages"</item>
1194
1195 <item>Libraries should be compiled with `-D_REENTRANT'</item>
1196
1197 <item>Libraries should be stripped with <prgn>strip --strip-unneeded</prgn>
1198 </item>
1199 </list></p>
1200
1201 <sect> Version 2.1.2.2, 2.1.2.1, 2.1.2.0
1202
1203 <p> Released Nov 1996.
1204
1205 <p><list>
1206 <item>Some changes WRT shared libraries
1207 </list></p>
1208
1209 <sect> Version 2.1.1.0
1210
1211 <p> Released Sep 1996.
1212
1213 <p><list>
1214 <item>No hard links in source packages</item>
1215
1216 <item>Do not use <prgn>dpkg-divert</prgn> or <prgn>update-alternatives</prgn>
1217 without consultation </item>
1218
1219 <item>Shared libraries must be installed stripped </item>
1220 </list></p>
1221
1222 <sect> Version 2.1.0.0
1223
1224 <p> Released Aug 1996.
1225
1226 <p><list>
1227   <item>Upstream changelog must be installed too </item>
1228 </list></p>
1229 </book>
1230 </debiandoc>