1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
4 <!-- -*- Mode: Sgml -*-
8 <title>Policy checklist for upgrading your packages</title>
12 <h1>Policy checklist for upgrading your packages</h1>
14 <h2>About the checklist</h2>
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.
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.
41 <h2>The checklist</h2>
46 * Changelog files must be encoded in UTF-8. [4.4]
47 * Tighten some format requirements for changelog files from a should
49 * Remove alternative changelog formats. Debian only supports one
50 changelog format for the Debian Archive. [4.4.1]
51 * New nocheck option for DEB_BUILD_OPTIONS indicating any build-time
52 test suite provided by the package should not be run. [4.9.1]
53 * All control files must be encoded in UTF-8. [5.1]
54 * The start action of an init script must exit successfully and not
55 start the daemon again if it's already running. [9.3.2]
59 * The base section has been removed. contrib and non-free have been
60 removed from the section list; they are only categories. The base
61 system is now defined by priority. [2.4, 3.7]
62 * If dpkg-source -x doesn't provide the source that will be compiled,
63 a debian/rules patch target is recommended and should do whatever
64 else is necessary. [4.9]
65 * Standardized the format of DEB_BUILD_OPTIONS. Specified permitted
66 characters for tags, required that tags be whitespace-separated,
67 allowed packages to assume non-conflicting tags, and required
68 unknown flags be ignored. [4.9.1, 10.1]
69 * Added parallel=n to the standardized DEB_BUILD_OPTIONS tags,
70 indicating that a package should be built using up to n parallel
71 processes if the package supports it [4.9.1]
72 * Debian packages should not use convenience copies of code from other
73 packages unless the included package is explicitly intended to be
75 * If dpkg-source -x doesn't produce source ready for editing and
76 building with dpkg-buildpackage, packages should include a
77 debian/README.source file explaining how to generate the patched
78 source, add a new modification, and remove an existing
79 modification. This file may also be used to document packaging a
80 new upstream release and any other complexity of the Debian build
82 * The Uploaders field in debian/control may be wrapped. [5.6.3]
83 * An empty Debian revision is equivalent to a Debian revision of 0 in
84 a version number. [5.6.12]
85 * New Homepage field for upstream web sites. [5.6.23]
86 * The Breaks field declares that this package breaks another and
87 prevents installation of the breaking package unless the package
88 named in Breaks is deconfigured first. This field should not be
89 used until the dpkg in Debian stable supports it. [6.5, 6.6, 7]
90 * Clarify which files should go into a shared library package, into a
91 separate package, or into the -dev package. Suggest -tools instead
92 of -runtime for runtime support programs, since that naming is more
93 common in Debian. [8.1, 8.2]
94 * Files in /etc/cron.{hourly,daily,weekly,monthly} must be
95 configuration files (upgraded from should). Mention the hourly
97 * Packages providing /etc/X11/Xresources files need not conflict with
98 xbase (<< 3.3.2.3a-2), which is long-obsolete. [11.8.6]
99 * Manual pages in locale-specific directories should use either the
100 legacy encoding for that directory or UTF-8. Country names should
101 not be included in locale-specific manual page directories unless
102 indicating a significant difference in the language. All
103 characters in the manual page source should be representable in the
104 legacy encoding for a locale even if the man page is encoded in
106 * The Apache 2.0 license is now in common-licenses and should be
107 referenced rather than quoted in debian/copyright. [12.5]
108 * Packages in contrib and non-free should state in the copyright file
109 that the package is not part of Debian GNU/Linux and briefly
111 * Underscore (_) is allowed in debconf template names. [debconf]
115 * Package version numbers may contain tildes, which sort before
116 anything, even the end of a part. [5.6.12]
117 * Scripts may assume that /bin/sh supports local (at a basic level)
118 and that its test builtin (if any) supports -a and -o binary
119 logical operators. [10.4]
120 * The substitution variable ${binary:Version} should be used in place
121 of ${Source-Version} for dependencies between packages of the same
123 * Substantial reorganization and renaming of sections in the Debian
124 menu structure. Packages with menu entries should be reviewed to
125 see if the menu section has been renamed or if one of the new
126 sections would be more appropriate. [menu policy]
127 * The Source field in a .changes file may contain a version number
128 in parentheses. [5.6.1]
129 * The acceptable values for the Urgency field are low, medium, high,
130 critical, or emergency. [5.6.17]
131 * The shlibs file now allows an optional type field, indicating the
132 type of package for which the line is valid. The only currently
133 supported type is udeb, used with packages for the Debian
135 * Packages following the Debian Configuration management
136 specification must allow for translation of their messages by using
137 a gettext-based system such as po-debconf. [3.9.1]
138 * GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
139 be referenced rather than quoted in debian/copyright. [12.5]
143 * Maintainer scripts must not be world writeable (up from a
144 should to a must) [6.1]
148 * Revert the cgi-lib change. [11.5]
152 * It is now possible to create shared libraries without
153 relocatable code (using -fPIC) in certain exceptional cases,
154 provided some procedures are followed, and for creating static
155 libraries with relocatable code (again, using -fPIC).
156 Discussion on debian-devel@lists.debian.org, getting a rough
157 consensus, and documenting it in README.Debian constitute most
158 of the process. [10.2]
159 * Packages should install any relevant files into the directories
160 /usr/include/X11/and /usr/lib/X11/, but if they do so, they
161 must pre-depend on x11-common (>= 1:7.0.0) [11.8.7]
165 * Packages shipping web server CGI files are expected to install
166 them in /usr/lib/cgi-lib/ directories. This location change
167 perhaps should be documented in NEWS [11.5]
168 * Web server packages should include a standard scriptAlias of
169 cgi-lib to /usr/lib/cgi-lib. [11.5]
170 * The version of FHS mandated by policy has been upped to
171 2.3. There should be no changes required for most packages,
172 though new top level directories /media, /srv, etc may be of
174 * All fields, apart from the Uploaders field, in the control file
175 are supposed to be a single logical line, which may be spread
176 over multiple physical lines (newline followed by space is
177 elided). However, any parser for the control file must allow
178 the Uploaders field to be spread over multiple physical lines
179 as well, to prepare for future changes. [ 5.1, 5.6.3 ]
180 * When scripts are installed into a directory in the system
181 PATH, the script name should not include an extension that
182 denotes the scripting language currently used to implement it.
184 * packages that invoke initscripts now must use invoke-rc.d to do
185 so since it also pays attention to run levels and other local
186 constraints. [ 9.3.3.2 ]
187 * We no longer use /usr/X11R6, since we have migrated away to
188 using Xorg paths. This means, for one thing, fonts live in
189 /usr/share/fonts/X11/ now, and /usr/X11R6 is gone.
190 [ 11.8.5.2, 11.8.7, etc]
194 * Recommend doc-base, and not menu, for registering package documentation.
195 * Run time support programs should live in subdirectories of
196 /usr/lib/ or /usr/share, and preferably the shared lib is named
197 the same as the package name (to avoid name collisions). [8.1]
198 * It is recommended that HTTP servers provide an alias /images to
199 allow packages to share image files with the web server [11.5]
203 + Prompting the user should be done using debconf. Non debconf
204 user prompts are now deprecated. [3.10.1]
208 - Restructuring causing shifts in section numbers and bumping of
209 the minor version number:
210 + Many packaging manual appendices that were integrated into policy
211 sections are now empty, and replaced with links to the Policy.
212 In particular, the appendices that included the list of control
213 fields were updated (new fields like Closes, Changed-By were added)
214 and the list of fields for each of control, .changes and .dsc files
215 is now in Policy, and they're marked mandatory, recommended or
216 optional based on the current practice and the behavior of the
217 deb-building tool-chain.
218 + Elimination of needlessly deep section levels, primarily in the
219 chapter Debian Archive, from which two new chapters were split out,
220 Binary packages and Source packages. What remained was reordered
221 properly, that is, some sect1s became sects etc.
222 + Several sections that were redundant, crufty or simply not designed
223 with any sort of vision, were rearranged according to the formula that
224 everything should be either in the same place or properly interlinked.
225 Some things remained split up between different chapters when they
226 talked about different aspects of files: their content, their syntax,
227 and their placement in the file system. In particular, see the new
228 sections about changelog files.
229 - Added Games/Simulation and Apps/Education to menu sub-policy
231 - Debian changelogs should be UTF-8 encoded. [C.2.2]
232 - shared libraries must be linked against all libraries that they
233 use symbols from in the same way that binaries are. [10.2]
234 - build-depends-indep need not be satisfied during clean
239 - packages providing the x-terminal-emulator virtual package
240 ought to ensure that they interpret the command line exactly
241 like xterm does. [11.8.3]
242 - Window managers compliant with the Window Manager Specification
243 Project may add 40 points for ranking in the alternatives [11.8.4]
247 - The section describing the Description: package field once again has
248 full details of the long description format. [3.4.2]
249 - Clarified that if a package has non-build-essential
250 build-dependencies, it should have them listed in the Build-Depends
251 and related fields (i.e. it's not merely optional). [4.2]
252 - When asked to restart a service that isn't already running,
253 the init script should start the service. [9.3.2]
254 - If the purpose of a package is to provide examples, then the
255 example files can be installed into <tt>/usr/share/doc/package</tt>
256 (rather than <tt>/usr/share/doc/package/examples</tt>). [12.6]
260 - It is no longer necessary to keep a log of changes to the upstream
261 sources in the copyright file. Instead, all such changes should be
262 documented in the changelog file. [12.7]
263 - <tt>Build-Depends</tt>, <tt>Build-Conflicts</tt>,
264 <tt>Build-Depends-Indep</tt>, and
265 <tt>Build-Conflicts-Indep</tt> must also be satisfied when the
266 clean target is called. [7.6]
267 - A new Apps/Science menu section is available [menu policy]
268 - debconf specification cleared up, various changes. [debconf
270 - It is no longer recommended to create symlinks from nonexistent
271 manual pages to undocumented(7). Missing manual pages for programs
272 are still a bug. [12.1]
276 - Packages no longer have to ask permission to call MAKEDEV in
277 postinst, merely notifying the user ought to be enough. [10.6]
278 - cryptographic software may now be included in the main
280 - task packages are no longer permitted; tasks are now created by a
281 special Tasks: field in the control file. [3.9]
282 - window managers that support netwm can now add 20 points when
283 they add themselves as an alternative for
284 /usr/bin/x-window-manager [11.8.4]
285 - The default compilation options have now changed, one should
286 provide debugging symbols in all cases, and optionally step
287 back optimization to -O0, depending on the DEB_BUILD_OPTIONS
288 environment variable. [10.1]
289 - Added mention of build-arch, build-indep, etc, in describing
290 the relationships with `Build-Depends', `Build-Conflicts',
291 `Build-Depends-Indep', and `Build-Conflicts-Indep'. May need to
292 review the new rules. [7.6, 4.8]
293 - Changed rules on how, and when, to invoke ldconfig in maintainer
294 scripts. Long rationale. [8]
295 - [Added the last note in 3.5.6 upgrading checklist item regarding
296 build rules, please see below]
300 - Emacs and TeX are no longer mandated by policy to be priority
301 standard packages [2.5]
302 - Programs that access docs need to do so via /usr/share/doc, and
303 not via /usr/doc/ as was the policy previously [11.5]
304 - Putting documentation in /usr/doc versus /usr/share/doc is now
305 a ``serious'' policy violation. [12.3]
306 - For web servers, one should not provide non-local access to the
307 /usr/share/doc hierarchy. If one can't provide access controls for
308 the http://localhost/doc/ directory, then it is preferred that one
309 ask permission to expose that information during the install. [11.5]
310 - There are new rules for build-indep/build-arch targets and
311 there is a new Build-Depend-Indep semantic. [7]
315 - Manpages should not rely on header information to have
316 alternative manpage names available; it should only use
317 symlinks or .so pages to do this [12.1]
318 - [Clarified note in 3.5.3.0 upgrading checklist regarding
319 examples and templates: this refers only to those examples used
320 by scripts; see section 10.7.3 for the whole story]
321 - Included a new section 10.9.1 describing the use of
322 dpkg-statoverride; this does not have the weight of policy
323 - Clarify Standards-Version: you don't need to rebuild your
324 packages just to change the Standards-Version!
325 - Plugins are no longer bound by all the rules of shared
327 - X Windows related things:
328 * Clarification of priority levels of X Window System related
330 * Rules for defining x-terminal-emulator improved [11.8.3]
331 * X Font policy rewritten: you must read this if you provide
332 fonts for the X Window System [11.8.5]
333 * Packages must not ship /usr/X11R6/lib/X11/app-defaults/ [11.8.6]
334 * X-related packages should usually use the regular FHS
335 locations; imake-using packages are exempted from this [11.8.7]
336 * OpenMotif linked binaries have the same rules as
337 OSF/Motif-linked ones [11.8.8]
341 - The system-wide mail directory is now /var/mail, no longer
342 /var/spool/mail. Any packages accessing the mail spool should
343 access it via /var/mail and include a suitable Depends field;
345 - The perl policy is now part of Debian policy proper. Perl
346 programs and modules should follow the current Perl policy
351 - Build-Depends arch syntax has been changed to be less
352 ambiguous. This should not affect any current packages [7.1]
353 - Examples and templates files for use by scripts should now live
354 in /usr/share/<package> or /usr/lib/<package>, with
355 symbolic links from /usr/share/doc/<package>/examples as
360 - X app-defaults directory has moved from
361 /usr/X11R6/lib/X11/app-defaults to /etc/X11/app-defaults [11.8.6]
365 - dpkg-shlibdeps now uses objdump, so shared libraries have to be
366 run through dpkg-shlibdeps as well as executables [8.1]
370 - Font packages for the X Window System must now declare a
371 dependency on xutils (>= 4.0.2) [11.8.5]
375 - Daemon startup scripts in /etc/init.d/ should not contain
376 modifiable parameters; these should be moved to a file in
377 /etc/default/; see [9.3.2] for details
378 - Files in /usr/share/doc must not be referenced by any
379 program. If such files are needed, they must be placed in
380 /usr/share/<package>/, and symbolic links created as required
381 in /usr/share/doc/<package>/ [12.3]
382 - Much of the packaging manual has now been imported into the
387 - A package of priority standard or higher may provide two
388 binaries, one compiled with support for the X Window System,
389 and the other without [11.8.1]
393 - By default executables should not be built with the debugging
394 option -g. Instead, it is recommended to support building the
395 package with debugging information optionally. Details in [10.1]
396 - Policy for packages where the upstream uses HTML changelog
397 files has been expanded. In short, a plain text changelog file
398 should always be generated for the upstream changes [12.8]
399 - Please note that the new release of the X window system (3.2)
400 shall probably need sweeping changes in policy
401 - Policy for packages providing the following X-based features
403 - X server (virtual package xserver) [11.8.2]
404 - X terminal emulator (virtual package x-terminal-emulator) [11.8.3]
405 - X window manager (virtual package x-window-manager, and
406 /usr/bin/x-window-manager alternative, with priority
407 calculation guidelines) [11.8.4]
408 - X fonts (this section has been written from scratch) [12.8.5]
409 - X application defaults [11.8.6]
410 - Policy for packages using the X Window System and FHS issues
411 has been clarified; see [11.8.7]
412 - No package may contain or make hard links to conffiles [11.7.3]
413 - Noted that newer dpkg versions do not require extreme care in
414 always creating the shared lib before the symlink, so the unpack
419 - Correction to semantics of architecture lists in Build-Depends
420 etc. Should not affect many packages [7.1]
424 - /usr/doc/<package> has to be a symlink pointing to
425 /usr/share/doc/<package>, to be maintained by postinst
426 and prerm scripts. Details are in [defunct]
427 - Introduced source dependencies (Build-Depends, etc.) [7.1, 7.6]
428 - /etc/rc.boot has been deprecated in favour of /etc/rcS.d.
429 (Packages should not be touching this directory, but should use
430 update-rc.d instead) [9.3.4]
431 - update-rc.d is now the *only* allowable way of accessing the
432 /etc/rc?.d/[SK]??* links. Any scripts which manipulate them
433 directly must be changed to use update-rc.d instead. (This is
434 because the file-rc package handles this information in an
435 incompatible way.) [9.3.3]
436 - Architecture-specific examples go in /usr/lib/<package>/examples
437 with symlinks from /usr/share/doc/<package>/examples/* or from
438 /usr/share/doc/<package>/examples itself [12.7]
439 - Updated FHS to a 2.1 draft; this reverts /var/state to
441 - Added MIME sub-policy document [9.7; mime-policy]
442 - VISUAL is allowed as a (higher priority) alternative to EDITOR [12.4]
443 - Modified liblockfile description, which affects
444 mailbox-accessing programs. Please see the policy document for
446 - If a package provides a changelog in HTML format, a text-only
447 version should also be included. (Such a version may be prepared
448 using lynx -dump -nolist.) [12.7]
449 - Description of how to handle version numbers based on dates
454 - Added the clarification that the .la files are essential for the
455 packages using libtool's libltdl library, in which case the
456 .la files must go in the run-time library package [10.2]
460 - Debian formally moves from the FSSTND to the FHS. This is a
461 major change, and the implications of this move are probably
463 - Only 3 digits of the Standards version need be included in
464 control files, though all four digits are still permitted. [4.1]
465 - The location of the GPL has changed to
466 /usr/share/common-licenses. This may require changing the
467 copyright files to point to the correct location of the GPL and
468 other major licenses [12.6]
469 - Packages that use libtool to create shared libraries must
470 include the .la files in the -dev packages [10.2]
471 - Use logrotate to rotate log files [10.8]
472 - section 5.8 has been rewritten (Programs for the X Window
474 - There is now an associated menu policy, in a separate document,
475 that carries the full weight of Debian policy [9.6; menu-policy]
476 - Programs which need to modify the files /var/run/utmp,
477 /var/log/wtmp and /var/log/lastlog must be installed setgid utmp [11.3]
480 ** Please note that section numbers below this point may not be up to date **
486 - Rearranged the manual to create a new Section 4, Files
487 + Section 3.3 ("Files") was moved to Section 4. The Sections
488 that were Section 4 and Section 5 were moved down to become
489 Section 5 and Section 6.
490 + What was Section 5.5 ("Log files") is now a subsection of the
491 new Section 4 ("Files"), becoming section 4.8, placed after
492 "Configuration files", moving the Section 4.8 ("Permissions
493 and owners") to Section 4.9. All subsections of the old
494 Section 5 after 5.5 were moved down to fill in the number
496 - Modified the section about changelog files to accommodate
497 upstream changelogs which were formatted as HTML/ These
498 upstream changelog files should now be accessible as
499 /usr/doc/package/changelog.html.gz
500 + Symlinks are permissible to link the real, or upstream,
501 changelog name to the Debian mandated name.
502 - Clarified that HTML documentation should be present in some
503 package, though not necessarily the main binary package.
504 - Corrected all references to the location of the copyright
505 files. The correct location is /usr/doc/package/copyright
506 - Ratified the architecture specification strings to cater to the
512 - Updated section 3.3.5 Symbolic links:
513 + symbolic links within a toplevel directory should be relative,
514 symbolic links between toplevel directories should be absolute
515 (cf., Policy Weekly Issue#6, topic 2)
517 - Updated section 4.9 Games:
518 + manpages for games should be installed in /usr/man/man6
519 (cf., Policy Weekly Issue#6, topic 3)
522 - Updated prefix of chapter 12, Shared Libraries:
523 ldconfig must be called in the postinst script if the package
524 installs shared libraries
525 (cf., Policy Weekly Issue #6, fixes:bug#20515)
529 - Updated section 3.3.4 Scripts:
530 + /bin/sh may be any POSIX compatible shell
531 + scripts including bashisms have to specify /bin/bash as
533 + scripts which create files in world-writable directories
534 (e.g., in /tmp) should use tempfile or mktemp for creating
537 - Updated section 3.3.5 Symbolic Links:
538 + symbolic links referencing compressed files must have the same
539 file extension as the referenced file
541 - Updated section 3.3.6 Device files:
542 + /dev/tty* serial devices should be used instead of /dev/cu*
544 - Updated section 3.4.2 Writing the scripts [in /etc/init.d]:
545 + all /etc/init.d scripts have to provide the following options:
546 start, stop, restart, force-reload
547 + the reload option is optional and must never stop and restart
550 - Updated section 3.5 Cron jobs:
551 + cron jobs that need to be executed more often than daily should
552 be installed into /etc/cron.d
554 - Updated section 3.7 Menus:
555 + removed section about how to register HTML docs to `menu'
556 (the corresponding section in 4.4, Web servers and applications,
557 has been removed in policy 2.2.0.0 already, so this one was
560 - New section 3.8 Keyboard configuration:
561 + details about how the backspace and delete keys should be
564 - New section 3.9 Environment variables:
565 + no program must depend on environment variables to get a
566 reasonable default configuration
568 - New section 4.6 News system configuration:
569 + /etc/news/organization and /etc/news/server should be supported
570 by all news servers and clients
572 - Updated section 4.7 Programs for the X Window System:
573 + programs requiring a non-free Motif library should be provided
574 as foo-smotif and foo-dmotif package
575 + if lesstif works reliably for such program, it should be linked
576 against lesstif and not against a non-free Motif library
578 - Updated section 4.9 Games:
579 + games for X Windows have to be installed in /usr/games, just as
582 2.3.0.1, 2.3.0.0 Sep 1997
584 * new section `4.2 Daemons' including rules for
585 /etc/services, /etc/protocols, /etc/rpc, and /etc/inetd.conf
587 * updated section about `Configuration files':
588 packages may not touch other packages' configuration files
590 * MUAs and MTAs have to use liblockfile
594 * added section 4.1 `Architecture specification strings':
597 where <arch> is one of the following:
598 i386, alpha, arm, m68k, powerpc, sparc.
600 * detailed rules for /usr/local
604 * editor/pager policy
610 * don't install shared libraries as executable
612 * app-defaults files may not be conffiles
614 2.1.3.2, 2.1.3.1, 2.1.3.0 Mar 1997
616 * two programs with different functionality must not have the
621 * "Standard for Console Messages"
623 * Libraries should be compiled with `-D_REENTRANT'
625 * Libraries should be stripped with "strip --strip-unneeded"
627 2.1.2.2, 2.1.2.1, 2.1.2.0 Nov 1996
629 * Some changes WRT shared libraries
633 * No hard links in source packages
635 * Do not use dpkg-divert or update-alternatives without consultation
637 * Shared libraries must be installed stripped
641 * Upstream changelog must be installed too
649 <!-- Keep this comment at the end of the file
653 sgml-live-element-indicator: t