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