Fix the long name of the Common Public License
[debian-policy.git] / upgrading-checklist.sgml
blob7ae8e13d0d5ed22f02b8ed33546a6e5c5405fbef
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 <email/rra@debian.org/ </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 id="3.9.9.0"> Version 3.9.9.0
38 <p>
40 Not Released Yet
42 </p><p><taglist>
43 <tag>3.4</tag>
44 <item> Require to update autotools at build time.
45 </item>
46 <tag>5.6.12</tag>
47 <item> Forbid colons in package version numbers.
48 </item>
49 <tag>12.5</tag>
50 <item> Add the Mozilla Public Licenses to <file>/usr/share/common-licenses</file>;
51 so that they can be referred to rather than quoted in Copyright files.</item>
52 </taglist></p>
54 <sect id="3.9.8.0"> Version 3.9.8.0
55 <p>
57 Released February, 2016.
59 </p><p><taglist>
60 <tag>9.6</tag>
61 <item> The menu system is deprecated in favor of the Free Desktop menu standard.
62 </item>
63 </taglist>
64 </p>
66 <sect id="3.9.7.0"> Version 3.9.7.0
67 <p>
69 Released February, 2016.
71 </p><p><taglist>
72 <tag>10.5</tag>
73 <item> Symbolic links must not traverse above the root directory.
74 </item>
75 <tag>9.2.2</tag>
76 <item> 32bit UIDs in the range 65536-4294967293 are reserved for dynamically
77 allocated user accounts.
78 </item>
79 <tag>5.1</tag>
80 <item> Empty field values in control files are only permitted in the
81 <file>debian/control</file> file of a source package.
82 </item>
83 <tag>4.9</tag>
84 <item> <file>debian/rules</file>: required targets must not attempt
85 network access.
86 </item>
87 <tag>12.3</tag>
88 <item> recommend to ship additional documentation for package
89 <prgn>pkg</prgn> in a separate package <prgn>pkg-doc</prgn> and install it
90 into <file>/usr/share/doc/pkg</file>.
91 </item>
92 </taglist></p>
94 <sect id="3.9.6.0"> Version 3.9.6.0
95 <p>
97 Released September, 2014.
99 </p><p><taglist>
100 <tag>9.1</tag>
101 <item> The FHS is relaxed to allow a subdirectory of <file>/usr/lib</file>
102 to hold a mixture of architecture-independent and architecture-dependent
103 files, though directories entirely composed of architecture-independent files
104 should be located in <file>/usr/share</file>.
105 </item>
106 <tag>9.1</tag>
107 <item>The FHS requirement for <file>/usr/local/lib64</file> to exist
108 if <file>/lib64</file> or <file>/usr/lib64</file> exists is removed.
109 </item>
110 <tag>9.1</tag>
111 <item> An FHS exception has been granted for multiarch include files,
112 permitting header files to instead be installed to
113 <file>/usr/include/triplet</file>.
114 </item>
115 <tag>10.1</tag>
116 <item> Binaries must not be statically linked with the GNU C library,
117 see policy for exceptions.
118 </item>
119 <tag>4.4</tag>
120 <item> It is clarified that signature appearing in debian/changelog should be
121 the details of the person who prepared this release of the package.
122 </item>
123 <tag>11.5</tag>
124 <item> The default web document root is now <file>/var/www/html</file>
125 </item>
126 <tag>virtual</tag>
127 <item><tt>java1-runtime</tt> and <tt>java2-runtime</tt> are removed,
128 <tt>javaN-runtime</tt> and <tt>javaN-runtime-headless</tt> are added
129 for all N between 5 and 9.
130 </item>
131 <tag>virtual</tag>
132 <item>Added <tt>httpd-wsgi</tt> for WSGI capable HTTP servers.
133 </item>
134 <tag>perl</tag>
135 <item> Perl packages should use the <tt>%Config</tt> hash to locate module
136 paths instead of hardcoding paths in <tt>@INC</tt>.
137 </item>
138 <tag>perl</tag>
139 <item> Perl binary modules and any modules installed into
140 <tt>$Config{vendorarch}</tt> must depend on the relevant
141 <package>perlapi-*</package> package.
142 </item> </taglist></p>
144 <sect id="3.9.5.0"> Version 3.9.5.0
147 Released October, 2013.
149 </p><p><taglist>
150 <tag>5.1</tag>
151 <item>Control data fields must not start with the hyphen character
152 (<tt>-</tt>), to avoid potential confusions when parsing clearsigned control
153 data files that were not properly unescaped.
154 </item>
155 <tag>5.4, 5.6.24</tag>
156 <item><tt>Checksums-Sha1</tt> and <tt>Checksums-Sha256</tt> are now
157 mandatory in <file>.dsc</file> files.
158 </item>
159 <tag>5.6.25, 5.8.1</tag>
160 <item>The <tt>DM-Upload-Allowed</tt> field is obsolete. Permissions
161 are now granted via <em>dak-commands</em> files.
162 <tag>5.6.27</tag>
163 <item>New section documenting the <tt>Package-List</tt> field in Debian
164 source control files.
165 </item>
166 <tag>5.6.28</tag>
167 <item>New section documenting the <tt>Package-Type</tt> field in source
168 package control files.
169 </item>
170 <tag>5.6.29</tag>
171 <item>New section documenting the <tt>Dgit</tt> field in Debian
172 source control files.
173 </item>
174 <tag>9.1.1.8</tag>
175 <item>The exception to the FHS for the <file>/selinux</file> was removed.
176 </item>
177 <tag>10.7.3</tag>
178 <item>Packages should remove all obsolete configuration files without
179 local changes during upgrades. The <prgn>dpkg-maintscript-helper</prgn>
180 tool, available from the <package>dpkg</package> package since
181 <em>Wheezy</em>, can help with this.
182 </item>
183 <tag>10.10</tag>
184 <item>The name of the files and directories installed by binary packages
185 must be encoded in UTF-8 and should be restricted to ASCII when possible.
186 In the system PATH, they must be restricted to ASCII.
187 </item>
188 <tag>11.5.2</tag>
189 <item>Stop recommending to serve HTML documents from
190 <file>/usr/share/doc/<var>package</var></file>.
191 </item>
192 <tag>12.2</tag>
193 <item>Packages distributing Info documents should use
194 <package>install-info</package>'s trigger, and do not need anymore
195 to depend on <tt>dpkg (>= 1.15.4) | install-info</tt>.
196 </item>
197 <tag>debconf</tag>
198 <item>The <tt>escape</tt> capability is now documented.
199 </item>
200 <tag>virtual</tag>
201 <item><tt>mp3-decoder</tt> and <tt>mp3-encoder</tt> are removed.</item>
202 </taglist></p>
204 <sect id="3.9.4.0"> Version 3.9.4.0
207 Released August, 2012.
209 </p><p><taglist>
210 <tag>2.4</tag>
211 <item>New <em>tasks</em> archive section.
212 </item>
213 <tag>4.9</tag>
214 <item><tt>build-arch</tt> and <tt>build-indep</tt> are now mandatory
215 targets in <file>debian/rules</file>.
216 </item>
217 <tag>5.6.26</tag>
218 <item>New section documenting the <tt>Vcs-*</tt> fields, which are
219 already in widespread use. Note the mechanism for specifying the Git
220 branch used for packaging in the Vcs-Git field.
221 </item>
222 <tag>7.1</tag>
223 <item>The deprecated relations &lt; and &gt; now must not be used.
224 </item>
225 <tag>7.8</tag>
226 <item>New <tt>Built-Using</tt> field, which must be used to document the
227 source packages for any binaries that are incorporated into this package
228 at build time. This is used to ensure that the archive meets license
229 requirements for providing source for all binaries.
230 </item>
231 <tag>8.6</tag>
232 <item>Policy for dependencies between shared libraries and other
233 packages has been largely rewritten to document the <tt>symbols</tt>
234 system and more clearly document handling of shared library ABI
235 changes. <file>symbols</file> files are now recommended
236 over <file>shlibs</file> files in most situations. All maintainers of
237 shared library packages should review the entirety of this section.
238 </item>
239 <tag>9.1.1</tag>
240 <item>Packages must not assume the <file>/run</file> directory exists or
241 is usable without a dependency on <tt>initscripts (>= 2.88dsf-13.3)</tt>
242 until the stable release of Debian supports <file>/run</file>.
243 </item>
244 <tag>9.7</tag>
245 <item>Packages including MIME configuration can now rely on triggers and
246 do not need to call update-mime.</item>
247 <tag>9.11</tag>
248 <item>New section documenting general requirements for alternate init
249 systems and specific requirements for integrating with upstart.
250 </item>
251 <tag>12.5</tag>
252 <item>All copyright files must be encoded in UTF-8.
253 </item>
254 </taglist></p>
256 <sect id="3.9.3.0"> Version 3.9.3.0
259 Released February, 2012.
261 </p><p><taglist>
262 <tag>2.4</tag>
263 <item>New archive sections <em>education</em>, <em>introspection</em>,
264 and <em>metapackages</em> added.
265 </item>
266 <tag>5.6.8</tag>
267 <item>The <tt>Architecture</tt> field in <file>*.dsc</file> files may
268 now contain the value <tt>any all</tt> for source packages building both
269 architecture-independent and architecture-dependent packages.
270 </item>
271 <tag>7.1</tag>
272 <item>If a dependency is restricted to particular architectures, the
273 list of architectures must be non-empty.
274 </item>
275 <tag>9.1.1</tag>
276 <item><file>/run</file> is allowed as an exception to the FHS and
277 replaces <file>/var/run</file>. <file>/run/lock</file>
278 replaces <file>/var/lock</file>. The FHS requirements for the older
279 directories apply to these directories as well. Backward compatibility
280 links will be maintained and packages need not switch to
281 referencing <file>/run</file> directly yet. Files in <file>/run</file>
282 should be stored in a temporary file system.
283 </item>
284 <tag>9.1.4</tag>
285 <item>New section spelling out the requirements for packages that use
286 files in <file>/run</file>, <file>/var/run</file>,
287 or <file>/var/lock</file>. This generalizes information previously only
288 in 9.3.2.
289 </item>
290 <tag>9.5</tag>
291 <item>Cron job file names must not contain <tt>.</tt> or <tt>+</tt> or
292 they will be ignored by cron. They should replace those characters
293 with <tt>_</tt>. If a package provides multiple cron job files in the
294 same directory, they should each start with the package name (possibly
295 modified as above), <tt>-</tt>, and then some suitable suffix.
296 </item>
297 <tag>9.10</tag>
298 <item>Packages using doc-base do not need to call install-docs anymore.
299 </item>
300 <tag>10.7.4</tag>
301 <item>Packages that declare the same <tt>conffile</tt> may see left-over
302 configuration files from each other even if they conflict.
303 </item>
304 <tag>11.8</tag>
305 <item>The Policy rules around Motif libraries were just a special case
306 of normal rules for non-free dependencies and were largely obsolete, so
307 they have been removed.
308 </item>
309 <tag>12.5</tag>
310 <item><file>debian/copyright</file> is no longer required to list the
311 Debian maintainers involved in the creation of the package (although
312 note that the requirement to list copyright information is unchanged).
313 </item>
314 <tag>copyright-format</tag>
315 <item>Version 1.0 of the "Machine-readable <file>debian/copyright</file>
316 file" specification is included.
317 </item>
318 <tag>mime</tag>
319 <item>This separate document has been retired and and its (short)
320 contents merged into Policy section 9.7. There are no changes to the
321 requirements.
322 </item>
323 <tag>perl</tag>
324 <item>Packages may declare an interest in the <var>perl-major-upgrade</var>
325 trigger to be notified of major upgrades of perl.
326 </item>
327 <tag>virtual</tag>
328 <item><tt>ttf-japanese-{mincho, gothic}</tt> is renamed to
329 <tt>fonts-japanese-{mincho, gothic}</tt>.
330 </item>
331 </taglist></p>
333 <sect id="3.9.2.0"> Version 3.9.2.0
336 Released April, 2011.
338 </p><p><taglist>
339 <tag>*</tag>
340 <item>Multiple clarifications throughout Policy where "installed" was
341 used and the more precise terms "unpacked" or "configured" were
342 intended.
343 </item>
344 <tag>3.3</tag>
345 <item>The maintainer address must accept mail from Debian role accounts
346 and the BTS. At least one human must be listed with their personal
347 email address in <tt>Uploaders</tt> if the maintainer is a shared email
348 address. The duties of a maintainer are also clearer.
349 </item>
350 <tag>5</tag>
351 <item>All control fields are now classified as simple, folded, or
352 multiline, which governs whether their values must be a single line or
353 may be continued across multiple lines and whether line breaks are
354 significant.
355 </item>
356 <tag>5.1</tag>
357 <item>Parsers are allowed to accept paragraph separation lines
358 containing whitespace, but control files should use completely empty
359 lines. Ordering of paragraphs is significant. Field names must be
360 composed of printable ASCII characters except colon and must not begin
361 with #.
362 </item>
363 <tag>5.6.25</tag>
364 <item>The <tt>DM-Upload-Allowed</tt> field is now documented.
365 </item>
366 <tag>6.5</tag>
367 <item>The system state maintainer scripts can rely upon during each
368 possible invocation is now documented. In several less-common cases,
369 this is stricter than Policy had previously documented. Packages with
370 complex maintainer scripts should be reviewed in light of this new
371 documentation.
372 </item>
373 <tag>7.2</tag>
374 <item>The impact on system state when maintainer scripts that are part
375 of a circular dependency are run is now documented. Circular
376 dependencies are now a should not.
377 </item>
378 <tag>7.2</tag>
379 <item>The system state when <prgn>postinst</prgn> and <prgn>prerm</prgn>
380 scripts are run is now documented, and the documentation of the special
381 case of dependency state for <prgn>postrm</prgn> scripts has been
382 improved. <prgn>postrm</prgn> scripts are required to gracefully skip
383 actions if their dependencies are not available.
384 </item>
385 <tag>9.1.1</tag>
386 <item>GNU/Hurd systems are allowed <file>/hurd</file>
387 and <file>/servers</file> directories in the root filesystem.
388 </item>
389 <tag>9.1.1</tag>
390 <item>Packages installing to architecture-specific subdirectories of
391 <file>/usr/lib</file> must use the value returned by
392 <prgn>dpkg-architecture -qDEB_HOST_MULTIARCH</prgn>, not by
393 <prgn>dpkg-architecture -qDEB_HOST_GNU_TYPE</prgn>; this is a path change
394 on i386 architectures and a no-op for other architectures.
395 </item>
396 <tag>virtual</tag>
397 <item><tt>mailx</tt> is now a virtual package provided by packages that
398 install <prgn>/usr/bin/mailx</prgn> and implement at least the
399 POSIX-required interface.
400 </item>
401 </taglist></p>
403 <sect id="3.9.1.0"> Version 3.9.1.0
406 Released July, 2010.
408 </p><p><taglist>
409 <tag>3.2.1</tag>
410 <item>Date-based version components should be given as the four-digit
411 year, two-digit month, and then two-digit day, but may have embedded
412 punctuation.
413 </item>
414 <tag>3.9</tag>
415 <item>Maintainer scripts must pass <tt>--package</tt>
416 to <prgn>dpkg-divert</prgn> when creating or removing diversions and
417 must not use <tt>--local</tt>.
418 </item>
419 <tag>4.10</tag>
420 <item>Only <prgn>dpkg-gencontrol</prgn> supports variable substitution.
421 <prgn>dpkg-genchanges</prgn> (for <file>*.changes</file>)
422 and <prgn>dpkg-source</prgn> (for <file>*.dsc</file>) do not.
423 </item>
424 <tag>7.1</tag>
425 <item>Architecture restrictions and wildcards are also allowed in binary
426 package relationships provided that the binary package is not
427 architecture-independent.
428 </item>
429 <tag>7.4</tag>
430 <item><tt>Conflicts</tt> and <tt>Breaks</tt> should only be used when
431 there are file conflicts or one package breaks the other, not just
432 because two packages provide similar functionality but don't interfere.
433 </item>
434 <tag>8.1</tag>
435 <item>The SONAME of a library should change whenever the ABI of the
436 library changes in a way that isn't backward-compatible. It should not
437 change if the library ABI changes are backward-compatible. Discourage
438 bundling shared libraries together in one package.
439 </item>
440 <tag>8.4</tag>
441 <item>Ada Library Information (<file>*.ali</file>) files must be
442 installed read-only.
443 </item>
444 <tag>8.6.1, 8.6.2, 8.6.5</tag>
445 <item>Packages should normally not include a <file>shlibs.local</file>
446 file since we now have complete <file>shlibs</file> coverage.
447 </item>
448 <tag>8.6.3</tag>
449 <item>The SONAME of a library may instead be of the
450 form <tt><var>name</var>-<var>major-version</var>.so</tt>.
451 </item>
452 <tag>10.2</tag>
453 <item>Libtool <file>.la</file> files should not be installed for public
454 libraries. If they're required (for <tt>libltdl</tt>, for instance),
455 the <tt>dependency_libs</tt> setting should be emptied. Library
456 packages historically including <file>.la</file> files must continue to
457 include them (with <tt>dependency_libs</tt> emptied) until all libraries
458 that depend on that library have removed or emptied
459 their <file>.la</file> files.
460 </item>
461 <tag>10.2</tag>
462 <item>Libraries no longer need to be built with <tt>-D_REENTRANT</tt>,
463 which was an obsolete LinuxThreads requirement. Instead, say explicitly
464 that libraries should be built with threading support and to be
465 thread-safe if the library supports this.
466 </item>
467 <tag>10.4</tag>
468 <item><file>/bin/sh</file> scripts may assume that <prgn>kill</prgn>
469 supports an argument of <tt>-<var>signal</var></tt>,
470 that <prgn>kill</prgn> and <prgn>trap</prgn> support the numeric signals
471 listed in the XSI extension, and that signal 13 (SIGPIPE) can be trapped
472 with <prgn>trap</prgn>.
473 </item>
474 <tag>10.8</tag>
475 <item>Use of <file>/etc/logrotate.d/<var>package</var></file> for
476 logrotate rules is now recommended.
477 </item>
478 <tag>10.9</tag>
479 <item>Control information files should be owned by <tt>root:root</tt>
480 and either mode 644 or mode 755.
481 </item>
482 <tag>11.4, 11.8.3, 11.8.4</tag>
483 <item>Packages providing alternatives for <prgn>editor</prgn>,
484 <prgn>pager</prgn>, <prgn>x-terminal-emulator</prgn>, or
485 <prgn>x-window-manager</prgn> should also provide a slave alternative
486 for the corresponding manual page.
487 </item>
488 <tag>11.5</tag>
489 <item>Cgi-bin executable files may be installed in subdirectories
490 of <file>/usr/lib/cgi-bin</file> and web servers should serve out
491 executables in those subdirectories.
492 </item>
493 <tag>12.5</tag>
494 <item>The GPL version 1 is now included in common-licenses and should be
495 referenced from there instead of included in the <file>copyright</file>
496 file.
497 </item>
498 </taglist></p>
500 <sect id="3.9.0.0"> Version 3.9.0.0
503 Released June, 2010.
505 </p><p><taglist>
506 <tag>4.4, 5.6.15</tag>
507 <item>The required format for the date in a changelog entry and in the
508 Date control field is now precisely specified.
509 </item>
510 <tag>5.1</tag>
511 <item>A control paragraph must not contain more than one instance of a
512 particular field name.
513 </item>
514 <tag>5.4, 5.5, 5.6.24</tag>
515 <item>The <tt>Checksums-Sha1</tt> and <tt>Checksums-Sha256</tt> fields
516 in <file>*.dsc</file> and <file>*.changes</file> files are now
517 documented and recommended.
518 </item>
519 <tag>5.5, 5.6.16</tag>
520 <item>The <tt>Format</tt> field of <file>.changes</file> files is now
521 1.8. The <tt>Format</tt> field syntax for source
522 package <file>.dsc</file> files allows a subtype in parentheses, and it
523 is used for a different purpose than the <tt>Format</tt> field
524 for <file>.changes</file> files.
525 </item>
526 <tag>5.6.2</tag>
527 <item>The syntax of the <tt>Maintainer</tt> field is now must rather
528 than should.
529 </item>
530 <tag>5.6.3</tag>
531 <item>The comma separating entries in <tt>Uploaders</tt> is now must
532 rather than should.
533 </item>
534 <tag>5.6.8, 7.1, 11.1.1</tag>
535 <item>Architecture wildcards may be used in addition to specific
536 architectures in <file>debian/control</file> and <file>*.dsc</file>
537 Architecture fields, and in architecture restrictions in build
538 relationships.
539 </item>
540 <tag>6.3</tag>
541 <item>Maintainer scripts are no longer guaranteed to run with a
542 controlling terminal and must be able to fall back to noninteractive
543 behavior (debconf handles this). Maintainer scripts may abort if there
544 is no controlling terminal and no reasonable default for a high-priority
545 question, but should avoid this if possible.
546 </item>
547 <tag>7.3, 7.6.1</tag>
548 <item><tt>Breaks</tt> should be used with <tt>Replaces</tt> for moving
549 files between packages.
550 </item>
551 <tag>7.4</tag>
552 <item><tt>Breaks</tt> should normally be used instead
553 of <tt>Conflicts</tt> for transient issues and moving files between
554 packages. New documentation of when each should be used.
555 </item>
556 <tag>7.5</tag>
557 <item>Use <tt>Conflicts</tt> with <tt>Provides</tt> if only one provider
558 of a virtual facility can be installed at a time.
559 </item>
560 <tag>8.4</tag>
561 <item>All shared library development files are no longer required to be
562 in the <tt>-dev</tt> package, only be available when the <tt>-dev</tt>
563 package is installed. This allows the <tt>-dev</tt> package to be split
564 as long as it depends on the additional packages.
565 </item>
566 <tag>9.2.2</tag>
567 <item>The UID range of user accounts is extended to 1000-59999.
568 </item>
569 <tag>9.3.2, 10.4</tag>
570 <item><file>init.d</file> scripts are a possible exception from the
571 normal requirement to use <tt>set -e</tt> in each shell script.
572 </item>
573 <tag>12.5</tag>
574 <item>The UCB BSD license was removed from the list of licenses that
575 should be referenced from <file>/usr/share/common-licenses/BSD</file>.
576 It should instead be included directly
577 in <file>debian/copyright</file>, although it will still be in
578 common-licenses for the time being.
579 </item>
580 <tag>debconf</tag>
581 <item><tt>SETTITLE</tt> is now documented (it has been supported for
582 some time). <tt>SETTITLE</tt> is like <tt>TITLE</tt> but takes a
583 template instead of a string to allow translation.
584 </item>
585 <tag>perl</tag>
586 <item><package>perl-base</package> now
587 provides <package>perlapi-<var>abiname</var></package> instead of a
588 package based solely on the Perl version. Perl packages must now depend
589 on <package>perlapi-$Config{debian_abi}</package>, falling back
590 on <tt>$Config{version}</tt> if <tt>$Config{debian_abi}</tt> is not set.
591 </item>
592 <tag>perl</tag>
593 <item>Packages using <file>Makefile.PL</file> should use
594 <tt>DESTDIR</tt> rather than <tt>PREFIX</tt> to install into the package
595 staging area. <tt>PREFIX</tt> only worked due to a Debian-local patch.
596 </item>
597 </taglist></p>
599 <sect id="3.8.4.0"> Version 3.8.4.0
602 Release Jan 2010.
604 </p><p><taglist>
605 <tag>9.1.1</tag>
606 <item> An FHS exception has been granted for multiarch libraries.
607 Permitting files to instead be installed to <file>/lib/triplet</file> and
608 <file>/usr/lib/triplet</file> directories.
609 </item>
610 <tag>10.6</tag>
611 <item>Packages may not contain named pipes and should instead create
612 them in postinst and remove them in prerm or postrm.
613 </item>
614 <tag>9.1.1</tag>
615 <item><file>/sys</file> and <file>/selinux</file> directories are explicitly
616 allowed as an exception to the FHS.
617 </item>
618 </taglist></p>
620 <sect id="3.8.3.0"> Version 3.8.3.0
622 Released Aug 2009.
624 </p><p><taglist>
625 <tag>4.9</tag>
626 <item>DEB_*_ARCH_CPU and DEB_*_ARCH_OS variables are now documented and
627 recommended over GNU-style variables for that information.
628 </item>
629 <tag>5.6.8</tag>
630 <item>Source package Architecture fields may contain <em/all/ in
631 combination with other architectures. Clarify when <em/all/ and <em/any/
632 may be used in different versions of the field.
633 </item>
634 <tag>5.6.14</tag>
635 <item>The Debian archive software does not support uploading
636 to multiple distributions with one <file>*.changes</file> file.
637 </item>
638 <tag>5.6.19</tag>
639 <item>The Binary field may span multiple lines.
640 </item>
641 <tag>10.2</tag>
642 <item>Shared library packages are no longer allowed to install libraries
643 in a non-standard location and modify <file/ld.so.conf/. Packages
644 should either be installed in a standard library directory or packages
645 using them should be built with RPATH.
646 </item>
647 <tag>11.8.7</tag>
648 <item>Installation directories for X programs have been clarified.
649 Packages are no longer required to pre-depend on x11-common before
650 installing into <file>/usr/include/X11</file>
651 and <file>/usr/lib/X11</file>.
652 </item>
653 <tag>12.1</tag>
654 <item>Manual pages are no longer required to contain only characters
655 representable in the legacy encoding for that language.
656 </item>
657 <tag>12.1</tag>
658 <item>Localized man pages should either be kept up-to-date with
659 the original version or warn that they're not up-to-date, either
660 with warning text or by showing missing or changed portions in the
661 original language.
662 </item>
663 <tag>12.2</tag>
664 <item>install-info is now handled via triggers so packages no
665 longer need to invoke it in maintainer scripts. Info documents
666 should now have directory sections and entries in the document.
667 Packages containing info documents should add a dependency to
668 support partial upgrades.
669 </item>
670 <tag>perl</tag>
671 <item>The requirement for Perl modules to have a versioned
672 Depend and Build-Depend on <tt>perl &gt;= 5.6.0-16</tt> has been removed.
673 </item>
674 </taglist></p>
676 <sect id="3.8.2.0"> Version 3.8.2.0
679 Released Jun 2009.
681 </p><p><taglist>
682 <tag>2.4</tag>
683 <item>The list of archive sections has been significantly expanded. See
684 <url id="http://lists.debian.org/debian-devel-announce/2009/03/msg00010.html"
685 name="this debian-devel-announce message">
686 for the list of new sections and rules for how to categorize
687 packages.
688 </item>
689 <tag>3.9.1</tag>
690 <item>All packages must use debconf or equivalent for user prompting,
691 though essential packages or their dependencies may also fall
692 back on other methods.
693 </item>
694 <tag>5.6.1</tag>
695 <item>The requirements for source package names are now explicitly
696 spelled out.
697 </item>
698 <tag>9.1</tag>
699 <item>Legacy XFree86 servers no longer get a special exception from the
700 FHS permitting <file>/etc/X11/XF86Config-4</file>.
701 </item>
702 <tag>9.1.3</tag>
703 <item>Removed obsolete dependency requirements for packages that use
704 <file>/var/mail</file>.
705 </item>
706 <tag>11.8.5</tag>
707 <item>Speedo fonts are now deprecated. The X backend was disabled
708 starting in lenny.
709 </item>
710 <tag>12.5</tag>
711 <item>The GNU Free Documentation License version 1.3 is included in
712 common-licenses and should be referenced from there.
713 </item>
714 </taglist></p>
716 <sect id="3.8.1.0"> Version 3.8.1.0
719 Released Mar 2009.
721 </p><p><taglist>
722 <tag>3.8</tag>
723 <item>Care should be taken when adding functionality to essential and
724 such additions create an obligation to support that functionality
725 in essential forever unless significant work is done.
726 </item>
727 <tag>4.4</tag>
728 <item>Changelog files must be encoded in UTF-8.
729 </item>
730 <tag>4.4</tag>
731 <item>Some format requirements for changelog files are now "must"
732 instead of "should."
733 </item>
734 <tag>4.4.1</tag>
735 <item>Alternative changelog formats have been removed. Debian only
736 supports one changelog format for the Debian Archive.
737 </item>
738 <tag>4.9.1</tag>
739 <item>New nocheck option for DEB_BUILD_OPTIONS indicating any build-time
740 test suite provided by the package should not be run.
741 </item>
742 <tag>5.1</tag>
743 <item>All control files must be encoded in UTF-8.
744 </item>
745 <tag>5.2</tag>
746 <item><file>debian/control</file> allows comment lines starting with #
747 with no preceding whitespace.
748 </item>
749 <tag>9.3</tag>
750 <item>Init scripts ending in .sh are not handled specially. They are not
751 sourced and are not guaranteed to be run by <prgn>/bin/sh</prgn> regardless
752 of the #! line. This brings Policy in line with the long-standing
753 behavior of the init system in Debian.
754 </item>
755 <tag>9.3.2</tag>
756 <item>The start action of an init script must exit successfully and not
757 start the daemon again if it's already running.
758 </item>
759 <tag>9.3.2</tag>
760 <item><file>/var/run</file> and <file>/var/lock</file> may be mounted as
761 temporary filesystems, and init scripts must therefore create any necessary
762 subdirectories dynamically.
763 </item>
764 <tag>10.4</tag>
765 <item> <file>/bin/sh</file> scripts may assume that local can take multiple
766 variable arguments and supports assignment.
767 </item>
768 <tag>11.6</tag>
769 <item>User mailboxes may be mode 600 and owned by the user rather than
770 mode 660, owned by user, and group mail.
771 </item>
772 </taglist></p>
774 <sect id="3.8.0.0"> Version 3.8.0.0
777 Released Jun 2008.
779 </p><p><taglist>
780 <tag>2.4, 3.7</tag>
781 <item>The base section has been removed. contrib and non-free have been
782 removed from the section list; they are only categories. The base
783 system is now defined by priority.
784 <tag>4.9</tag>
785 <item>If <prgn>dpkg-source -x</prgn> doesn't provide the source that will be
786 compiled, a debian/rules patch target is recommended and should do whatever
787 else is necessary.
788 <tag>4.9.1, 10.1</tag>
789 <item>Standardized the format of DEB_BUILD_OPTIONS. Specified permitted
790 characters for tags, required that tags be whitespace-separated,
791 allowed packages to assume non-conflicting tags, and required
792 unknown flags be ignored.
793 <tag>4.9.1</tag>
794 <item>Added parallel=n to the standardized DEB_BUILD_OPTIONS tags,
795 indicating that a package should be built using up to n parallel
796 processes if the package supports it
797 <tag>4.13</tag>
798 <item>Debian packages should not use convenience copies of code from other
799 packages unless the included package is explicitly intended to be
800 used that way.
801 <tag>4.14</tag>
802 <item>If dpkg-source -x doesn't produce source ready for editing and
803 building with dpkg-buildpackage, packages should include a
804 <file>debian/README.source</file> file explaining how to generate
805 the patched source, add a new modification, and remove an existing
806 modification. This file may also be used to document packaging a
807 new upstream release and any other complexity of the Debian build
808 process.
809 <tag>5.6.3</tag>
810 <item>The Uploaders field in debian/control may be wrapped.
811 <tag>5.6.12</tag>
812 <item>An empty Debian revision is equivalent to a Debian revision of 0 in
813 a version number.
814 <tag>5.6.23</tag>
815 <item>New Homepage field for upstream web sites.
816 <tag>6.5, 6.6, 7</tag>
817 <item>The Breaks field declares that this package breaks another and
818 prevents installation of the breaking package unless the package
819 named in Breaks is deconfigured first. This field should not be
820 used until the dpkg in Debian stable supports it.
821 <tag>8.1, 8.2</tag>
822 <item>Clarify which files should go into a shared library package, into a
823 separate package, or into the -dev package. Suggest -tools instead
824 of -runtime for runtime support programs, since that naming is more
825 common in Debian.
826 <tag>9.5</tag>
827 <item>Files in <file>/etc/cron.{hourly,daily,weekly,monthly}</file> must be
828 configuration files (upgraded from should). Mention the hourly
829 directory.
830 <tag>11.8.6</tag>
831 <item>Packages providing <file>/etc/X11/Xresources</file> files need not
832 conflict with <tt> xbase (&lt;&lt; 3.3.2.3a-2)</tt>, which is
833 long-obsolete.
834 <tag>12.1</tag>
835 <item>Manual pages in locale-specific directories should use either the
836 legacy encoding for that directory or UTF-8. Country names should
837 not be included in locale-specific manual page directories unless
838 indicating a significant difference in the language. All
839 characters in the manual page source should be representable in the
840 legacy encoding for a locale even if the man page is encoded in
841 UTF-8.
842 <tag>12.5</tag>
843 <item>The Apache 2.0 license is now in common-licenses and should be
844 referenced rather than quoted in <file>debian/copyright</file>.
845 <tag>12.5</tag>
846 <item>Packages in contrib and non-free should state in the copyright file
847 that the package is not part of Debian GNU/Linux and briefly
848 explain why.
849 <tag>debconf</tag>
850 <item>Underscore (_) is allowed in debconf template names.
851 </taglist></p>
853 <sect id="3.7.3.0"> Version 3.7.3.0
856 Released Dec 2007.
858 </p><p><taglist>
859 <tag>5.6.12</tag>
860 <item>Package version numbers may contain tildes, which sort before
861 anything, even the end of a part.
862 <tag>10.4</tag>
863 <item>Scripts may assume that <file>/bin/sh</file> supports local (at a basic
864 level) and that its test builtin (if any) supports -a and -o binary
865 logical operators.
866 <tag>8.5</tag>
867 <item>The substitution variable ${binary:Version} should be used in place
868 of ${Source-Version} for dependencies between packages of the same
869 library.
870 <tag>menu policy</tag>
871 <item>Substantial reorganization and renaming of sections in the Debian
872 menu structure. Packages with menu entries should be reviewed to
873 see if the menu section has been renamed or if one of the new
874 sections would be more appropriate.
875 <tag>5.6.1</tag>
876 <item>The Source field in a .changes file may contain a version number
877 in parentheses.
878 <tag>5.6.17</tag>
879 <item>The acceptable values for the Urgency field are low, medium, high,
880 critical, or emergency.
881 <tag>8.6</tag>
882 <item>The shlibs file now allows an optional type field, indicating the
883 type of package for which the line is valid. The only currently
884 supported type is udeb, used with packages for the Debian
885 Installer.
886 <tag>3.9.1</tag>
887 <item>Packages following the Debian Configuration management
888 specification must allow for translation of their messages by using
889 a gettext-based system such as po-debconf.
890 <tag>12.5</tag>
891 <item>GFDL 1.2, GPL 3, and LGPL 3 are now in common-licenses and should
892 be referenced rather than quoted in debian/copyright.
893 </taglist></p>
895 <sect id="3.7.2.2"> Version 3.7.2.2
898 Released Oct 2006.
900 </p><p><taglist>
901 <tag>6.1</tag> <item>Maintainer scripts must not be world writeable (up from a
902 should to a must)</item>
903 </taglist></p>
905 <sect id="3.7.2.0"> Version 3.7.2.0
908 Released Apr 2006.
910 </p><p><taglist>
911 <tag>11.5</tag> <item>Revert the cgi-lib change. </item>
912 </taglist></p>
914 <sect id="3.7.1.0"> Version 3.7.1.0
917 Released Apr 2006.
919 </p><p><taglist>
920 <tag>10.2</tag>
921 <item>It is now possible to create shared libraries without
922 relocatable code (using -fPIC) in certain exceptional cases,
923 provided some procedures are followed, and for creating static
924 libraries with relocatable code (again, using -fPIC).
925 Discussion on debian-devel@lists.debian.org, getting a rough
926 consensus, and documenting it in README.Debian constitute most
927 of the process.
928 <tag>11.8.7</tag>
929 <item>Packages should install any relevant files into the directories
930 <file>/usr/include/X11/</file> and <file>/usr/lib/X11/</file>, but if
931 they do so, they must pre-depend on <tt>x11-common (&gt;= 1:7.0.0)</tt>
932 </taglist></p>
934 <sect id="3.7.0.0"> Version 3.7.0.0
937 Released Apr 2006.
939 </p><p><taglist>
940 <tag>11.5</tag>
941 <item>Packages shipping web server CGI files are expected to install
942 them in <file>/usr/lib/cgi-lib/</file> directories. This location change
943 perhaps should be documented in NEWS
944 <tag>11.5</tag>
945 <item>Web server packages should include a standard scriptAlias of
946 cgi-lib to <file>/usr/lib/cgi-lib</file>.
947 <tag>9.1.1</tag>
948 <item>The version of FHS mandated by policy has been upped to
949 2.3. There should be no changes required for most packages,
950 though new top level directories <file>/media</file>, <file>/srv</file>,
951 etc. may be of interest.
952 <tag>5.1, 5.6.3</tag>
953 <item>All fields, apart from the Uploaders field, in the control file
954 are supposed to be a single logical line, which may be spread
955 over multiple physical lines (newline followed by space is
956 elided). However, any parser for the control file must allow
957 the Uploaders field to be spread over multiple physical lines
958 as well, to prepare for future changes.
959 <tag>10.4</tag>
960 <item>When scripts are installed into a directory in the system
961 PATH, the script name should not include an extension that
962 denotes the scripting language currently used to implement it.
964 <tag>9.3.3.2</tag>
965 <item>packages that invoke initscripts now must use invoke-rc.d to do
966 so since it also pays attention to run levels and other local
967 constraints.
968 <tag>11.8.5.2, 11.8.7, etc</tag>
969 <item>We no longer use <file>/usr/X11R6</file>, since we have
970 migrated away to using Xorg paths. This means, for one thing, fonts
971 live in <file>/usr/share/fonts/X11/</file> now, and <file>/usr/X11R6</file>
972 is gone.
973 </taglist></p>
975 <sect id="3.6.2.0"> Version 3.6.2.0
978 Released 2005
980 </p><p><taglist>
981 <tag></tag>
982 <item>Recommend. doc-base, and not menu, for registering package documentation.
983 </item>
984 <tag>8.1</tag>
985 <item>Run time support programs should live in subdirectories of
986 <file>/usr/lib/</file> or <file>/usr/share</file>, and preferably the shared
987 lib is named the same as the package name (to avoid name collisions).
988 </item>
989 <tag>11.5</tag>
990 <item>It is recommended that HTTP servers provide an alias /images to
991 allow packages to share image files with the web server
992 </item>
993 </taglist></p>
995 <sect id="3.6.1.0"> Version 3.6.1.0
998 Released Aug 2003.
1000 </p><p><taglist>
1001 <tag>3.10.1</tag>
1002 <item>Prompting the user should be done using debconf. Non debconf
1003 user prompts are now deprecated.
1004 </taglist></p>
1006 <sect id="3.6.0.0"> Version 3.6.0
1009 Released Jul 2003.
1011 </p><p><taglist>
1012 <tag></tag>
1013 <item>Restructuring causing shifts in section numbers and bumping of
1014 the minor version number:
1015 <tag></tag>
1016 <item>Many packaging manual appendices that were integrated into policy
1017 sections are now empty, and replaced with links to the Policy.
1018 In particular, the appendices that included the list of control
1019 fields were updated (new fields like Closes, Changed-By were added)
1020 and the list of fields for each of control, .changes and .dsc files
1021 is now in Policy, and they're marked mandatory, recommended or
1022 optional based on the current practice and the behavior of the
1023 deb-building tool-chain.
1024 <tag></tag>
1025 <item>Elimination of needlessly deep section levels, primarily in the
1026 chapter Debian Archive, from which two new chapters were split out,
1027 Binary packages and Source packages. What remained was reordered
1028 properly, that is, some sects became sects etc.
1029 <tag></tag>
1030 <item>Several sections that were redundant, crufty or simply not designed
1031 with any sort of vision, were rearranged according to the formula that
1032 everything should be either in the same place or properly interlinked.
1033 Some things remained split up between different chapters when they
1034 talked about different aspects of files: their content, their syntax,
1035 and their placement in the file system. In particular, see the new
1036 sections about changelog files.
1037 <tag>menu policy</tag>
1038 <item>Added Games/Simulation and Apps/Education to menu
1039 sub-policy
1040 <tag>C.2.2</tag>
1041 <item>Debian changelogs should be UTF-8 encoded.
1042 <tag>10.2</tag>
1043 <item>shared libraries must be linked against all libraries that they
1044 use symbols from in the same way that binaries are.
1045 <tag>7.6</tag>
1046 <item>build-depends-indep need not be satisfied during clean
1047 target.
1048 </taglist></p>
1050 <sect id="3.5.10.0"> Version 3.5.10
1053 Released May 2003.
1055 </p><p><taglist>
1056 <tag>11.8.3</tag>
1057 <item>packages providing the x-terminal-emulator virtual package
1058 ought to ensure that they interpret the command line exactly
1059 like xterm does.
1060 <tag>11.8.4</tag>
1061 <item>Window managers compliant with the Window Manager Specification
1062 Project may add 40 points for ranking in the alternatives
1063 </taglist></p>
1065 <sect id="3.5.9.0"> Version 3.5.9.0
1068 Released Mar 2003.
1070 </p><p><taglist>
1071 <tag>3.4.2</tag>
1072 <item>The section describing the Description: package field once again has
1073 full details of the long description format.
1074 <tag>4.2</tag>
1075 <item>Clarified that if a package has non-build-essential
1076 build-dependencies, it should have them listed in the Build-Depends
1077 and related fields (i.e. it's not merely optional).
1078 <tag>9.3.2</tag>
1079 <item>When asked to restart a service that isn't already running,
1080 the init script should start the service.
1081 <tag>12.6</tag>
1082 <item>If the purpose of a package is to provide examples, then the
1083 example files can be installed into <file>/usr/share/doc/package</file>
1084 (rather than <file>/usr/share/doc/package/examples</file>).
1085 </taglist></p>
1087 <sect id="3.5.8.0"> Version 3.5.8.0
1090 Released Nov 2002.
1092 </p><p><taglist>
1093 <tag>12.7</tag>
1094 <item>It is no longer necessary to keep a log of changes to the upstream
1095 sources in the copyright file. Instead, all such changes should be
1096 documented in the changelog file.
1097 <tag>7.6</tag>
1098 <item><var/Build-Depends/, <var/Build-Conflicts/, <var/Build-Depends-Indep/,
1099 and <var/Build-Conflicts-Indep/ must also be satisfied when the clean
1100 target is called.
1101 <tag>menu policy</tag>
1102 <item>A new Apps/Science menu section is available
1103 <tag>debconf policy</tag>
1104 <item>debconf specification cleared up, various changes.
1105 <tag>12.1</tag>
1106 <item>It is no longer recommended to create symlinks from nonexistent
1107 manual pages to undocumented(7). Missing manual pages for programs
1108 are still a bug.
1109 </taglist></p>
1111 <sect id="3.5.7.0"> Version 3.5.7.0
1114 Released Aug 2002.
1116 </p><p><taglist>
1117 <tag></tag>
1118 <item>Packages no longer have to ask permission to call MAKEDEV in
1119 postinst, merely notifying the user ought to be enough.
1120 <tag>2.2.4</tag>
1121 <item>cryptographic software may now be included in the main
1122 archive.
1123 <tag>3.9</tag>
1124 <item>task packages are no longer permitted; tasks are now created by a
1125 special Tasks: field in the control file.
1126 <tag>11.8.4</tag>
1127 <item>window managers that support netwm can now add 20 points when
1128 they add themselves as an alternative for
1129 <file>/usr/bin/x-window-manager</file>
1130 <tag>10.1</tag>
1131 <item>The default compilation options have now changed, one should
1132 provide debugging symbols in all cases, and optionally step
1133 back optimization to -O0, depending on the DEB_BUILD_OPTIONS
1134 environment variable.
1135 <tag>7.6, 4.8</tag>
1136 <item>Added mention of build-arch, build-indep, etc, in describing
1137 the relationships with `Build-Depends', `Build-Conflicts',
1138 `Build-Depends-Indep', and `Build-Conflicts-Indep'. May need to
1139 review the new rules.
1140 <tag>8</tag>
1141 <item>Changed rules on how, and when, to invoke ldconfig in maintainer
1142 scripts. Long rationale.
1143 </taglist></p>
1145 <p><em>
1146 Added the last note in 3.5.6 upgrading checklist item regarding build
1147 rules, please see below
1148 </em></p>
1150 <sect id="3.5.6.0"> Version 3.5.6.0
1153 Released Jul 2001.
1155 </p><p><taglist>
1156 <tag>2.5</tag>
1157 <item>Emacs and TeX are no longer mandated by policy to be priority
1158 standard packages
1159 <tag>11.5</tag>
1160 <item>Programs that access docs need to do so via <file>/usr/share/doc</file>,
1161 and not via <file>/usr/doc/</file> as was the policy previously
1162 <tag>12.3</tag>
1163 <item>Putting documentation in <file>/usr/doc</file> versus
1164 <file>/usr/share/doc</file> is now a ``serious'' policy violation.
1165 <tag>11.5</tag>
1166 <item>For web servers, one should not provide non-local access to the
1167 <file>/usr/share/doc</file> hierarchy. If one can't provide access
1168 controls for the http://localhost/doc/ directory, then it is preferred
1169 that one ask permission to expose that information during the install.
1170 <tag>7</tag>
1171 <item>There are new rules for build-indep/build-arch targets and
1172 there is a new Build-Depend-Indep semantic.
1173 </taglist></p>
1175 <sect id="3.5.5.0"> Version 3.5.5.0
1178 Released May 2001.
1180 </p><p><taglist>
1181 <tag>12.1</tag>
1182 <item>Manpages should not rely on header information to have
1183 alternative manpage names available; it should only use
1184 symlinks or .so pages to do this
1185 </item>
1186 <tag></tag>
1187 <item><em> Clarified note in 3.5.3.0 upgrading checklist regarding
1188 examples and templates: this refers only to those examples used
1189 by scripts; see section 10.7.3 for the whole story</em>
1190 </item>
1191 <tag></tag>
1192 <item>Included a new section 10.9.1 describing the use of
1193 dpkg-statoverride; this does not have the weight of policy
1194 </item>
1195 <tag></tag>
1196 <item>Clarify Standards-Version: you don't need to rebuild your
1197 packages just to change the Standards-Version!
1198 </item>
1199 <tag>10.2</tag>
1200 <item>Plugins are no longer bound by all the rules of shared
1201 libraries
1202 </item>
1203 <tag>X Windows related things:</tag>
1204 <item><taglist>
1205 <tag>11.8.1</tag>
1206 <item>Clarification of priority levels of X Window System related
1207 packages
1208 </item>
1209 <tag>11.8.3</tag>
1210 <item>Rules for defining x-terminal-emulator improved </item>
1211 <tag>11.8.5</tag>
1212 <item>X Font policy rewritten: you must read this if you provide
1213 fonts for the X Window System
1214 </item>
1215 <tag>11.8.6</tag>
1216 <item>Packages must not ship <file>/usr/X11R6/lib/X11/app-defaults/</file>
1217 </item>
1218 <tag>11.8.7</tag>
1219 <item>X-related packages should usually use the regular FHS
1220 locations; imake-using packages are exempted from this
1221 </item>
1222 <tag>11.8.8</tag>
1223 <item>OpenMotif linked binaries have the same rules as
1224 OSF/Motif-linked ones
1225 </item>
1226 </taglist></item>
1227 </taglist></p>
1229 <sect id="3.5.4.0"> Version 3.5.4.0
1230 <p> Released Apr 2001.
1232 </p><p><taglist>
1233 <tag>11.6</tag>
1234 <item>The system-wide mail directory is now /var/mail, no longer
1235 /var/spool/mail. Any packages accessing the mail spool should
1236 access it via /var/mail and include a suitable Depends field;
1237 </item>
1238 <tag>11.9; perl-policy</tag>
1239 <item>The perl policy is now part of Debian policy
1240 proper. Perl programs and modules should follow the current Perl
1241 policy
1242 </item>
1243 </taglist></p>
1245 <sect id="3.5.3.0"> Version 3.5.3.0
1246 <p> Released Apr 2001
1248 </p><p><taglist>
1249 <tag>7.1</tag>
1250 <item>Build-Depends arch syntax has been changed to be less
1251 ambiguous. This should not affect any current packages
1252 </item>
1253 <tag>10.7.3</tag>
1254 <item>Examples and templates files for use by scripts should now live
1255 in <file>/usr/share/&lt;package&gt;</file> or
1256 <file>/usr/lib/&lt;package&gt;</file>, with symbolic links from
1257 <file>/usr/share/doc/&lt;package&gt;/examples</file> as needed
1258 </item>
1259 </taglist></p>
1261 <sect id="3.5.2.0"> Version 3.5.2.0
1263 <p> Released Feb 2001.
1265 </p><p><taglist>
1266 <tag>11.8.6</tag>
1267 <item>X app-defaults directory has moved from
1268 <file>/usr/X11R6/lib/X11/app-defaults</file> to
1269 <file>/etc/X11/app-defaults</file>
1270 </item>
1271 </taglist></p>
1273 <sect id="3.5.1.0"> Version 3.5.1.0
1275 <p> Released Feb 2001.
1277 </p><p><taglist>
1278 <tag>8.1</tag>
1279 <item>dpkg-shlibdeps now uses objdump, so shared libraries have to be
1280 run through dpkg-shlibdeps as well as executables
1281 </item>
1282 </taglist></p>
1284 <sect id="3.5.0.0"> Version 3.5.0.0
1286 <p> Released Jan 2001.
1288 </p><p><taglist>
1289 <tag>11.8.5</tag>
1290 <item>Font packages for the X Window System must now declare a
1291 dependency on xutils (>= 4.0.2)
1292 </item>
1293 </taglist></p>
1295 <sect id="3.2.1.1"> Version 3.2.1.1
1297 <p> Released Jan 2001.
1299 </p><p><taglist>
1300 <tag>9.3.2</tag>
1301 <item>Daemon startup scripts in <file>/etc/init.d/</file> should not contain
1302 modifiable parameters; these should be moved to a file in
1303 <file>/etc/default/</file>
1304 </item>
1305 <tag>12.3</tag>
1306 <item>Files in <file>/usr/share/doc</file> must not be referenced by any
1307 program. If such files are needed, they must be placed in
1308 <file>/usr/share/&lt;package&gt;/</file>, and symbolic links
1309 created as required in <file>/usr/share/doc/&lt;package&gt;/</file>
1310 </item>
1311 <tag></tag>
1312 <item>Much of the packaging manual has now been imported into the
1313 policy document
1314 </item>
1315 </taglist></p>
1317 <sect id="3.2.1.0"> Version 3.2.1.0
1319 <p> Released Aug 00.
1321 </p><p><taglist>
1322 <tag>11.8.1</tag>
1323 <item>A package of priority standard or higher may provide two
1324 binaries, one compiled with support for the X Window System,
1325 and the other without
1326 </item>
1327 </taglist></p>
1329 <sect id="3.2.0.0"> Version 3.2.0.0
1331 <p> Released Aug 00.
1333 </p><p><taglist>
1334 <tag>10.1</tag>
1335 <item>By default executables should not be built with the debugging
1336 option -g. Instead, it is recommended to support building the
1337 package with debugging information optionally.
1338 </item>
1339 <tag>12.8</tag>
1340 <item>Policy for packages where the upstream uses HTML changelog
1341 files has been expanded. In short, a plain text changelog file
1342 should always be generated for the upstream changes
1343 </item>
1344 <tag></tag>
1345 <item>Please note that the new release of the X window system (3.2)
1346 shall probably need sweeping changes in policy
1347 </item>
1348 <tag></tag>
1349 <item>Policy for packages providing the following X-based features
1350 has been codified:
1351 <taglist>
1352 <tag>11.8.2</tag>
1353 <item>X server (virtual package xserver) </item>
1354 <tag>11.8.3</tag>
1355 <item>X terminal emulator (virtual package x-terminal-emulator) </item>
1356 <tag>11.8.4</tag>
1357 <item>X window manager (virtual package x-window-manager, and
1358 <file>/usr/bin/x-window-manager</file> alternative, with priority
1359 calculation guidelines)
1360 </item>
1361 <tag>12.8.5</tag>
1362 <item>X fonts (this section has been written from scratch) </item>
1363 <tag>11.8.6</tag>
1364 <item>X application defaults </item>
1365 </taglist>
1366 </item>
1367 <tag>11.8.7</tag>
1368 <item>Policy for packages using the X Window System and FHS issues
1369 has been clarified;
1370 </item>
1371 <tag>11.7.3</tag>
1372 <item>No package may contain or make hard links to conffiles </item>
1373 <tag>8</tag>
1374 <item>Noted that newer dpkg versions do not require extreme care in
1375 always creating the shared lib before the symlink, so the unpack
1376 order be correct
1377 </item>
1378 </taglist></p>
1380 <sect id="3.1.1.0"> Version 3.1.1.0
1382 <p> Released Nov 1999.
1384 </p><p><taglist>
1385 <tag>7.1</tag>
1386 <item>Correction to semantics of architecture lists in Build-Depends
1387 etc. Should not affect many packages
1388 </item>
1389 </taglist></p>
1391 <sect id="3.1.0.0"> Version 3.1.0.0
1393 <p> Released Oct 1999.
1395 </p><p><taglist>
1396 <tag>defunct</tag>
1397 <item><file>/usr/doc/&lt;package&gt;</file> has to be a symlink pointing to
1398 <file>/usr/share/doc/&lt;package&gt;</file>, to be maintained by postinst
1399 and prerm scripts.
1400 </item>
1401 <tag>7.1, 7.6</tag>
1402 <item>Introduced source dependencies (Build-Depends, etc.) </item>
1403 <tag>9.3.4</tag>
1404 <item><file>/etc/rc.boot</file> has been deprecated in favour of
1405 <file>/etc/rcS.d</file>. (Packages should not be touching this directory,
1406 but should use update-rc.d instead)
1407 </item>
1408 <tag>9.3.3</tag>
1409 <item>update-rc.d is now the <em>only</em> allowable way of accessing the
1410 <file>/etc/rc?.d/[SK]??*</file> links. Any scripts which manipulate them
1411 directly must be changed to use update-rc.d instead. (This is
1412 because the file-rc package handles this information in an
1413 incompatible way.)
1414 </item>
1415 <tag>12.7</tag>
1416 <item>Architecture-specific examples go in
1417 <file>/usr/lib/&lt;package&gt;/examples</file>
1418 with symlinks from <file>/usr/share/doc/&lt;package&gt;/examples/*</file>
1419 or from <file>/usr/share/doc/&lt;package&gt;/examples</file> itself
1420 </item>
1421 <tag>9.1.1</tag>
1422 <item>Updated FHS to a 2.1 draft; this reverts <file>/var/state</file> to
1423 <file>/var/lib</file>
1424 </item>
1425 <tag>9.7; mime-policy</tag>
1426 <item>Added MIME sub-policy document </item>
1427 <tag>12.4</tag>
1428 <item>VISUAL is allowed as a (higher priority) alternative to EDITOR
1429 </item>
1430 <tag>11.6</tag>
1431 <item>Modified liblockfile description, which affects
1432 mailbox-accessing programs. Please see the policy document for
1433 details
1434 </item>
1435 <tag>12.7</tag>
1436 <item>If a package provides a changelog in HTML format, a text-only
1437 version should also be included. (Such a version may be prepared
1438 using <prgn>lynx -dump -nolist</prgn>.)
1439 </item>
1440 <tag>3.2.1</tag>
1441 <item>Description of how to handle version numbers based on dates
1442 added
1443 </item>
1444 </taglist></p>
1446 <sect id="3.0.1.0"> Version 3.0.1.0
1448 <p> Released Jul 1999.
1450 </p><p><taglist>
1451 <tag>10.2</tag>
1452 <item>Added the clarification that the .la files are essential for
1453 the packages using libtool's libltdl library, in which case the .la
1454 files must go in the run-time library package
1455 </item>
1456 </taglist></p>
1458 <sect id="3.0.0.0"> Version 3.0.0.0
1460 <p> Released Jun 1999.
1462 </p><p><taglist>
1463 <tag>9.1</tag>
1464 <item>Debian formally moves from the FSSTND to the FHS. This is a
1465 major change, and the implications of this move are probably
1466 not all known.
1467 </item>
1468 <tag>4.1</tag>
1469 <item>Only 3 digits of the Standards version need be included in
1470 control files, though all four digits are still permitted.
1471 </item>
1472 <tag>12.6</tag>
1473 <item>The location of the GPL has changed to
1474 <file>/usr/share/common-licenses</file>. This may require changing the
1475 copyright files to point to the correct location of the GPL and
1476 other major licenses
1477 </item>
1478 <tag>10.2</tag>
1479 <item>Packages that use libtool to create shared libraries must
1480 include the .la files in the -dev packages
1481 </item>
1482 <tag>10.8</tag>
1483 <item>Use logrotate to rotate log files
1484 </item>
1485 <tag>now 11.8</tag>
1486 <item>section 5.8 has been rewritten (Programs for the X Window
1487 System)
1488 </item>
1489 <tag>9.6; menu-policy</tag>
1490 <item>There is now an associated menu policy, in a separate document,
1491 that carries the full weight of Debian policy
1492 </item>
1493 <tag>11.3</tag>
1494 <item>Programs which need to modify the files <file>/var/run/utmp</file>,
1495 <file>/var/log/wtmp</file> and <file>/var/log/lastlog</file> must be
1496 installed setgid utmp
1497 </item>
1498 </taglist></p>
1499 <p><em>
1500 Please note that section numbers below this point may not be up to date
1501 </em></p>
1503 <sect id="2.5.0.0"> Version 2.5.0.0
1505 <p> Released Oct 1998.
1507 Policy Manual:
1508 </p><p><list>
1509 <item>Rearranged the manual to create a new Section 4, Files
1510 <list>
1511 <item>Section 3.3 ("Files") was moved to Section 4. The Sections
1512 that were Section 4 and Section 5 were moved down to become
1513 Section 5 and Section 6.
1514 </item>
1515 <item>What was Section 5.5 ("Log files") is now a subsection of the
1516 new Section 4 ("Files"), becoming section 4.8, placed after
1517 "Configuration files", moving the Section 4.8 ("Permissions
1518 and owners") to Section 4.9. All subsections of the old
1519 Section 5 after 5.5 were moved down to fill in the number
1520 gap.
1521 </item>
1522 </list></item>
1523 <item>Modified the section about changelog files to accommodate
1524 upstream changelogs which were formatted as HTML. These
1525 upstream changelog files should now be accessible as
1526 <file>/usr/doc/package/changelog.html.gz</file>
1527 </item>
1528 <item>Symlinks are permissible to link the real, or upstream,
1529 changelog name to the Debian mandated name.
1530 </item>
1531 <item>Clarified that HTML documentation should be present in some
1532 package, though not necessarily the main binary package.
1533 </item>
1534 <item>Corrected all references to the location of the copyright
1535 files. The correct location is <file>/usr/doc/package/copyright</file>
1536 </item>
1537 <item>Ratified the architecture specification strings to cater to the
1538 HURD.
1539 </item>
1540 </list></p>
1542 <sect id="2.4.1.0"> Version 2.4.1.0
1544 <p> Released Apr 1998.
1545 </p>
1546 <sect1> Policy Manual:
1547 <p><taglist>
1548 <tag>Updated section 3.3.5 Symbolic links:</tag>
1549 <item>symbolic links within a toplevel directory should be relative,
1550 symbolic links between toplevel directories should be absolute
1551 (cf., Policy Weekly Issue#6, topic 2)
1552 </item>
1554 <tag>Updated section 4.9 Games:</tag>
1555 <item>manpages for games should be installed in <file>/usr/man/man6</file>
1556 (cf., Policy Weekly Issue#6, topic 3)
1557 </item>
1558 </taglist></p>
1560 <sect1> Packaging Manual:
1561 <p><list>
1562 <item>Updated prefix of chapter 12, Shared Libraries:
1563 ldconfig must be called in the postinst script if the package
1564 installs shared libraries
1565 (cf., Policy Weekly Issue #6, fixes:bug#20515)
1566 </item>
1567 </list></p>
1569 <sect id="2.4.0.0"> Version 2.4.0.0
1571 <p> Released Jan 1998
1573 </p><p><taglist>
1574 <tag>Updated section 3.3.4 Scripts:</tag>
1575 <item><list>
1576 <item>/bin/sh may be any POSIX compatible shell
1577 <item>scripts including bashisms have to specify <file>/bin/bash</file>
1578 as interpreter
1579 <item>scripts which create files in world-writable directories
1580 (e.g., in <file>/tmp</file>) should use tempfile or mktemp for creating
1581 the directory
1582 </list></item>
1584 <tag>Updated section 3.3.5 Symbolic Links:</tag>
1585 <item>symbolic links referencing compressed files must have the same
1586 file extension as the referenced file
1587 </item>
1589 <tag>Updated section 3.3.6 Device files:</tag>
1590 <item><file>/dev/tty*</file> serial devices should be used instead of
1591 <file>/dev/cu*</file>
1592 </item>
1594 <tag>Updated section 3.4.2 Writing the scripts in <file>/etc/init.d</file>:
1595 <item><list>
1596 <item>all <file>/etc/init.d</file> scripts have to provide the following
1597 options: start, stop, restart, force-reload
1598 <item>the reload option is optional and must never stop and restart
1599 the service
1600 </list></item>
1602 <tag>Updated section 3.5 Cron jobs:
1603 <item>cron jobs that need to be executed more often than daily should
1604 be installed into <file>/etc/cron.d</file>
1605 </item>
1607 <tag>Updated section 3.7 Menus:
1608 <item>removed section about how to register HTML docs to `menu'
1609 (the corresponding section in 4.4, Web servers and applications,
1610 has been removed in policy 2.2.0.0 already, so this one was
1611 obsolete)
1612 </item>
1614 <tag>New section 3.8 Keyboard configuration:
1615 <item>details about how the backspace and delete keys should be
1616 handled
1617 </item>
1619 <tag>New section 3.9 Environment variables:
1620 <item>no program must depend on environment variables to get a
1621 reasonable default configuration
1622 </item>
1624 <tag>New section 4.6 News system configuration:
1625 <item><file>/etc/news/organization</file> and <file>/etc/news/server</file>
1626 should be supported by all news servers and clients
1627 </item>
1629 <tag>Updated section 4.7 Programs for the X Window System:
1630 <item><list>
1631 <item>programs requiring a non-free Motif library should be provided
1632 as foo-smotif and foo-dmotif package
1633 </item>
1634 <item>if lesstif works reliably for such program, it should be linked
1635 against lesstif and not against a non-free Motif library
1636 </item>
1637 </list></item>
1639 <tag>Updated section 4.9 Games:
1640 <item>games for X Windows have to be installed in <file>/usr/games</file>,
1641 just as non-X games
1642 </item>
1643 </taglist></p>
1645 <sect id="2.3.0.0"> Version 2.3.0.1, 2.3.0.0
1647 <p> Released Sep 1997.
1649 <p><list>
1650 <item>new section `4.2 Daemons' including rules for
1651 <file>/etc/services</file>, <file>/etc/protocols</file>,
1652 <file>/etc/rpc</file>, and <file>/etc/inetd.conf</file>
1653 </item>
1655 <item>updated section about `Configuration files':
1656 packages may not touch other packages' configuration files
1657 </item>
1659 <item>MUAs and MTAs have to use liblockfile</item>
1660 </list></p>
1662 <sect id="2.2.0.0"> Version 2.2.0.0
1664 <p> Released July 1997.
1666 <p><list>
1667 <item>added section 4.1 `Architecture specification strings':
1669 &lt;arch&gt;-linux
1670 where &lt;arch&gt; is one of the following:
1671 i386, alpha, arm, m68k, powerpc, sparc.
1672 </item>
1674 <item>detailed rules for <file>/usr/local</file></item>
1676 <item>user ID's</item>
1678 <item>editor/pager policy</item>
1680 <item>cron jobs</item>
1682 <item>device files</item>
1684 <item>don't install shared libraries as executable</item>
1686 <item>app-defaults files may not be conffiles</item>
1687 </list></p>
1689 <sect id="2.1.3.0"> Version 2.1.3.2, 2.1.3.1, 2.1.3.0
1691 <p> Released Mar 1997.
1693 <p><list>
1694 <item>two programs with different functionality must not have the
1695 same name </item>
1697 <item>"Webstandard 3.0"</item>
1699 <item>"Standard for Console Messages"</item>
1701 <item>Libraries should be compiled with `-D_REENTRANT'</item>
1703 <item>Libraries should be stripped with <prgn>strip --strip-unneeded</prgn>
1704 </item>
1705 </list></p>
1707 <sect id="2.1.2.0"> Version 2.1.2.2, 2.1.2.1, 2.1.2.0
1709 <p> Released Nov 1996.
1711 <p><list>
1712 <item>Some changes WRT shared libraries
1713 </list></p>
1715 <sect id="2.1.1.0"> Version 2.1.1.0
1717 <p> Released Sep 1996.
1719 <p><list>
1720 <item>No hard links in source packages</item>
1722 <item>Do not use <prgn>dpkg-divert</prgn> or <prgn>update-alternatives</prgn>
1723 without consultation </item>
1725 <item>Shared libraries must be installed stripped </item>
1726 </list></p>
1728 <sect id="2.1.0.0"> Version 2.1.0.0
1730 <p> Released Aug 1996.
1732 <p><list>
1733 <item>Upstream changelog must be installed too </item>
1734 </list></p>
1735 </book>
1736 </debiandoc>