]> git.donarmstrong.com Git - debian/debian-policy.git/blobdiff - policy.sgml
Clean, rename, and wrap Build-Depends
[debian/debian-policy.git] / policy.sgml
index b864726028f4be7a873cea2a04a183118b28976c..9037de81337d0b7b743214d0cb9f9b34b3c645c4 100644 (file)
        <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>
 
          The maintainer name and email address used in the changelog
          should be the details of the person uploading <em>this</em>
          version.  They are <em>not</em> necessarily those of the
-         usual package maintainer.  The information here will be
-         copied to the <tt>Changed-By</tt> field in the
-         <tt>.changes</tt> file (see <ref id="f-Changed-By">),
-         and then later used to send an acknowledgement when the
-         upload has been installed.
+         usual package maintainer.<footnote>
+           If the developer uploading the package is not one of the usual
+           maintainers of the package (as listed in
+           the <qref id="f-Maintainer"><tt>Maintainer</tt></qref>
+           or <qref id="f-Uploaders"><tt>Uploaders</tt></qref> control
+           fields of the package), the first line of the changelog is
+           conventionally used to explain why a non-maintainer is
+           uploading the package.  The Debian Developer's Reference
+           (see <ref id="related">) documents the conventions
+           used.</footnote>
+         The information here will be copied to the <tt>Changed-By</tt>
+         field in the <tt>.changes</tt> file
+         (see <ref id="f-Changed-By">), and then later used to send an
+         acknowledgement when the upload has been installed.
        </p>
 
        <p>
           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>
@@ -7614,7 +7636,7 @@ fname () {
            <item>The XSI extension to <prgn>trap</prgn> allowing numeric
              signals must be supported.  In addition to the signal
              numbers listed in the extension, which are the same as for
-             <prgn>kill<prgn> above, 13 (SIGPIPE) must be allowed.
+             <prgn>kill</prgn> above, 13 (SIGPIPE) must be allowed.
            </item>
          </list>
          If a shell script requires non-SUSv3 features from the shell