chiark / gitweb /
more purging of url-pkg-manual references
[developers-reference.git] / developers-reference.sgml
index 5ecbb3f39f9e6fe72cf535353a8816c5f45c688e..1a491c6db7fb95b49488a9a6e97837e42e5df0af 100644 (file)
@@ -5,7 +5,7 @@
   <!-- common, language independant entities -->
   <!entity % commondata  SYSTEM "common.ent" > %commondata;
   <!-- CVS revision of this document -->
-  <!entity cvs-rev "$Revision: 1.48 $">
+  <!entity cvs-rev "$Revision: 1.52 $">
 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->
@@ -34,7 +34,7 @@
 
       <copyright>
        <copyrightsummary>
-copyright &copy;1998, 1999 Adam Di Carlo</copyrightsummary>
+copyright &copy;1998 &ndash 2001 Adam Di Carlo</copyrightsummary>
        <copyrightsummary>
 copyright &copy;1997, 1998 Christian Schwarz</copyrightsummary>
        <p>
@@ -76,16 +76,15 @@ discussion of resources which can help maintainers with the quality of
 their packages (<ref id="tools">).
       <p>
 It should be clear that this reference does not discuss the technical
-details of the Debian package nor how to generate Debian packages;
-that information is discussed in the <url id="&url-pkg-manual;"
-name="Debian Packaging Manual">.  Nor does this reference detail the
-standards to which Debian software must comply; that information can
-be found in the <url id="&url-debian-policy;" name="Debian Policy
-Manual">.
+details of the Debian package nor how to generate Debian packages.
+Nor does this reference detail the standards to which Debian software
+must comply.  All of such information can be found in the <url
+id="&url-debian-policy;" name="Debian Policy Manual">.
       <p>
 Furthermore, this document is <em>not an expression of formal
-policy</em>.  It contains documentation for the Debian system, and
-generally agreed-upon best practices.
+policy</em>.  It contains documentation for the Debian system and
+generally agreed-upon best practices.  Thus, it is what is called a
+``normative'' document.
 
 
     <chapt id="new-maintainer">Applying to Become a Maintainer
@@ -928,9 +927,9 @@ The changes file is a control file with the following fields:
 &control-file-fields;
          <p>
 All of these fields are mandatory for a Debian upload.  See the list
-of control fields in the <url id="&url-pkg-manual;" name="Debian
-Packaging Manual"> for the contents of these fields.  You can close
-bugs automatically using the <tt>Description</tt> field, see <ref
+of control fields in the <url id="&url-debian-policy;" name="Debian
+Policy Manual"> for the contents of these fields.  You can close bugs
+automatically using the <tt>Description</tt> field, see <ref
 id="upload-bugfix">.  Only the <tt>Distribution</tt> field is
 discussed in this section, since it relates to the archive maintenance
 policies.
@@ -1086,7 +1085,7 @@ After uploading your package, you can check how the archive maintenance
 software will process it by running <prgn>dinstall</prgn> on your changes
 file: <example>dinstall -n foo.changes</example>
 
-       <sect1 id="upload-non-us">Uploading to <tt>non-us</tt> (pandora)
+       <sect1 id="upload-non-us">Uploading to <tt>non-US</tt> (pandora)
          <p>
 As discussed above, export controlled software should not be uploaded
 to <tt>ftp-master</tt>.  Instead, use <prgn>scp</prgn> or non-anonymous
@@ -1101,7 +1100,29 @@ the program for details.
 You can check your upload the same way it's done on <tt>ftp-master</tt>,
 with:
 <example>dinstall -n foo.changes</example>
-      
+         <p>
+Note that U.S. residents or citizens are subject to restrictions on
+export of cryptographic software. As of this writing, U.S. citizens are
+allowed to export some cryptographic software, subject to notification
+rules by the U.S. Department of Commerce.
+         <p>
+Debian policy does not prevent upload to non-US by U.S. residents or
+citizens, but care should be taken in doing so. It is recommended that
+developers take all necessary steps to ensure that they are not
+breaking current US law by doing an upload to non-US, <em>including
+consulting a lawyer</em>.
+         <p>
+For packages in non-US main or contrib, developers should at least
+follow the <url id="&url-u.s.-export;" name="procedure outlined by the
+US Government">.  Maintainers of non-US/non-free packages should
+further consult these <url id="url-notification-of-export" name="rules
+on notification of export"> of non-free software.
+         <p>
+This section is for information only and does not constitute legal
+advice. Again, it is strongly recommended that U.S. citizens and
+residents consult a lawyer before doing uploads to non-US.
+
+
        <sect1>Uploads via <tt>chiark</tt>
          <p>
 If you have a slow network connection to <tt>ftp-master</tt>, there are
@@ -1521,7 +1542,7 @@ of things you should check or be aware of.
            <item>
 Don't set architecture to a value other than ``all'' or ``any'' unless
 you really mean it.  In too many cases, maintainers don't follow the
-instructions in the <url id="&url-pkg-manual;" name="Debian Packaging
+instructions in the <url id="&url-debian-policy;;" name="Debian Policy
 Manual">.  Setting your architecture to ``i386'' is usually incorrect.
            <item>
 Make sure your source package is correct.  Do <tt>dpkg-source -x
@@ -1710,8 +1731,8 @@ belongs in.
        <p>
 If you need to change the section for one of your packages, change the
 package control information to place the package in the desired
-section, and re-upload the package (see the <url id="&url-pkg-manual;"
-name="Debian Packaging Manual"> for details).  Carefully examine the
+section, and re-upload the package (see the <url id="&url-debian-policy;"
+name="Debian Policy Manual"> for details).  Carefully examine the
 installation log sent to you when the package is installed into the
 archive.  If for some reason the old location of the package remains,
 file a bug against <tt>ftp.debian.org</tt> asking that the old
@@ -1752,8 +1773,8 @@ announce list (either &email-debian-changes; or
 Sometimes you made a mistake naming the package and you need to rename
 it.  In this case, you need to follow a two-step process.  First, set
 your <file>debian/control</file> file to replace and conflict with the
-obsolete name of the package (see the <url id="&url-pkg-manual;"
-name="Debian Packaging Manual"> for details).  Once you've uploaded
+obsolete name of the package (see the <url id="&url-debian-policy;"
+name="Debian Policy Manual"> for details).  Once you've uploaded
 that package, and the package has moved into the archive, file a bug
 against <tt>ftp.debian.org</tt> asking to remove the package with the
 obsolete name.
@@ -1965,6 +1986,21 @@ of Debian policy as well as some checks for common errors.  The use of
 id="upload-checking"> and <ref id="lintian-reports">.
 
 
+      <sect id="debconf">
+        <heading><package>debconf</package></heading>
+        <p>
+<package>debconf</package> provides a consistent interface to
+configuring packages interactively.  It is user interface
+intedependant, allowing end-users to configure packages with a
+text-only interface, an HTML interface, or a dialog interface.  New
+interfaces can be added modularly.
+        <p>
+Many feel that this system should be used for all packages requiring
+interactive configuration.  <package>debconf</package> is not
+currently required by Debian Policy, however, that may change in the
+future.
+
+
       <sect id="debhelper">
        <heading><package>debhelper</package>
        <p>