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