]> git.donarmstrong.com Git - debian/debian-policy.git/blobdiff - policy.sgml
Release policy 3.9.7.0
[debian/debian-policy.git] / policy.sgml
index a489febaa605ae786d987686b0d4f7ffe22bb27a..404dc7373f80cdc20bf793e064d7163e3885518f 100644 (file)
          <enumlist>
            <item>Russ Allbery</item>
            <item>Bill Allombert</item>
-           <item>Andrew McMillan</item>
-           <item>Manoj Srivastava</item>
-           <item>Colin Watson</item>
+           <item>Andreas Barth</item>
+           <item>Jonathan Nieder</item>
          </enumlist>
         </p>
 
@@ -1746,11 +1745,14 @@ zope.
 
        <p>
          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.<footnote>
-           If the developer uploading the package is not one of the usual
-           maintainers of the package (as listed in
+         should be the details of the person who prepared this release of
+         the package.  They are <em>not</em> necessarily those of the
+         uploader or usual package maintainer.<footnote>
+           In the case of a sponsored upload, the uploader signs the
+           files, but the changelog maintainer name and address are those
+           of the person who prepared this release.  If the preparer of
+           the release 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
@@ -1929,6 +1931,10 @@ zope.
          any target that these targets depend on must also be
          non-interactive.
        </p>
+       <p>
+          For packages in the main archive, no required targets
+          may attempt network access.
+       </p>
 
        <p>
          The targets are as follows:
@@ -2556,7 +2562,9 @@ Package: libc6
          the field name is <tt>Package</tt> and the field value
          <tt>libc6</tt>.
        </p>
-
+        <p> Empty field values are only permitted in source package control files
+         (<file>debian/control</file>). Such fields are ignored.
+        </p>
        <p>
          A paragraph must not contain more than one instance of a
          particular field name.
@@ -2699,6 +2707,7 @@ Package: libc6
          file. These tools are responsible for removing the line
          breaks from such fields when using fields from
          <file>debian/control</file> to generate other control files.
+         They are also responsible for discarding empty fields.
        </p>
 
        <p>
@@ -3673,7 +3682,7 @@ Files:
          <p>
            The special value <tt>byhand</tt> for the section in a
            <tt>.changes</tt> file indicates that the file in question
-           is not an ordinary package file and must by installed by
+           is not an ordinary package file and must be installed by
            hand by the distribution maintainers.  If the section is
            <tt>byhand</tt> the priority should be <tt>-</tt>.
          </p>
@@ -6972,8 +6981,18 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
                   <footnote>
                     This is necessary in order to reserve the directories for
                     use in cross-installation of library packages from other
-                    architectures, as part of the planned deployment of
-                    <tt>multiarch</tt>.
+                    architectures, as part of <tt>multiarch</tt>.
+                  </footnote>
+                </p>
+                <p>
+                  The requirement for C and C++ headers files to be
+                  accessible through the search path
+                  <file>/usr/include/</file> is amended, permitting files to
+                  be accessible through the search path
+                  <file>/usr/include/<var>triplet</var></file> where
+                  <tt><var>triplet</var></tt> is as above.  <footnote>
+                    This is necessary for architecture-dependant headers
+                    file to coexist in a <tt>multiarch</tt> setup.
                   </footnote>
                 </p>
                 <p>
@@ -7042,12 +7061,20 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
                    kernel information.</footnote>
                </p>
              </item>
+             <item>
+                <p>
+                  The <file>/var/www</file> directory is additionally allowed. 
+                </p>
+             </item>
              <item>
                <p>
-                 The requirement for <file>/usr/local/lib&lt;qual&gt;</file>
-                 to exist if <file>/lib&lt;qual&gt</file> or
-                 <file>/usr/lib&lt;qual&gt</file> exists is removed.
-               </p>
+                  The requirement for <file>/usr/local/lib&lt;qual&gt;</file>
+                  to exist if <file>/lib&lt;qual&gt;</file> or
+                  <file>/usr/lib&lt;qual&gt;</file> exists (where 
+                  <file>lib&lt;qual&gt;</file> is a variant of
+                  <file>lib</file> such as <file>lib32</file> or
+                  <file>lib64</file>) is removed.
+                  </p>
              </item>
              <item>
                <p>
@@ -7329,6 +7356,35 @@ rmdir /usr/local/share/emacs 2>/dev/null || true
              </item>
 
              <tag>65535:</tag>
+             <item>
+               <p>
+                 This value <em>must not</em> be used, because it was
+                 the error return sentinel value when <tt>uid_t</tt>
+                 was 16 bits.
+               </p>
+             </item>
+
+             <tag>65536-4294967293:</tag>
+             <item>
+               <p>
+                 Dynamically allocated user accounts.  By
+                 default <prgn>adduser</prgn> will not allocate UIDs
+                 and GIDs in this range, to ease compatibility with
+                 legacy systems where <tt>uid_t</tt> is still 16
+                 bits.
+               </p>
+             </item>
+
+             <tag>4294967294:</tag>
+             <item>
+               <p>
+                  <tt>(uid_t)(-2) == (gid_t)(-2)</tt> <em>must not</em> be
+                  used, because it is used as the anonymous, unauthenticated
+                  user by some NFS implementations.
+               </p>
+             </item>
+
+             <tag>4294967295:</tag>
              <item>
                <p>
                  <tt>(uid_t)(-1) == (gid_t)(-1)</tt> <em>must
@@ -8452,7 +8508,17 @@ fi
          renamed.  If a consensus cannot be reached, <em>both</em>
          programs must be renamed.
        </p>
-
+       <p>
+          Binary executables must not be statically linked with the GNU C
+          library, since this prevents the binary from benefiting from
+          fixes and improvements to the C library without being rebuilt
+          and complicates security updates.  This requirement may be
+          relaxed for binary executables whose intended purpose is to
+          diagnose and fix the system in situations where the GNU C
+          library may not be usable (such as system recovery shells or
+          utilities like ldconfig) or for binary executables where the
+          security benefits of static linking outweigh the drawbacks.
+       </p>
        <p>
          By default, when a package is being built, any binaries
          created should include debugging information, as well as
@@ -8861,6 +8927,7 @@ fname () {
            would point to <file>/srv/run</file> rather than the intended
            target.
          </footnote>
+         Symbolic links must not traverse above the root directory.
        </p>
 
        <p>
@@ -9759,7 +9826,7 @@ http://localhost/cgi-bin/.../<var>cgi-bin-name</var>
                <package>doc-base</package> package.  If access to the
                web document root is unavoidable then use
                <example compact="compact">
-/var/www
+/var/www/html
                </example>
                as the Document Root.  This might be just a symbolic
                link to the location where the system administrator
@@ -10595,45 +10662,77 @@ END-INFO-DIR-ENTRY
        </p>
       </sect>
 
-      <sect>
+      <sect id="docs-additional">
        <heading>Additional documentation</heading>
 
        <p>
-         Any additional documentation that comes with the package may
-         be installed at the discretion of the package maintainer.
-         Plain text documentation should be installed in the directory
-         <file>/usr/share/doc/<var>package</var></file>, where
-         <var>package</var> is the name of the package, and
-          compressed with <tt>gzip -9</tt> unless it is small.
-        </p>
+         Any additional documentation that comes with the package may be
+         installed at the discretion of the package maintainer.  It is
+         often a good idea to include text information files
+         (<file>README</file>s, FAQs, and so forth) that come with the
+         source package in the binary package.  However, you don't need
+         to install the instructions for building and installing the
+         package, of course!
+       </p>
 
        <p>
-         If a package comes with large amounts of documentation which
-         many users of the package will not require you should create
-         a separate binary package to contain it, so that it does not
-         take up disk space on the machines of users who do not need
-         or want it installed.</p>
+         Plain text documentation should be compressed with <tt>gzip
+         -9</tt> unless it is small.
+       </p>
 
        <p>
-         It is often a good idea to put text information files
-         (<file>README</file>s, changelogs, and so forth) that come with
-         the source package in <file>/usr/share/doc/<var>package</var></file>
-         in the binary package.  However, you don't need to install
-         the instructions for building and installing the package, of
-         course!</p>
+         If a package comes with large amounts of documentation that many
+         users of the package will not require, you should create a
+         separate binary package to contain it so that it does not take
+         up disk space on the machines of users who do not need or want
+         it installed.  As a special case of this rule, shared library
+         documentation of any appreciable size should always be packaged
+         with the library development package (<ref id="sharedlibs-dev">)
+         or in a separate documentation package, since shared libraries
+         are frequently installed as dependencies of other packages by
+         users who have little interest in documentation of the library
+         itself.  The documentation package for the
+         package <var>package</var> is conventionally
+         named <var>package</var>-doc
+         (or <var>package</var>-doc-<var>language-code</var> if there are
+         separate documentation packages for multiple languages).
+       </p>
+
+       <p>
+         Additional documentation included in the package should be
+         installed under <file>/usr/share/doc/<var>package</var></file>.
+         If the documentation is packaged separately,
+         as <var>package</var>-doc for example, it may be installed under
+         either that path or into the documentation directory for the
+         separate documentation package
+         (<file>/usr/share/doc/<var>package</var>-doc</file> in this
+         example).  However, installing the documentation into the
+         documentation directory of the main package is preferred since
+         it is independent of the packaging method and will be easier for
+         users to find.
+       </p>
+
+       <p>
+         Any separate package providing documentation must still install
+         standard documentation files in its
+         own <file>/usr/share/doc</file> directory as specified in the
+         rest of this policy.  See, for example, <ref id="copyrightfile">
+         and <ref id="changelogs">.
+       </p>
 
        <p>
          Packages must not require the existence of any files in
          <file>/usr/share/doc/</file> in order to function
          <footnote>
-             The system administrator should be able to
-             delete files in <file>/usr/share/doc/</file> without causing
-             any programs to break.
-         </footnote>.
-         Any files that are referenced by programs but are also
-         useful as stand alone documentation should be installed under
-         <file>/usr/share/<var>package</var>/</file> with symbolic links from
-         <file>/usr/share/doc/<var>package</var></file>.
+           The system administrator should be able to delete files
+           in <file>/usr/share/doc/</file> without causing any programs
+           to break.
+         </footnote>.  Any files that are used or read by programs but
+         are also useful as stand alone documentation should be installed
+         elsewhere, such as
+         under <file>/usr/share/<var>package</var>/</file>, and then
+         included via symbolic links
+         in <file>/usr/share/doc/<var>package</var></file>.
        </p>
 
        <p>
@@ -10653,18 +10752,6 @@ END-INFO-DIR-ENTRY
             </p>
           </footnote>
        </p>
-
-       <p>
-         Former Debian releases placed all additional documentation
-         in <file>/usr/doc/<var>package</var></file>.  This has been
-         changed to <file>/usr/share/doc/<var>package</var></file>,
-         and packages must not put documentation in the directory
-         <file>/usr/doc/<var>package</var></file>. <footnote>
-           At this phase of the transition, we no longer require a
-           symbolic link in <file>/usr/doc/</file>. At a later point,
-           policy shall change to make the symbolic links a bug.
-         </footnote>
-       </p>
       </sect>
 
       <sect>
@@ -10675,16 +10762,16 @@ END-INFO-DIR-ENTRY
          via HTML.</p>
 
        <p>
-         If your package comes with extensive documentation in a
+         If the package comes with extensive documentation in a
          markup format that can be converted to various other formats
          you should if possible ship HTML versions in a binary
-         package, in the directory
-         <file>/usr/share/doc/<var>appropriate-package</var></file> or
-         its subdirectories.<footnote>
-             The rationale: The important thing here is that HTML
-             docs should be available in <em>some</em> package, not
-             necessarily in the main binary package.
+         package.<footnote>
+             Rationale: The important thing here is that HTML
+             documentation should be available from <em>some</em>
+             binary package.
          </footnote>
+         The documentation must be installed as specified in
+         <ref id="docs-additional">.
        </p>
 
        <p>