From: Russ Allbery <rra@debian.org>
Date: Tue, 29 Jun 2010 18:14:49 +0000 (-0700)
Subject: Merge branch 'master' into bug504880-rra
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=21df36b8215e66ff6a1f66de5418660dc032df99;hp=-c;p=debian%2Fdebian-policy.git

Merge branch 'master' into bug504880-rra
---

21df36b8215e66ff6a1f66de5418660dc032df99
diff --combined policy.sgml
index 57ff067,9fe7158..2f4c935
--- a/policy.sgml
+++ b/policy.sgml
@@@ -2,6 -2,8 +2,8 @@@
  <!-- include version information so we don't have to hard code it
       within the document -->
  <!entity % versiondata SYSTEM "version.ent"> %versiondata;
+ <!-- current Debian changes file format -->
+ <!entity changesversion "1.8">
  ]>
  <debiandoc>
  
@@@ -474,9 -476,11 +476,11 @@@
  	      <item>
  		  must not require a package outside of <em>main</em>
  		  for compilation or execution (thus, the package must
- 		  not declare a "Depends", "Recommends", or
- 		  "Build-Depends" relationship on a non-<em>main</em>
- 		  package),
+ 		  not declare a <tt>Pre-Depends</tt>, <tt>Depends</tt>,
+ 		  <tt>Recommends</tt>, <tt>Build-Depends</tt>,
+ 		  or <tt>Build-Depends-Indep</tt> relationship on a
+ 		  non-<em>main</em> package unless a package
+ 		  in <em>main</em> is listed as an alternative),
  	      </item>
  	      <item>
  		  must not be so buggy that we refuse to support them,
@@@ -1054,8 -1058,8 +1058,8 @@@
  	</p>
  
  	<p>
 -	  Sometimes, a package requires another package to be installed
 -	  <em>and</em> configured before it can be installed. In this
 +	  Sometimes, a package requires another package to be unpacked
 +	  <em>and</em> configured before it can be unpacked. In this
  	  case, you must specify a <tt>Pre-Depends</tt> entry for
  	  the package.
  	</p>
@@@ -2497,7 -2501,7 +2501,7 @@@ Package: libc
  	  These fields are used by <prgn>dpkg-gencontrol</prgn> to
  	  generate control files for binary packages (see below), by
  	  <prgn>dpkg-genchanges</prgn> to generate the
- 	  <tt>.changes</tt> file to accompany the upload, and by
+ 	  <file>.changes</file> file to accompany the upload, and by
  	  <prgn>dpkg-source</prgn> when it creates the
  	  <file>.dsc</file> source control file as part of a source
  	  archive. Many fields are permitted to span multiple lines in
@@@ -2531,7 -2535,8 +2535,8 @@@
  
  	<p>
  	  The <file>DEBIAN/control</file> file contains the most vital
- 	  (and version-dependent) information about a binary package.
+ 	  (and version-dependent) information about a binary package.  It
+ 	  consists of a single paragraph.
  	</p>
  
  	<p>
@@@ -2558,10 -2563,9 +2563,9 @@@
  	<heading>Debian source control files -- <tt>.dsc</tt></heading>
  
  	<p>
- 	  This file contains a series of fields, identified and
- 	  separated just like the fields in the control file of
- 	  a binary package.  The fields are listed below; their
- 	  syntax is described above, in <ref id="pkg-controlfields">.
+ 	  This file consists of a single paragraph, possibly surrounded by
+ 	  a PGP signature. The fields of that paragraph are listed below.
+ 	  Their syntax is described above, in <ref id="pkg-controlfields">.
  
  	<list compact="compact">
  	  <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
@@@ -2595,12 -2599,19 +2599,19 @@@
  	<heading>Debian changes files -- <file>.changes</file></heading>
  
  	<p>
- 	  The .changes files are used by the Debian archive maintenance
- 	  software to process updates to packages. They contain one
- 	  paragraph which contains information from the
- 	  <tt>debian/control</tt> file and other data about the
- 	  source package gathered via <tt>debian/changelog</tt>
- 	  and <tt>debian/rules</tt>.
+ 	  The <file>.changes</file> files are used by the Debian archive
+ 	  maintenance software to process updates to packages. They
+ 	  consist of a single paragraph, possibly surrounded by a PGP
+ 	  signature. That paragraph contains information from the
+ 	  <file>debian/control</file> file and other data about the
+ 	  source package gathered via <file>debian/changelog</file>
+ 	  and <file>debian/rules</file>.
+ 	</p>
+ 
+ 	<p>
+ 	  <file>.changes</file> files have a format version that is
+ 	  incremented whenever the documented fields or their meaning
+ 	  change.  This document describes format &changesversion;.
  	</p>
  
  	<p>
@@@ -3259,12 -3270,30 +3270,30 @@@
  	  <heading><tt>Format</tt></heading>
  
  	  <p>
- 	    This field specifies a format revision for the file.
- 	    The most current format described in the Policy Manual
- 	    is version <strong>1.5</strong>.  The syntax of the
- 	    format value is the same as that of a package version
- 	    number except that no epoch or Debian revision is allowed
- 	    - see <ref id="f-Version">.
+ 	    In <qref id="debianchangesfiles"><file>.changes</file></qref>
+ 	    files, this field declares the format version of that file.
+ 	    The syntax of the field value is the same as that of
+ 	    a <qref id="f-Version">package version number</qref> except
+ 	    that no epoch or Debian revision is allowed.  The format
+ 	    described in this document is <tt>&changesversion;</tt>.
+ 	  </p>
+ 
+ 	  <p>
+ 	    In <qref id="debiansourcecontrolfiles"><file>.dsc</file>
+ 	    Debian source control</qref> files, this field declares the
+ 	    format of the source package.  The field value is used by
+ 	    programs acting on a source package to interpret the list of
+ 	    files in the source package and determine how to unpack it.
+ 	    The syntax of the field value is a numeric major revision, a
+ 	    period, a numeric minor revision, and then an optional subtype
+ 	    after whitespace, which if specified is an alphanumeric word
+ 	    in parentheses.  The subtype is optional in the syntax but may
+ 	    be mandatory for particular source format revisions.
+ 	    <footnote>
+ 	      The source formats currently supported by the Debian archive
+ 	      software are <tt>1.0</tt>, <tt>3.0 (native)</tt>,
+ 	      and <tt>3.0 (quilt)</tt>.
+ 	    </footnote>
  	  </p>
  	</sect1>
  
@@@ -3525,7 -3554,6 +3554,6 @@@ Checksums-Sha256
  	    must match the list of files in the <tt>Files</tt> field.
  	  </p>
  	</sect1>
- 
        </sect>
  
        <sect>
@@@ -3625,7 -3653,7 +3653,7 @@@
  
  	<p>
  	  Broadly speaking the <prgn>preinst</prgn> is called before
 -	  (a particular version of) a package is installed, and the
 +	  (a particular version of) a package is unpacked, and the
  	  <prgn>postinst</prgn> afterwards; the <prgn>prerm</prgn>
  	  before (a version of) a package is removed and the
  	  <prgn>postrm</prgn> afterwards.
@@@ -4015,7 -4043,7 +4043,7 @@@
  		behavior which, though deterministic, is hard for the
  		system administrator to understand.  It can easily
  		lead to "missing" programs if, for example, a package
 -		is installed which overwrites a file from another
 +		is unpacked which overwrites a file from another
  		package, and is then removed again.<footnote>
  		    Part of the problem is due to what is arguably a
  		    bug in <prgn>dpkg</prgn>.
@@@ -4151,7 -4179,7 +4179,7 @@@
  		If there was a conflicting package we go and do the
  		removal actions (described below), starting with the
  		removal of the conflicting package's files (any that
 -		are also in the package being installed have already
 +		are also in the package being unpacked have already
  		been removed from the conflicting package's file list,
  		and so do not get removed now).
  	    </item>
@@@ -4465,30 -4493,31 +4493,30 @@@ Build-Depends: foo [linux-any], bar [an
  	</p>
  
  	<p>
 -	  For this reason packages in an installation run are usually
 -	  all unpacked first and all configured later; this gives
 -	  later versions of packages with dependencies on later
 -	  versions of other packages the opportunity to have their
 -	  dependencies satisfied.
 +	  Since <tt>Depends</tt> only places requirements on the
 +	  configuration step, packages in an installation run are usually
 +	  all unpacked first and all configured later.  This makes it
 +	  easier to satisfy all dependencies when multiple packages are
 +	  being upgraded.
  	</p>
  
 -        <p>
 -          In case of circular dependencies, since installation or
 -          removal order honoring the dependency order can't be
 -          established, dependency loops are broken at some point
 -          (based on rules below), and some packages may not be able to
 -          rely on their dependencies being present when being
 -          installed or removed, depending on which side of the break
 -          of the circular dependency loop they happen to be on.  If one
 -          of the packages in the loop has no postinst script, then the
 -          cycle will be broken at that package, so as to ensure that
 -          all postinst scripts run with the dependencies properly
 -          configured if this is possible. Otherwise the breaking point
 -          is arbitrary.
 -        </p>
 -
  	<p>
 -	  The <tt>Depends</tt> field thus allows package maintainers
 -	  to impose an order in which packages should be configured.
 +	  If there is a circular dependency among packages being installed
 +	  or removed, installation or removal order honoring the
 +	  dependency order is impossible, requiring the dependency loop be
 +	  broken at some point and the dependency requirements violated
 +	  for at least one package.  Packages involved in circular
 +	  dependencies may not be able to rely on their dependencies being
 +	  configured when being configured or removed depending on which
 +	  side of the break of the circular dependency loop they happen to
 +	  be on.  If one of the packages in the loop has no
 +	  <prgn>postinst</prgn> script, then the cycle will be broken at
 +	  that package; this ensures that all <prgn>postinst</prgn>
 +	  scripts are run with their dependencies properly configured if
 +	  this is possible.  Otherwise the breaking point is arbitrary.
 +	  Packages should therefore avoid circular dependencies where
 +	  possible, particularly if they have <prgn>postinst</prgn>
 +	  scripts.
  	</p>
  
  	<p>
@@@ -4500,8 -4529,7 +4528,8 @@@
  		This declares an absolute dependency.  A package will
  		not be configured unless all of the packages listed in
  		its <tt>Depends</tt> field have been correctly
 -		configured.
 +		configured (unless there is a circular dependency as
 +		described above).
  	      </p>
  
  	      <p>
@@@ -4515,17 -4543,10 +4543,17 @@@
  		The <tt>Depends</tt> field should also be used if the
  		<prgn>postinst</prgn>, <prgn>prerm</prgn> or
  		<prgn>postrm</prgn> scripts require the package to be
 -		present in order to run.  Note, however, that the
 -		<prgn>postrm</prgn> cannot rely on any non-essential
 -		packages to be present during the <tt>purge</tt>
 -		phase.
 +		present in order to run.  (If both packages are involved
 +		in a dependency loop, this might not work as expected; see
 +		the explanation a few paragraphs back.)  In the case of
 +		<prgn>postinst</prgn> and <prgn>postrm</prgn>, the
 +		depended-on packages will be unpacked and configured
 +		first.  (Note, however, that the <prgn>postrm</prgn>
 +		cannot rely on any non-essential packages to be present
 +		during the <tt>purge</tt> phase.)  In the case of
 +		<prgn>prerm</prgn>, the depended-on package will at least
 +		be unpacked (it might be configured too, but you can't
 +		rely on this unless you use <tt>Pre-Depends</tt>).
  	    </item>
  
  	    <tag><tt>Recommends</tt></tag>
@@@ -4588,17 -4609,7 +4616,17 @@@
  		to be <em>configured</em>, the pre-dependency will be
  		treated as a normal <tt>Depends</tt>, that is, it will
  		be considered satisfied only if the depended-on
 -		package has been correctly configured.
 +		package has been correctly configured.  However, unlike
 +		with <tt>Depends</tt>, <tt>Pre-Depends</tt> does not
 +		permit circular dependencies to be broken.  If a circular
 +		dependency is encountered while attempting to honor
 +		<tt>Pre-Depends</tt>, the installation will be aborted.
 +	      </p>
 +
 +	      <p>
 +		<tt>Pre-Depends</tt> are also required if the
 +		<prgn>preinst</prgn> script depends on the named package.
 +		It is best to avoid this situation if possible.
  	      </p>
  
  	      <p>
@@@ -4607,6 -4618,13 +4635,6 @@@
  		installation would hamper the ability of the system to
  		continue with any upgrade that might be in progress.
  	      </p>
 -
 -	      <p>
 -		<tt>Pre-Depends</tt> are also required if the
 -		<prgn>preinst</prgn> script depends on the named
 -		package.  It is best to avoid this situation if
 -		possible.
 -	      </p>
  	    </item>
  	  </taglist>
  	</p>
@@@ -4631,7 -4649,7 +4659,7 @@@
  	<p>
  	  When one binary package declares that it breaks another,
  	  <prgn>dpkg</prgn> will refuse to allow the package which
 -	  declares <tt>Breaks</tt> be installed unless the broken
 +	  declares <tt>Breaks</tt> be unpacked unless the broken
  	  package is deconfigured first, and it will refuse to
  	  allow the broken package to be reconfigured.
  	</p>
@@@ -4684,7 -4702,7 +4712,7 @@@
  	<p>
            When one binary package declares a conflict with another
  	  using a <tt>Conflicts</tt> field, <prgn>dpkg</prgn> will
 -	  refuse to allow them to be installed on the system at the
 +	  refuse to allow them to be unpacked on the system at the
  	  same time.  This is a stronger restriction than <tt>Breaks</tt>,
  	  which just prevents both packages from being configured at the
  	  same time.  Conflicting packages cannot be unpacked on the
@@@ -4692,8 -4710,8 +4720,8 @@@
  	</p>
  
  	<p>
 -	  If one package is to be installed, the other must be removed
 -	  first.  If the package being installed is marked as replacing
 +	  If one package is to be unpacked, the other must be removed
 +	  first.  If the package being unpacked is marked as replacing
  	  (see <ref id="replaces">, but note that <tt>Breaks</tt> should
  	  normally be used in this case) the one on the system, or the one
  	  on the system is marked as deselected, or both packages are
@@@ -4966,7 -4984,7 +4994,7 @@@ Provides: mail-transport-agen
  Conflicts: mail-transport-agent
  Replaces: mail-transport-agent
  	    </example>
 -	    ensuring that only one MTA can be installed at any one
 +	    ensuring that only one MTA can be unpacked at any one
  	    time.  See <ref id="virtual"> for more information about this
  	    example.
  	</sect1>
@@@ -5185,7 -5203,7 +5213,7 @@@
           <footnote>
  	    <p>
  	      During install or upgrade, the preinst is called before
 -	      the new files are installed, so calling "ldconfig" is
 +	      the new files are unpacked, so calling "ldconfig" is
  	      pointless.  The preinst of an existing package can also be
  	      called if an upgrade fails.  However, this happens during
  	      the critical time when a shared libs may exist on-disk
@@@ -5330,7 -5348,7 +5358,7 @@@
  	<ref id="conflicts">) to ensure that the user only installs one
  	development version at a time (as different development versions are
  	likely to have the same header files in them, which would cause a
 -	filename clash if both were installed).
 +	filename clash if both were unpacked).
        </p>
  
        <p>
@@@ -9391,14 -9409,15 +9419,15 @@@ END-INFO-DIR-ENTR
  
  	<p>
  	  Packages distributed under the Apache license (version 2.0), the
- 	  Artistic license, the GNU GPL (version 2 or 3), the GNU LGPL
- 	  (versions 2, 2.1, or 3), and the GNU FDL (versions 1.2 or 1.3)
- 	  should refer to the corresponding files
+ 	  Artistic license, the GNU GPL (versions 1, 2, or 3), the GNU
+ 	  LGPL (versions 2, 2.1, or 3), and the GNU FDL (versions 1.2 or
+ 	  1.3) should refer to the corresponding files
  	  under <file>/usr/share/common-licenses</file>,<footnote>
  	    <p>
  	      In particular,
                <file>/usr/share/common-licenses/Apache-2.0</file>,
                <file>/usr/share/common-licenses/Artistic</file>,
+               <file>/usr/share/common-licenses/GPL-1</file>,
                <file>/usr/share/common-licenses/GPL-2</file>,
                <file>/usr/share/common-licenses/GPL-3</file>,
                <file>/usr/share/common-licenses/LGPL-2</file>,
@@@ -9668,7 -9687,7 +9697,7 @@@
  	<p>
  	  The <prgn>DEBIAN</prgn> directory will not appear in the
  	  file system archive of the package, and so won't be installed
 -	  by <prgn>dpkg</prgn> when the package is installed.
 +	  by <prgn>dpkg</prgn> when the package is unpacked.
  	</p>
  
  	<p>