1 <!doctype debiandoc system>
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/
12 <chapt> About the checklist
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.
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 < 2.5.0,
32 it may be easier to check through the whole of policy instead of
33 picking your way through this list.
37 <sect> Version 3.9.1.0
44 <item>Date-based version components should be given as the four-digit
45 year, two-digit month, and then two-digit day, but may have embedded
49 <item>Maintainer scripts must pass <tt>--package</tt>
50 to <prgn>dpkg-divert</prgn> when creating or removing diversions and
51 must not use <tt>--local</tt>.
54 <item>Only <prgn>dpkg-gencontrol</prgn> supports variable substitution.
55 <prgn>dpkg-genchanges</prgn> (for <file>*.changes</file>)
56 and <prgn>dpkg-source</prgn> (for <file>*.dsc</file>) do not.
59 <item>Architecture restrictions and wildcards are also allowed in binary
60 package relationships provided that the binary package is not
61 architecture-independent.
64 <item><tt>Conflicts</tt> and <tt>Breaks</tt> should only be used when
65 there are file conflicts or one package breaks the other, not just
66 because two packages provide similar functionality but don't interfere.
69 <item>The SONAME of a library should change whenever the ABI of the
70 library changes in a way that isn't backward-compatible. It should not
71 change if the library ABI changes are backward-compatible. Discourage
72 bundling shared libraries together in one package.
75 <item>Ada Library Information (<file>*.ali</file>) files must be
78 <tag>8.6.1, 8.6.2, 8.6.5</tag>
79 <item>Packages should normally not include a <file>shlibs.local</file>
80 file since we now have complete <file>shlibs</file> coverage.
83 <item>The SONAME of a library may instead be of the
84 form <tt><var>name</var>-<var>major-version</var>.so</tt>.
87 <item>Libtool <file>.la</file> files should not be installed for public
88 libraries. If they're required (for <tt>libltdl</tt>, for instance),
89 the <tt>dependency_libs</tt> setting should be emptied. Library
90 packages historically including <file>.la</file> files must continue to
91 include them (with <tt>dependency_libs</tt> emptied) until all libraries
92 that depend on that library have removed or emptied
93 their <file>.la</file> files.
96 <item>Libraries no longer need to be built with <tt>-D_REENTRANT</tt>,
97 which was an obsolete LinuxThreads requirement. Instead, say explicitly
98 that libraries should be built with threading support and to be
99 thread-safe if the library supports this.
102 <item><file>/bin/sh</file> scripts may assume that <prgn>kill</prgn>
103 supports an argument of <tt>-<var>signal</var></tt>,
104 that <prgn>kill</prgn> and <prgn>trap</prgn> support the numeric signals
105 listed in the XSI extension, and that signal 13 (SIGPIPE) can be trapped
106 with <prgn>trap</prgn>.
109 <item>Recommend <file>/etc/logrotate.d/<var>package</var></file> for
113 <item>Control information files should be owned by <tt>root:root</tt>
114 and either mode 644 or mode 755.
116 <tag>11.4, 11.8.3, 11.8.4</tag>
117 <item>Packages providing alternatives for <prgn>editor</prgn>,
118 <prgn>pager</prgn>, <prgn>x-terminal-emulator</prgn>, or
119 <prgn>x-window-manager</prgn> should also provide a slave alternative
120 for the corresponding manual page.
123 <item>Cgi-bin executable files may be installed in subdirectories
124 of <file>/usr/lib/cgi-bin</file> and web servers should serve out
125 executables in those subdirectories.
128 <item>The GPL version 1 is now included in common-licenses and should be
129 referenced from there instead of included in the <file>copyright</file>
134 <sect> Version 3.9.0.0
140 <tag>4.4, 5.6.15</tag>
141 <item>The required format for the date in a changelog entry and in the
142 Date control field is now precisely specified.
145 <item>A control paragraph must not contain more than one instance of a
146 particular field name.
148 <tag>5.4, 5.5, 5.6.24</tag>
149 <item>Document and recommend the <tt>Checksums-Sha1</tt>
150 and <tt>Checksums-Sha256</tt> fields in <file>*.dsc</file>
151 and <file>*.changes</file> files.
153 <tag>5.5, 5.6.16</tag>
154 <item>The <tt>Format</tt> field of <file>.changes</file> files is now
155 1.8. The <tt>Format</tt> field syntax for source
156 package <file>.dsc</file> files allows a subtype in parentheses, and it
157 is used for a different purpose than the <tt>Format</tt> field
158 for <file>.changes</file> files.
161 <item>The syntax of the <tt>Maintainer</tt> field is now must rather
165 <item>The comma separating entries in <tt>Uploaders</tt> is now must
168 <tag>5.6.8, 7.1, 11.1.1</tag>
169 <item>Architecture wildcards may be used in addition to specific
170 architectures in <file>debian/control</file> and <file>*.dsc</file>
171 Architecture fields, and in architecture restrictions in build
175 <item>Maintainer scripts are no longer guaranteed to run with a
176 controlling terminal and must be able to fall back to noninteractive
177 behavior (debconf handles this). Maintainer scripts may abort if there
178 is no controlling terminal and no reasonable default for a high-priority
179 question, but should avoid this if possible.
181 <tag>7.3, 7.6.1</tag>
182 <item><tt>Breaks</tt> should be used with <tt>Replaces</tt> for moving
183 files between packages.
186 <item><tt>Breaks</tt> should normally be used instead
187 of <tt>Conflicts</tt> for transient issues and moving files between
188 packages. New documentation of when each should be used.
191 <item>Use <tt>Conflicts</tt> with <tt>Provides</tt> if only one provider
192 of a virtual facility can be installed at a time.
195 <item>All shared library development files are no longer required to be
196 in the <tt>-dev</tt> package, only be available when the <tt>-dev</tt>
197 package is installed. This allows the <tt>-dev</tt> package to be split
198 as long as it depends on the additional packages.
201 <item>The UID range of user accounts is extended to 1000-59999.
203 <tag>9.3.2, 10.4</tag>
204 <item><file>init.d</file> scripts are a possible exception from the
205 normal requirement to use <tt>set -e</tt> in each shell script.
208 <item>The UCB BSD license was removed from the list of licenses that
209 should be referenced from <file>/usr/share/common-licenses/BSD</file>.
210 It should instead be included directly
211 in <file>debian/copyright</file>, although it will still be in
212 common-licenses for the time being.
215 <item>Add <tt>SETTITLE</tt> (which has been supported for some time).
216 Like <tt>TITLE</tt> but takes a template instead of a string to allow
220 <item><package>perl-base</package> now
221 provides <package>perlapi-<var>abiname</var></package> instead of a
222 package based solely on the Perl version. Perl packages must now depend
223 on <package>perlapi-$Config{debian_abi}</package>, falling back
224 on <tt>$Config{version}</tt> if <tt>$Config{debian_abi}</tt> is not set.
227 <item>Packages using <file>Makefile.PL</file> should use
228 <tt>DESTDIR</tt> rather than <tt>PREFIX</tt> to install into the package
229 staging area. <tt>PREFIX</tt> only worked due to a Debian-local patch.
233 <sect> Version 3.8.4.0
240 <item> An FHS exception has been granted for multiarch libraries.
241 Permitting files to instead be installed to <file>/lib/triplet</file> and
242 <file>/usr/lib/triplet</file> directories.
245 <item>Explicitly state that packages may not contain named pipes and
246 should instead create them in postinst and remove them in prerm or postrm.
249 <item><file>/sys</file> and <file>/selinux</file> directories are explicitly
250 allowed as an exception to the FHS.
254 <sect> Version 3.8.3.0
260 <item>Add DEB_*_ARCH_CPU and DEB_*_ARCH_OS variables and
261 recommend them over GNU-style variables for that information.
264 <item>Source package Architecture fields may contain <em/all/ in
265 combination with other architectures. Clarify when <em/all/ and <em/any/
266 may be used in different versions of the field.
269 <item>The Debian archive software does not support uploading
270 to multiple distributions with one <file>*.changes</file> file.
273 <item>The Binary field may span multiple lines.
276 <item>Remove the permission for shared library packages to
277 install libraries in a non-standard location and modify <file/ld.so.conf/.
278 Packages should either be installed in a standard library directory
279 or packages using them should be built with RPATH.
282 <item>Clarify installation directories for X programs and
283 remove the requirement to pre-depend on x11-common before installing
284 into <file>/usr/include/X11</file> and <file>/usr/lib/X11</file>.
287 <item>Remove the requirement that all characters in a manual
288 page be representable in the legacy encoding for that language.
291 <item>Localized man pages should either be kept up-to-date with
292 the original version or warn that they're not up-to-date, either
293 with warning text or by showing missing or changed portions in the
297 <item>install-info is now handled via triggers so packages no
298 longer need to invoke it in maintainer scripts. Info documents
299 should now have directory sections and entries in the document.
300 Packages containing info documents should add a dependency to
301 support partial upgrades.
304 <item>The requirement for Perl modules to have a versioned
305 Depend and Build-Depend on <tt>perl >= 5.6.0-16</tt> has been removed.
309 <sect> Version 3.8.2.0
316 <item>The list of archive sections has been significantly expanded. See
317 <url id="http://lists.debian.org/debian-devel-announce/2009/03/msg00010.html"
318 name="this debian-devel-announce message">
319 for the list of new sections and rules for how to categorize
323 <item>All packages must use debconf or equivalent for user prompting,
324 though essential packages or their dependencies may also fall
325 back on other methods.
328 <item>The requirements for source package names are now explicitly
332 <item>Legacy XFree86 servers no longer get a special exception from the
333 FHS permitting <file>/etc/X11/XF86Config-4</file>.
336 <item>Removed obsolete dependency requirements for packages that use
337 <file>/var/mail</file>.
340 <item>Speedo fonts are now deprecated. The X backend was disabled
344 <item>The GNU Free Documentation License version 1.3 is included in
345 common-licenses and should be referenced from there.
349 <sect> Version 3.8.1.0
356 <item>Care should be taken when adding functionality to essential and
357 such additions create an obligation to support that functionality
358 in essential forever unless significant work is done.
361 <item>Changelog files must be encoded in UTF-8.
364 <item>Tighten some format requirements for changelog files from a should
368 <item>Remove alternative changelog formats. Debian only supports one
369 changelog format for the Debian Archive.
372 <item>New nocheck option for DEB_BUILD_OPTIONS indicating any build-time
373 test suite provided by the package should not be run.
376 <item>All control files must be encoded in UTF-8.
379 <item>debian/control allows comment lines starting with # with no
380 preceding whitespace.
383 <item>Init scripts ending in .sh are not handled specially. They are not
384 sourced and are not guaranteed to be run by <prgn>/bin/sh</prgn> regardless
385 of the #! line. This brings Policy in line with the long-standing
386 behavior of the init system in Debian.
389 <item>The start action of an init script must exit successfully and not
390 start the daemon again if it's already running.
393 <item><file>/var/run</file> and <file>/var/lock</file> may be mounted as
394 temporary filesystems, and init scripts must therefore create any necessary
395 subdirectories dynamically.
398 <item> <file>/bin/sh</file> scripts may assume that local can take multiple
399 variable arguments and supports assignment.
402 <item>User mailboxes may be mode 600 and owned by the user rather than
403 mode 660, owned by user, and group mail.
407 <sect> Version 3.8.0.0
414 <item>The base section has been removed. contrib and non-free have been
415 removed from the section list; they are only categories. The base
416 system is now defined by priority.
418 <item>If <prgn>dpkg-source -x</prgn> doesn't provide the source that will be
419 compiled, a debian/rules patch target is recommended and should do whatever
421 <tag>4.9.1, 10.1</tag>
422 <item>Standardized the format of DEB_BUILD_OPTIONS. Specified permitted
423 characters for tags, required that tags be whitespace-separated,
424 allowed packages to assume non-conflicting tags, and required
425 unknown flags be ignored.
427 <item>Added parallel=n to the standardized DEB_BUILD_OPTIONS tags,
428 indicating that a package should be built using up to n parallel
429 processes if the package supports it
431 <item>Debian packages should not use convenience copies of code from other
432 packages unless the included package is explicitly intended to be
435 <item>If dpkg-source -x doesn't produce source ready for editing and
436 building with dpkg-buildpackage, packages should include a
437 <file>debian/README.source</file> file explaining how to generate
438 the patched source, add a new modification, and remove an existing
439 modification. This file may also be used to document packaging a
440 new upstream release and any other complexity of the Debian build
443 <item>The Uploaders field in debian/control may be wrapped.
445 <item>An empty Debian revision is equivalent to a Debian revision of 0 in
448 <item>New Homepage field for upstream web sites.
449 <tag>6.5, 6.6, 7</tag>
450 <item>The Breaks field declares that this package breaks another and
451 prevents installation of the breaking package unless the package
452 named in Breaks is deconfigured first. This field should not be
453 used until the dpkg in Debian stable supports it.
455 <item>Clarify which files should go into a shared library package, into a
456 separate package, or into the -dev package. Suggest -tools instead
457 of -runtime for runtime support programs, since that naming is more
460 <item>Files in <file>/etc/cron.{hourly,daily,weekly,monthly}</file> must be
461 configuration files (upgraded from should). Mention the hourly
464 <item>Packages providing <file>/etc/X11/Xresources</file> files need not
465 conflict with <tt> xbase (<< 3.3.2.3a-2)</tt>, which is
468 <item>Manual pages in locale-specific directories should use either the
469 legacy encoding for that directory or UTF-8. Country names should
470 not be included in locale-specific manual page directories unless
471 indicating a significant difference in the language. All
472 characters in the manual page source should be representable in the
473 legacy encoding for a locale even if the man page is encoded in
476 <item>The Apache 2.0 license is now in common-licenses and should be
477 referenced rather than quoted in <file>debian/copyright</file>.
479 <item>Packages in contrib and non-free should state in the copyright file
480 that the package is not part of Debian GNU/Linux and briefly
483 <item>Underscore (_) is allowed in debconf template names.
486 <sect> Version 3.7.3.0
493 <item>Package version numbers may contain tildes, which sort before
494 anything, even the end of a part.
496 <item>Scripts may assume that <file>/bin/sh</file> supports local (at a basic
497 level) and that its test builtin (if any) supports -a and -o binary
500 <item>The substitution variable ${binary:Version} should be used in place
501 of ${Source-Version} for dependencies between packages of the same
503 <tag>menu policy</tag>
504 <item>Substantial reorganization and renaming of sections in the Debian
505 menu structure. Packages with menu entries should be reviewed to
506 see if the menu section has been renamed or if one of the new
507 sections would be more appropriate.
509 <item>The Source field in a .changes file may contain a version number
512 <item>The acceptable values for the Urgency field are low, medium, high,
513 critical, or emergency.
515 <item>The shlibs file now allows an optional type field, indicating the
516 type of package for which the line is valid. The only currently
517 supported type is udeb, used with packages for the Debian
520 <item>Packages following the Debian Configuration management
521 specification must allow for translation of their messages by using
522 a gettext-based system such as po-debconf.
524 <item>GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
525 be referenced rather than quoted in debian/copyright.
528 <sect> Version 3.7.2.2
534 <tag>6.1</tag> <item>Maintainer scripts must not be world writeable (up from a
535 should to a must)</item>
538 <sect> Version 3.7.2.0
544 <tag>11.5</tag> <item>Revert the cgi-lib change. </item>
547 <sect> Version 3.7.1.0
554 <item>It is now possible to create shared libraries without
555 relocatable code (using -fPIC) in certain exceptional cases,
556 provided some procedures are followed, and for creating static
557 libraries with relocatable code (again, using -fPIC).
558 Discussion on debian-devel@lists.debian.org, getting a rough
559 consensus, and documenting it in README.Debian constitute most
562 <item>Packages should install any relevant files into the directories
563 <file>/usr/include/X11/</file> and <file>/usr/lib/X11/</file>, but if
564 they do so, they must pre-depend on <tt>x11-common (>= 1:7.0.0)</tt>
567 <sect> Version 3.7.0.0
574 <item>Packages shipping web server CGI files are expected to install
575 them in <file>/usr/lib/cgi-lib/</file> directories. This location change
576 perhaps should be documented in NEWS
578 <item>Web server packages should include a standard scriptAlias of
579 cgi-lib to <file>/usr/lib/cgi-lib</file>.
581 <item>The version of FHS mandated by policy has been upped to
582 2.3. There should be no changes required for most packages,
583 though new top level directories <file>/media</file>, <file>/srv</file>,
584 etc. may be of interest.
585 <tag>5.1, 5.6.3</tag>
586 <item>All fields, apart from the Uploaders field, in the control file
587 are supposed to be a single logical line, which may be spread
588 over multiple physical lines (newline followed by space is
589 elided). However, any parser for the control file must allow
590 the Uploaders field to be spread over multiple physical lines
591 as well, to prepare for future changes.
593 <item>When scripts are installed into a directory in the system
594 PATH, the script name should not include an extension that
595 denotes the scripting language currently used to implement it.
598 <item>packages that invoke initscripts now must use invoke-rc.d to do
599 so since it also pays attention to run levels and other local
601 <tag>11.8.5.2, 11.8.7, etc</tag>
602 <item>We no longer use <file>/usr/X11R6</file>, since we have
603 migrated away to using Xorg paths. This means, for one thing, fonts
604 live in <file>/usr/share/fonts/X11/</file> now, and <file>/usr/X11R6</file>
608 <sect> Version 3.6.2.0
615 <item>Recommend. doc-base, and not menu, for registering package documentation.
618 <item>Run time support programs should live in subdirectories of
619 <file>/usr/lib/</file> or <file>/usr/share</file>, and preferably the shared
620 lib is named the same as the package name (to avoid name collisions).
623 <item>It is recommended that HTTP servers provide an alias /images to
624 allow packages to share image files with the web server
628 <sect> Version 3.6.1.0
635 <item>Prompting the user should be done using debconf. Non debconf
636 user prompts are now deprecated.
646 <item>Restructuring causing shifts in section numbers and bumping of
647 the minor version number:
649 <item>Many packaging manual appendices that were integrated into policy
650 sections are now empty, and replaced with links to the Policy.
651 In particular, the appendices that included the list of control
652 fields were updated (new fields like Closes, Changed-By were added)
653 and the list of fields for each of control, .changes and .dsc files
654 is now in Policy, and they're marked mandatory, recommended or
655 optional based on the current practice and the behavior of the
656 deb-building tool-chain.
658 <item>Elimination of needlessly deep section levels, primarily in the
659 chapter Debian Archive, from which two new chapters were split out,
660 Binary packages and Source packages. What remained was reordered
661 properly, that is, some sects became sects etc.
663 <item>Several sections that were redundant, crufty or simply not designed
664 with any sort of vision, were rearranged according to the formula that
665 everything should be either in the same place or properly interlinked.
666 Some things remained split up between different chapters when they
667 talked about different aspects of files: their content, their syntax,
668 and their placement in the file system. In particular, see the new
669 sections about changelog files.
670 <tag>menu policy</tag>
671 <item>Added Games/Simulation and Apps/Education to menu
674 <item>Debian changelogs should be UTF-8 encoded.
676 <item>shared libraries must be linked against all libraries that they
677 use symbols from in the same way that binaries are.
679 <item>build-depends-indep need not be satisfied during clean
683 <sect> Version 3.5.10
690 <item>packages providing the x-terminal-emulator virtual package
691 ought to ensure that they interpret the command line exactly
694 <item>Window managers compliant with the Window Manager Specification
695 Project may add 40 points for ranking in the alternatives
698 <sect> Version 3.5.9.0
705 <item>The section describing the Description: package field once again has
706 full details of the long description format.
708 <item>Clarified that if a package has non-build-essential
709 build-dependencies, it should have them listed in the Build-Depends
710 and related fields (i.e. it's not merely optional).
712 <item>When asked to restart a service that isn't already running,
713 the init script should start the service.
715 <item>If the purpose of a package is to provide examples, then the
716 example files can be installed into <file>/usr/share/doc/package</file>
717 (rather than <file>/usr/share/doc/package/examples</file>).
720 <sect> Version 3.5.8.0
727 <item>It is no longer necessary to keep a log of changes to the upstream
728 sources in the copyright file. Instead, all such changes should be
729 documented in the changelog file.
731 <item><var/Build-Depends/, <var/Build-Conflicts/, <var/Build-Depends-Indep/,
732 and <var/Build-Conflicts-Indep/ must also be satisfied when the clean
734 <tag>menu policy</tag>
735 <item>A new Apps/Science menu section is available
736 <tag>debconf policy</tag>
737 <item>debconf specification cleared up, various changes.
739 <item>It is no longer recommended to create symlinks from nonexistent
740 manual pages to undocumented(7). Missing manual pages for programs
744 <sect> Version 3.5.7.0
751 <item>Packages no longer have to ask permission to call MAKEDEV in
752 postinst, merely notifying the user ought to be enough.
754 <item>cryptographic software may now be included in the main
757 <item>task packages are no longer permitted; tasks are now created by a
758 special Tasks: field in the control file.
760 <item>window managers that support netwm can now add 20 points when
761 they add themselves as an alternative for
762 <file>/usr/bin/x-window-manager</file>
764 <item>The default compilation options have now changed, one should
765 provide debugging symbols in all cases, and optionally step
766 back optimization to -O0, depending on the DEB_BUILD_OPTIONS
767 environment variable.
769 <item>Added mention of build-arch, build-indep, etc, in describing
770 the relationships with `Build-Depends', `Build-Conflicts',
771 `Build-Depends-Indep', and `Build-Conflicts-Indep'. May need to
772 review the new rules.
774 <item>Changed rules on how, and when, to invoke ldconfig in maintainer
775 scripts. Long rationale.
779 Added the last note in 3.5.6 upgrading checklist item regarding build
780 rules, please see below
783 <sect> Version 3.5.6.0
790 <item>Emacs and TeX are no longer mandated by policy to be priority
793 <item>Programs that access docs need to do so via <file>/usr/share/doc</file>,
794 and not via <file>/usr/doc/</file> as was the policy previously
796 <item>Putting documentation in <file>/usr/doc</file> versus
797 <file>/usr/share/doc</file> is now a ``serious'' policy violation.
799 <item>For web servers, one should not provide non-local access to the
800 <file>/usr/share/doc</file> hierarchy. If one can't provide access
801 controls for the http://localhost/doc/ directory, then it is preferred
802 that one ask permission to expose that information during the install.
804 <item>There are new rules for build-indep/build-arch targets and
805 there is a new Build-Depend-Indep semantic.
808 <sect> Version 3.5.5.0
815 <item>Manpages should not rely on header information to have
816 alternative manpage names available; it should only use
817 symlinks or .so pages to do this
820 <item><em> Clarified note in 3.5.3.0 upgrading checklist regarding
821 examples and templates: this refers only to those examples used
822 by scripts; see section 10.7.3 for the whole story</em>
825 <item>Included a new section 10.9.1 describing the use of
826 dpkg-statoverride; this does not have the weight of policy
829 <item>Clarify Standards-Version: you don't need to rebuild your
830 packages just to change the Standards-Version!
833 <item>Plugins are no longer bound by all the rules of shared
836 <tag>X Windows related things:</tag>
839 <item>Clarification of priority levels of X Window System related
843 <item>Rules for defining x-terminal-emulator improved </item>
845 <item>X Font policy rewritten: you must read this if you provide
846 fonts for the X Window System
849 <item>Packages must not ship <file>/usr/X11R6/lib/X11/app-defaults/</file>
852 <item>X-related packages should usually use the regular FHS
853 locations; imake-using packages are exempted from this
856 <item>OpenMotif linked binaries have the same rules as
857 OSF/Motif-linked ones
862 <sect> Version 3.5.4.0
863 <p> Released Apr 2001.
867 <item>The system-wide mail directory is now /var/mail, no longer
868 /var/spool/mail. Any packages accessing the mail spool should
869 access it via /var/mail and include a suitable Depends field;
872 <tag>11.9; perl-policy</tag>
873 <item>The perl policy is now part of Debian policy
874 proper. Perl programs and modules should follow the current Perl
879 <sect> Version 3.5.3.0
880 <p> Released Apr 2001
884 <item>Build-Depends arch syntax has been changed to be less
885 ambiguous. This should not affect any current packages
888 <item>Examples and templates files for use by scripts should now live
889 in <file>/usr/share/<package></file> or
890 <file>/usr/lib/<package></file>, with symbolic links from
891 <file>/usr/share/doc/<package>/examples</file> as needed
895 <sect> Version 3.5.2.0
897 <p> Released Feb 2001.
901 <item>X app-defaults directory has moved from
902 <file>/usr/X11R6/lib/X11/app-defaults</file> to
903 <file>/etc/X11/app-defaults</file>
907 <sect> Version 3.5.1.0
909 <p> Released Feb 2001.
913 <item>dpkg-shlibdeps now uses objdump, so shared libraries have to be
914 run through dpkg-shlibdeps as well as executables
918 <sect> Version 3.5.0.0
920 <p> Released Jan 2001.
924 <item>Font packages for the X Window System must now declare a
925 dependency on xutils (>= 4.0.2)
929 <sect> Version 3.2.1.1
931 <p> Released Jan 2001.
935 <item>Daemon startup scripts in <file>/etc/init.d/</file> should not contain
936 modifiable parameters; these should be moved to a file in
937 <file>/etc/default/</file>
940 <item>Files in <file>/usr/share/doc</file> must not be referenced by any
941 program. If such files are needed, they must be placed in
942 <file>/usr/share/<package>/</file>, and symbolic links
943 created as required in <file>/usr/share/doc/<package>/</file>
946 <item>Much of the packaging manual has now been imported into the
951 <sect> Version 3.2.1.0
957 <item>A package of priority standard or higher may provide two
958 binaries, one compiled with support for the X Window System,
959 and the other without
963 <sect> Version 3.2.0.0
969 <item>By default executables should not be built with the debugging
970 option -g. Instead, it is recommended to support building the
971 package with debugging information optionally. Details in
974 <item>Policy for packages where the upstream uses HTML changelog
975 files has been expanded. In short, a plain text changelog file
976 should always be generated for the upstream changes
979 <item>Please note that the new release of the X window system (3.2)
980 shall probably need sweeping changes in policy
983 <item>Policy for packages providing the following X-based features
987 <item>X server (virtual package xserver) </item>
989 <item>X terminal emulator (virtual package x-terminal-emulator) </item>
991 <item>X window manager (virtual package x-window-manager, and
992 <file>/usr/bin/x-window-manager</file> alternative, with priority
993 calculation guidelines)
996 <item>X fonts (this section has been written from scratch) </item>
998 <item>X application defaults </item>
1002 <item>Policy for packages using the X Window System and FHS issues
1006 <item>No package may contain or make hard links to conffiles </item>
1008 <item>Noted that newer dpkg versions do not require extreme care in
1009 always creating the shared lib before the symlink, so the unpack
1014 <sect> Version 3.1.1.0
1016 <p> Released Nov 1999.
1020 <item>Correction to semantics of architecture lists in Build-Depends
1021 etc. Should not affect many packages
1025 <sect> Version 3.1.0.0
1027 <p> Released Oct 1999.
1031 <item><file>/usr/doc/<package></file> has to be a symlink pointing to
1032 <file>/usr/share/doc/<package></file>, to be maintained by postinst
1036 <item>Introduced source dependencies (Build-Depends, etc.) </item>
1038 <item><file>/etc/rc.boot</file> has been deprecated in favour of
1039 <file>/etc/rcS.d</file>. (Packages should not be touching this directory,
1040 but should use update-rc.d instead)
1043 <item>update-rc.d is now the <em>only</em> allowable way of accessing the
1044 <file>/etc/rc?.d/[SK]??*</file> links. Any scripts which manipulate them
1045 directly must be changed to use update-rc.d instead. (This is
1046 because the file-rc package handles this information in an
1050 <item>Architecture-specific examples go in
1051 <file>/usr/lib/<package>/examples</file>
1052 with symlinks from <file>/usr/share/doc/<package>/examples/*</file>
1053 or from <file>/usr/share/doc/<package>/examples</file> itself
1056 <item>Updated FHS to a 2.1 draft; this reverts <file>/var/state</file> to
1057 <file>/var/lib</file>
1059 <tag>9.7; mime-policy</tag>
1060 <item>Added MIME sub-policy document </item>
1062 <item>VISUAL is allowed as a (higher priority) alternative to EDITOR
1065 <item>Modified liblockfile description, which affects
1066 mailbox-accessing programs. Please see the policy document for
1070 <item>If a package provides a changelog in HTML format, a text-only
1071 version should also be included. (Such a version may be prepared
1072 using <prgn>lynx -dump -nolist</prgn>.)
1075 <item>Description of how to handle version numbers based on dates
1080 <sect> Version 3.0.1.0
1082 <p> Released Jul 1999.
1086 <item>Added the clarification that the .la files are essential for
1087 the packages using libtool's libltdl library, in which case the .la
1088 files must go in the run-time library package
1092 <sect> Version 3.0.0.0
1094 <p> Released Jun 1999.
1098 <item>Debian formally moves from the FSSTND to the FHS. This is a
1099 major change, and the implications of this move are probably
1103 <item>Only 3 digits of the Standards version need be included in
1104 control files, though all four digits are still permitted.
1107 <item>The location of the GPL has changed to
1108 <file>/usr/share/common-licenses</file>. This may require changing the
1109 copyright files to point to the correct location of the GPL and
1110 other major licenses
1113 <item>Packages that use libtool to create shared libraries must
1114 include the .la files in the -dev packages
1117 <item>Use logrotate to rotate log files
1120 <item>section 5.8 has been rewritten (Programs for the X Window
1123 <tag>9.6; menu-policy</tag>
1124 <item>There is now an associated menu policy, in a separate document,
1125 that carries the full weight of Debian policy
1128 <item>Programs which need to modify the files <file>/var/run/utmp</file>,
1129 <file>/var/log/wtmp</file> and <file>/var/log/lastlog</file> must be
1130 installed setgid utmp
1134 Please note that section numbers below this point may not be up to date
1137 <sect> Version 2.5.0.0
1139 <p> Released Oct 1998.
1143 <item>Rearranged the manual to create a new Section 4, Files
1145 <item>Section 3.3 ("Files") was moved to Section 4. The Sections
1146 that were Section 4 and Section 5 were moved down to become
1147 Section 5 and Section 6.
1149 <item>What was Section 5.5 ("Log files") is now a subsection of the
1150 new Section 4 ("Files"), becoming section 4.8, placed after
1151 "Configuration files", moving the Section 4.8 ("Permissions
1152 and owners") to Section 4.9. All subsections of the old
1153 Section 5 after 5.5 were moved down to fill in the number
1157 <item>Modified the section about changelog files to accommodate
1158 upstream changelogs which were formatted as HTML. These
1159 upstream changelog files should now be accessible as
1160 <file>/usr/doc/package/changelog.html.gz</file>
1162 <item>Symlinks are permissible to link the real, or upstream,
1163 changelog name to the Debian mandated name.
1165 <item>Clarified that HTML documentation should be present in some
1166 package, though not necessarily the main binary package.
1168 <item>Corrected all references to the location of the copyright
1169 files. The correct location is <file>/usr/doc/package/copyright</file>
1171 <item>Ratified the architecture specification strings to cater to the
1176 <sect> Version 2.4.1.0
1178 <p> Released Apr 1998.
1180 <sect1> Policy Manual:
1182 <tag>Updated section 3.3.5 Symbolic links:</tag>
1183 <item>symbolic links within a toplevel directory should be relative,
1184 symbolic links between toplevel directories should be absolute
1185 (cf., Policy Weekly Issue#6, topic 2)
1188 <tag>Updated section 4.9 Games:</tag>
1189 <item>manpages for games should be installed in <file>/usr/man/man6</file>
1190 (cf., Policy Weekly Issue#6, topic 3)
1194 <sect1> Packaging Manual:
1196 <item>Updated prefix of chapter 12, Shared Libraries:
1197 ldconfig must be called in the postinst script if the package
1198 installs shared libraries
1199 (cf., Policy Weekly Issue #6, fixes:bug#20515)
1203 <sect> Version 2.4.0.0
1205 <p> Released Jan 1998
1208 <tag>Updated section 3.3.4 Scripts:</tag>
1210 <item>/bin/sh may be any POSIX compatible shell
1211 <item>scripts including bashisms have to specify <file>/bin/bash</file>
1213 <item>scripts which create files in world-writable directories
1214 (e.g., in <file>/tmp</file>) should use tempfile or mktemp for creating
1218 <tag>Updated section 3.3.5 Symbolic Links:</tag>
1219 <item>symbolic links referencing compressed files must have the same
1220 file extension as the referenced file
1223 <tag>Updated section 3.3.6 Device files:</tag>
1224 <item><file>/dev/tty*</file> serial devices should be used instead of
1225 <file>/dev/cu*</file>
1228 <tag>Updated section 3.4.2 Writing the scripts in <file>/etc/init.d</file>:
1230 <item>all <file>/etc/init.d</file> scripts have to provide the following
1231 options: start, stop, restart, force-reload
1232 <item>the reload option is optional and must never stop and restart
1236 <tag>Updated section 3.5 Cron jobs:
1237 <item>cron jobs that need to be executed more often than daily should
1238 be installed into <file>/etc/cron.d</file>
1241 <tag>Updated section 3.7 Menus:
1242 <item>removed section about how to register HTML docs to `menu'
1243 (the corresponding section in 4.4, Web servers and applications,
1244 has been removed in policy 2.2.0.0 already, so this one was
1248 <tag>New section 3.8 Keyboard configuration:
1249 <item>details about how the backspace and delete keys should be
1253 <tag>New section 3.9 Environment variables:
1254 <item>no program must depend on environment variables to get a
1255 reasonable default configuration
1258 <tag>New section 4.6 News system configuration:
1259 <item><file>/etc/news/organization</file> and <file>/etc/news/server</file>
1260 should be supported by all news servers and clients
1263 <tag>Updated section 4.7 Programs for the X Window System:
1265 <item>programs requiring a non-free Motif library should be provided
1266 as foo-smotif and foo-dmotif package
1268 <item>if lesstif works reliably for such program, it should be linked
1269 against lesstif and not against a non-free Motif library
1273 <tag>Updated section 4.9 Games:
1274 <item>games for X Windows have to be installed in <file>/usr/games</file>,
1279 <sect> Version 2.3.0.1, 2.3.0.0
1281 <p> Released Sep 1997.
1284 <item>new section `4.2 Daemons' including rules for
1285 <file>/etc/services</file>, <file>/etc/protocols</file>,
1286 <file>/etc/rpc</file>, and <file>/etc/inetd.conf</file>
1289 <item>updated section about `Configuration files':
1290 packages may not touch other packages' configuration files
1293 <item>MUAs and MTAs have to use liblockfile</item>
1296 <sect> Version 2.2.0.0
1298 <p> Released July 1997.
1301 <item>added section 4.1 `Architecture specification strings':
1304 where <arch> is one of the following:
1305 i386, alpha, arm, m68k, powerpc, sparc.
1308 <item>detailed rules for <file>/usr/local</file></item>
1310 <item>user ID's</item>
1312 <item>editor/pager policy</item>
1314 <item>cron jobs</item>
1316 <item>device files</item>
1318 <item>don't install shared libraries as executable</item>
1320 <item>app-defaults files may not be conffiles</item>
1323 <sect> Version 2.1.3.2, 2.1.3.1, 2.1.3.0
1325 <p> Released Mar 1997.
1328 <item>two programs with different functionality must not have the
1331 <item>"Webstandard 3.0"</item>
1333 <item>"Standard for Console Messages"</item>
1335 <item>Libraries should be compiled with `-D_REENTRANT'</item>
1337 <item>Libraries should be stripped with <prgn>strip --strip-unneeded</prgn>
1341 <sect> Version 2.1.2.2, 2.1.2.1, 2.1.2.0
1343 <p> Released Nov 1996.
1346 <item>Some changes WRT shared libraries
1349 <sect> Version 2.1.1.0
1351 <p> Released Sep 1996.
1354 <item>No hard links in source packages</item>
1356 <item>Do not use <prgn>dpkg-divert</prgn> or <prgn>update-alternatives</prgn>
1357 without consultation </item>
1359 <item>Shared libraries must be installed stripped </item>
1362 <sect> Version 2.1.0.0
1364 <p> Released Aug 1996.
1367 <item>Upstream changelog must be installed too </item>