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