]> git.donarmstrong.com Git - debian/debian-policy.git/blobdiff - policy.sgml
Merge branch 'master' into bug23712-rra
[debian/debian-policy.git] / policy.sgml
index ca83a42cd68069b63073ed36c098a4d1630c5950..b61ab26140fc17f3735e0e085a67af520c6e4cb5 100644 (file)
@@ -15,7 +15,7 @@
 
       <abstract>
        This manual describes the policy requirements for the Debian
-       GNU/Linux distribution.  This includes the structure and
+       distribution.  This includes the structure and
        contents of the Debian archive and several design issues of
        the operating system, as well as technical requirements that
        each package must satisfy to be included in the distribution.
@@ -50,7 +50,7 @@
 
        <p>
          A copy of the GNU General Public License is available as
-         <file>/usr/share/common-licenses/GPL</file> in the Debian GNU/Linux
+         <file>/usr/share/common-licenses/GPL</file> in the Debian
          distribution or on the World Wide Web at
          <url id="http://www.gnu.org/copyleft/gpl.html"
               name="the GNU General Public Licence">. You can also
@@ -68,7 +68,7 @@
        <heading>Scope</heading>
        <p>
          This manual describes the policy requirements for the Debian
-         GNU/Linux distribution. This includes the structure and
+         distribution. This includes the structure and
          contents of the Debian archive and several design issues of the
          operating system, as well as technical requirements that
          each package must satisfy to be included in the
       <heading>The Debian Archive</heading>
 
       <p>
-       The Debian GNU/Linux system is maintained and distributed as a
+       The Debian system is maintained and distributed as a
        collection of <em>packages</em>. Since there are so many of
        them (currently well over 15000), they are split into
        <em>sections</em> and given <em>priorities</em> to simplify
       </p>
 
       <p>
-       The <em>main</em> archive area forms the <em>Debian GNU/Linux
-       distribution</em>.
+       The <em>main</em> archive area forms the <em>Debian distribution</em>.
       </p>
 
       <p>
       <heading>Binary packages</heading>
 
       <p>
-       The Debian GNU/Linux distribution is based on the Debian
+       The Debian distribution is based on the Debian
        package management system, called <prgn>dpkg</prgn>. Thus,
        all packages in the Debian distribution must be provided
        in the <tt>.deb</tt> file format.
        <heading>The maintainer of a package</heading>
 
        <p>
-         Every package must have a maintainer.  The maintainer may be one
-         person or a group of people reachable from a common email
-         address, such as a mailing list.  The maintainer is responsible
-         for maintaining the Debian packaging files, evaluating and
+         Every package must have a maintainer, except for orphaned
+         packages as described below.  The maintainer may be one person
+         or a group of people reachable from a common email address, such
+         as a mailing list.  The maintainer is responsible for
+         maintaining the Debian packaging files, evaluating and
          responding appropriately to reported bugs, uploading new
          versions of the package (either directly or through a sponsor),
          ensuring that the package is placed in the appropriate archive
        </p>
 
        <p>
-         If the maintainer of a package no longer has time or desire to
-         maintain a package, it should be orphaned according to the
-         procedure described in the Debian Developer's Reference
-         (see <ref id="related">).  The maintainer then
-         becomes <tt>Debian QA Group &lt;packages@qa.debian.org&gt;</tt>.
+         An orphaned package is one with no current maintainer.  Orphaned
+         packages should have their <tt>Maintainer</tt> control field set
+         to <tt>Debian QA Group &lt;packages@qa.debian.org&gt;</tt>.
          These packages are considered maintained by the Debian project
          as a whole until someone else volunteers to take over
-         maintenance.
+         maintenance.<footnote>
+           The detailed procedure for gracefully orphaning a package can
+           be found in the Debian Developer's Reference
+           (see <ref id="related">).
+         </footnote>
        </p>
       </sect>
 
 
        <p>
          The <tt>base system</tt> is a minimum subset of the Debian
-         GNU/Linux system that is installed before everything else
+         system that is installed before everything else
          on a new system. Only very few packages are allowed to form
          part of the base system, in order to keep the required disk
          usage very small.
           identical behavior.
        </p>
 
+       <p>
+         The following targets are required and must be implemented
+         by <file>debian/rules</file>: <tt>clean</tt>, <tt>binary</tt>,
+         <tt>binary-arch</tt>, <tt>binary-indep</tt>, and <tt>build</tt>.
+         These are the targets called by <prgn>dpkg-buildpackage</prgn>.
+       </p>
+
        <p>
          Since an interactive <file>debian/rules</file> script makes it
-         impossible to auto-compile that package and also makes it
-         hard for other people to reproduce the same binary
-         package, all <em>required targets</em> must be
-         non-interactive. At a minimum, required targets are the
-         ones called by <prgn>dpkg-buildpackage</prgn>, namely,
-         <em>clean</em>, <em>binary</em>, <em>binary-arch</em>,
-         <em>binary-indep</em>, and <em>build</em>. It also follows
-         that any target that these targets depend on must also be
+         impossible to auto-compile that package and also makes it hard
+         for other people to reproduce the same binary package, all
+         required targets must be non-interactive.  It also follows that
+         any target that these targets depend on must also be
          non-interactive.
        </p>
 
        <p>
-         The targets are as follows (required unless stated otherwise):
+         The targets are as follows:
          <taglist>
-           <tag><tt>build</tt></tag>
+           <tag><tt>build</tt> (required)</tag>
            <item>
              <p>
                The <tt>build</tt> target should perform all the
              </p>
            </item>
 
-           <tag><tt>binary</tt>, <tt>binary-arch</tt>,
-             <tt>binary-indep</tt>
+           <tag><tt>binary</tt> (required), <tt>binary-arch</tt>
+             (required), <tt>binary-indep</tt> (required)
            </tag>
            <item>
              <p>
              </p>
            </item>
 
-           <tag><tt>clean</tt></tag>
+           <tag><tt>clean</tt> (required)</tag>
            <item>
              <p>
                This must undo any effects that the <tt>build</tt>
 
        <p>
          The architectures we build on and build for are determined
-         by <prgn>make</prgn> variables using the utility
-         <qref id="pkg-dpkg-architecture"><prgn>dpkg-architecture</prgn></qref>.
-         You can determine the
-         Debian architecture and the GNU style architecture
-         specification string for the build machine (the machine type
-         we are building on) as well as for the host machine (the
-         machine type we are building for).  Here is a list of
-         supported <prgn>make</prgn> variables:
+         by <prgn>make</prgn> variables using the
+         utility <qref id="pkg-dpkg-architecture"><prgn>dpkg-architecture</prgn></qref>.
+         You can determine the Debian architecture and the GNU style
+         architecture specification string for the build architecture as
+         well as for the host architecture.  The build architecture is
+         the architecture on which <file>debian/rules</file> is run and
+         the package build is performed.  The host architecture is the
+         architecture on which the resulting package will be installed
+         and run.  These are normally the same, but may be different in
+         the case of cross-compilation (building packages for one
+         architecture on machines of a different architecture).
+       </p>
+
+       <p>
+         Here is a list of supported <prgn>make</prgn> variables:
          <list compact="compact">
            <item>
                <tt>DEB_*_ARCH</tt> (the Debian architecture)
                <tt>DEB_*_GNU_TYPE</tt>)
          </list>
          where <tt>*</tt> is either <tt>BUILD</tt> for specification of
-         the build machine or <tt>HOST</tt> for specification of the
-         host machine.
+         the build architecture or <tt>HOST</tt> for specification of the
+         host architecture.
        </p>
 
        <p>
@@ -7936,22 +7948,6 @@ ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq
        <sect1>
          <heading>Sharing configuration files</heading>
 
-         <p>
-           Packages which specify the same file as a
-           <tt>conffile</tt> must be tagged as <em>conflicting</em>
-           with each other.  (This is an instance of the general rule
-           about not sharing files.  Note that neither alternatives
-           nor diversions are likely to be appropriate in this case;
-           in particular, <prgn>dpkg</prgn> does not handle diverted
-           <tt>conffile</tt>s well.)
-         </p>
-
-         <p>
-           The maintainer scripts must not alter a <tt>conffile</tt>
-           of <em>any</em> package, including the one the scripts
-           belong to.
-         </p>
-
          <p>
            If two or more packages use the same configuration file
            and it is reasonable for both to be installed at the same
@@ -8001,6 +7997,34 @@ ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq
            and which manages the shared configuration files.  (The
            <tt>sgml-base</tt> package is a good example.)
          </p>
+
+         <p>
+           If the configuration file cannot be shared as described above,
+           the packages must be marked as conflicting with each other.
+           Two packages that specify the same file as
+           a <tt>conffile</tt> must conflict.  This is an instance of the
+           general rule about not sharing files.  Neither alternatives
+           nor diversions are likely to be appropriate in this case; in
+           particular, <prgn>dpkg</prgn> does not handle diverted
+           <tt>conffile</tt>s well.
+         </p>
+
+         <p>
+           When two packages both declare the same <tt>conffile</tt>, they
+           may see left-over configuration files from each other even
+           though they conflict with each other.  If a user removes
+           (without purging) one of the packages and installs the other,
+           the new package will take over the <tt>conffile</tt> from the
+           old package.  If the file was modified by the user, it will be
+           treated the same as any other locally
+           modified <tt>conffile</tt> during an upgrade.
+         </p>
+
+         <p>
+           The maintainer scripts must not alter a <tt>conffile</tt>
+           of <em>any</em> package, including the one the scripts
+           belong to.
+         </p>
        </sect1>
 
        <sect1>
@@ -9549,8 +9573,7 @@ END-INFO-DIR-ENTRY
        <p>
          Packages in the <em>contrib</em> or <em>non-free</em> archive
          areas should state in the copyright file that the package is not
-         part of the Debian GNU/Linux distribution and briefly explain
-         why.
+         part of the Debian distribution and briefly explain why.
        </p>
 
        <p>
@@ -9721,9 +9744,8 @@ END-INFO-DIR-ENTRY
        <prgn>dpkg</prgn> is a suite of programs for creating binary
        package files and installing and removing them on Unix
        systems.<footnote>
-           <prgn>dpkg</prgn> is targeted primarily at Debian
-           GNU/Linux, but may work on or be ported to other
-           systems.
+           <prgn>dpkg</prgn> is targeted primarily at Debian, but may
+           work on or be ported to other systems.
        </footnote>
       </p>