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