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