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