]> git.donarmstrong.com Git - debian/debian-policy.git/blobdiff - policy.sgml
Merge branch 'master' into bug23712-rra
[debian/debian-policy.git] / policy.sgml
index 25a5fe644f09f3cfd7760b8f926bf2ccc0e1daa5..a65989742a8bd5591f1547788094cb38defbfc0c 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
           The actual editing is done by a group of maintainers that have
           no editorial powers. These are the current maintainers:
 
-          <enumlist>
-            <item>Julian Gilbey</item>
-            <item>Branden Robinson</item>
-            <item>Josip Rodin</item>
-            <item>Manoj Srivastava</item>
-          </enumlist>
+         <enumlist>
+           <item>Russ Allbery</item>
+           <item>Bill Allombert</item>
+           <item>Andrew McMillan</item>
+           <item>Manoj Srivastava</item>
+           <item>Colin Watson</item>
+         </enumlist>
         </p>
 
        <p>
       <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>
        <sect1 id="main">
          <heading>The main archive area</heading>
 
+         <p>
+           The <em>main</em> archive area comprises the Debian
+           distribution.  Only the packages in this area are considered
+           part of the distribution.  None of the packages in
+           the <em>main</em> archive area require software outside of
+           that area to function.  Anyone may use, share, modify and
+           redistribute the packages in this archive area
+           freely<footnote>
+             See <url id="http://www.debian.org/intro/free"
+                      name="What Does Free Mean?"> for
+             more about what we mean by free software.
+           </footnote>.
+         </p>
+
          <p>
            Every package in <em>main</em> must comply with the DFSG
            (Debian Free Software Guidelines).
        <sect1 id="contrib">
          <heading>The contrib archive area</heading>
 
+         <p>
+           The <em>contrib</em> archive area contains supplemental
+           packages intended to work with the Debian distribution, but
+           which require software outside of the distribution to either
+           build or function.
+         </p>
+
          <p>
            Every package in <em>contrib</em> must comply with the DFSG.
          </p>
            </list>
          </p>
 
-
          <p>
            Examples of packages which would be included in
            <em>contrib</em> are:
        <sect1 id="non-free">
          <heading>The non-free archive area</heading>
 
+         <p>
+           The <em>non-free</em> archive area contains supplemental
+           packages intended to work with the Debian distribution that do
+           not comply with the DFSG or have other problems that make
+           their distribution problematic.  They may not comply with all
+           of the policy requirements in this manual due to restrictions
+           on modifications or other limitations.
+         </p>
+
          <p>
            Packages must be placed in <em>non-free</em> if they are
            not compliant with the DFSG or are encumbered by patents
       <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.
 
       </sect>
 
-      <sect>
+      <sect id="dependencies">
        <heading>Dependencies</heading>
 
        <p>
 
        <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.
@@ -2536,6 +2565,7 @@ Package: libc6
            <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
            <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
            <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
+           <item><qref id="f-DM-Upload-Allowed"><tt>DM-Upload-Allowed</tt></qref></item>
            <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
            <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
            <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
@@ -2641,6 +2671,7 @@ Package: libc6
          <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
          <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
          <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
+         <item><qref id="f-DM-Upload-Allowed"><tt>DM-Upload-Allowed</tt></qref></item>
          <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
          <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
          <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
@@ -3632,6 +3663,21 @@ Checksums-Sha256:
            must match the list of files in the <tt>Files</tt> field.
          </p>
        </sect1>
+
+       <sect1 id="f-DM-Upload-Allowed">
+         <heading><tt>DM-Upload-Allowed</tt></heading>
+
+         <p>
+           The most recent version of a package uploaded to unstable or
+           experimental must include the field <tt>DM-Upload-Allowed:
+           yes</tt> in the source section of its source control file for
+           the Debian archive to accept uploads signed with a key in the
+           Debian Maintainer keyring.  See the General
+           Resolution <url id="http://www.debian.org/vote/2007/vote_003"
+           name="Endorse the concept of Debian Maintainers"> for more
+           details.
+         </p>
+       </sect1>
       </sect>
 
       <sect>
@@ -3981,7 +4027,7 @@ fi
                in <prgn>postrm</prgn> purges the <prgn>debconf</prgn>
                configuration for the package
                if <package>debconf</package> is installed.
-             </foonote>
+             </footnote>
            </item>
 
            <tag><var>new-postrm</var> <tt>failed-upgrade</tt>
@@ -4849,6 +4895,13 @@ Build-Depends: foo [linux-any], bar [any-i386], baz [!linux-any]
                installation would hamper the ability of the system to
                continue with any upgrade that might be in progress.
              </p>
+
+             <p>
+               You should not specify a <tt>Pre-Depends</tt> entry for a
+               package before this has been discussed on the
+               <tt>debian-devel</tt> mailing list and a consensus about
+               doing that has been reached.  See <ref id="dependencies">.
+             </p>
            </item>
          </taglist>
        </p>
@@ -5487,12 +5540,9 @@ Replaces: mail-transport-agent
          library directories of the dynamic linker (which are currently
          <file>/usr/lib</file> and <file>/lib</file>) or a directory that is
          listed in <file>/etc/ld.so.conf</file><footnote>
-           These are currently
-           <list compact="compact">
-             <item>/usr/local/lib</item>
-             <item>/usr/lib/libc5-compat</item>
-             <item>/lib/libc5-compat</item>
-           </list>
+           These are currently <file>/usr/local/lib</file> plus
+           directories under <file>/lib</file> and <file>/usr/lib</file>
+           matching the multiarch triplet for the system architecture.
          </footnote>
          must use <prgn>ldconfig</prgn> to update the shared library
          system.
@@ -6105,13 +6155,13 @@ install -m644 debian/shlibs.<var>package</var> debian/<var>package</var>/DEBIAN/
                   <file>/lib/<var>triplet</var></file> and
                   <file>/usr/lib/<var>triplet</var></file>, where
                   <tt><var>triplet</var></tt> is the value returned by
-                  <tt>dpkg-architecture -qDEB_HOST_GNU_TYPE</tt> for the
+                  <tt>dpkg-architecture -qDEB_HOST_MULTIARCH</tt> for the
                   architecture of the package.  Packages may <em>not</em>
                   install files to any <var>triplet</var> path other
                   than the one matching the architecture of that package;
                   for instance, an <tt>Architecture: amd64</tt> package
                   containing 32-bit x86 libraries may not install these
-                  libraries to <file>/usr/lib/i486-linux-gnu</file>.
+                  libraries to <file>/usr/lib/i386-linux-gnu</file>.
                   <footnote>
                     This is necessary in order to reserve the directories for
                     use in cross-installation of library packages from other
@@ -6161,9 +6211,21 @@ install -m644 debian/shlibs.<var>package</var> debian/<var>package</var>/DEBIAN/
                   to get access to kernel information.</footnote>
                 </p>
               </item>
+             <item>
+               <p>
+                 On GNU/Hurd systems, the following additional
+                 directories are allowed in the root
+                 filesystem: <file>/hurd</file>
+                 and <file>/servers</file>.<footnote>
+                   These directories are used to store translators and as
+                   a set of standard names for mount points,
+                   respectively.
+                 </footnote>
+               </p>
+             </item>
             </enumlist>
-
           </p>
+
           <p>
             The version of this document referred here can be
            found in the <tt>debian-policy</tt> package or on <url
@@ -8070,22 +8132,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
@@ -8135,6 +8181,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>
@@ -9006,9 +9080,9 @@ name ["<var>syshostname</var>"]:
 
               <item>
                   If the window manager complies with <url
-                   id="http://www.freedesktop.org/Standards/wm-spec"
+                   id="http://www.freedesktop.org/wiki/Specifications/wm-spec"
                    name="The Window Manager Specification Project">,
-                  written by the <url id="http://www.freedesktop.org/"
+                  written by the <url id="http://www.freedesktop.org/wiki/"
                    name="Free Desktop Group">, add 40 points.
               </item>
 
@@ -9423,13 +9497,13 @@ name ["<var>syshostname</var>"]:
           maintainer of the package is allowed to write this bug report
           themselves, if they so desire).  Do not close the bug report
           until a proper man page is available.<footnote>
-              It is not very hard to write a man page. See the
+             It is not very hard to write a man page. See the
              <url id="http://www.schweikhardt.net/man_page_howto.html"
                name="Man-Page-HOWTO">,
-             <manref name="man" section="7">, the examples
-              created by <prgn>debmake</prgn> or <prgn>dh_make</prgn>,
-             the helper program <prgn>help2man</prgn>, or the
-              directory <file>/usr/share/doc/man-db/examples</file>.
+             <manref name="man" section="7">, the examples created
+             by <prgn>dh_make</prgn>, the helper
+             program <prgn>help2man</prgn>, or the
+             directory <file>/usr/share/doc/man-db/examples</file>.
           </footnote>
        </p>
 
@@ -9683,8 +9757,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>
@@ -9855,9 +9928,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>
 
@@ -9902,13 +9974,10 @@ END-INFO-DIR-ENTRY
       </p>
 
       <p>
-       The Debian version of the FSF's GNU hello program is provided
-       as an example for people wishing to create Debian
-       packages. The Debian <prgn>debmake</prgn> package is
-       recommended as a very helpful tool in creating and maintaining
-       Debian packages. However, while the tools and examples are
-       helpful, they do not replace the need to read and follow the
-       Policy and Programmer's Manual.</p>
+       The Debian version of the FSF's GNU hello program is provided as
+       an example for people wishing to create Debian packages. However,
+       while the examples are helpful, they do not replace the need to
+       read and follow the Policy and Programmer's Manual.</p>
     </appendix>
 
     <appendix id="pkg-binarypkg">