chiark / gitweb /
provide proper l10n for SGML date entities; now we have &date-<LANG>
[developers-reference.git] / developers-reference.sgml
index a16315578dc105b9cd3d3bad14584e972940013c..af1aca2b1911645413d314b5c6f7c33ae64bd6ad 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.50 $">
+  <!entity cvs-rev "$Revision: 1.58 $">
 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->
@@ -30,7 +30,7 @@
       <author>Adam Di Carlo, current maintainer <email>aph@debian.org</email>
       <author>Christian Schwarz <email>schwarz@debian.org</email>
       <author>Ian Jackson <email>ijackson@gnu.ai.mit.edu</email>
-      <version>ver. &version;, &date;
+      <version>ver. &version;, &date-en;
 
       <copyright>
        <copyrightsummary>
@@ -76,12 +76,10 @@ 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
@@ -319,20 +317,19 @@ to remove the ``on vacation'' flag when you come back.
       <sect id="upstream-coordination">Coordination With Upstream Developers
        <p>
 A big part of your job as Debian maintainer will be to stay in contact
-with the upstream developers since you'll have to share information that
-you get from the Bug Tracking System. It's not your job to fix non-Debian
-specific bugs.
-Rather, you have to forward these bugs to the upstream developers.
-(Of course, if you are able to do so, you may certainly fix them...)
-This way, the bug will hopefully
-be corrected when the next upstream version comes out.
+with the upstream developers.  Debian users will sometimes report bugs
+to the Bug Tracking System that are not specific to Debian.  You
+must forward these bug reports to the upstream developers so that
+they can be fixed in a future release.  It's not your job to fix
+non-Debian specific bugs.  However, if you are able to do so, you are
+encouraged to contribute to upstream development of the package by
+providing a fix for the bug.  Debian users and developers will often
+submit patches to fix upstream bugs, and you should evaluate and
+forward these patches upstream.
         <p>
-From time to
-time, you may get a patch attached to a bug report.  You have to send the
-patch upstream and make sure that it gets included (if the authors accept
-the proposed fix). If you need to modify the upstream sources in order to
-build a policy conformant package, then you should propose a nice fix 
-to the upstream developers which can be included there, so that you won't have to
+If you need to modify the upstream sources in order to build a policy
+conformant package, then you should propose a nice fix to the upstream
+developers which can be included there, so that you won't have to
 modify the sources of the next upstream version. Whatever changes you
 need, always try not to fork from the upstream sources.
 
@@ -348,7 +345,7 @@ id="&url-debian-qa;" name="Debian Quality Assurance"> effort are
 following those bugs and try to help you each time they can. But if
 you can't fix such bugs within 2 weeks, you should either ask for help
 by sending a mail to the Quality Assurance (QA) group
-(&email-debian-qa;) or justify yourself and present your plan to fix
+&email-debian-qa;, or justify yourself and present your plan to fix
 it by sending a mail to the bug concerned report. Otherwise people
 from the QA group may want to do a Non-Maintainer Upload (see
 <ref id="nmu">) after trying to contact you (they might not wait as long as
@@ -929,9 +926,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.
@@ -1087,7 +1084,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
@@ -1102,7 +1099,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
@@ -1522,7 +1541,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
@@ -1580,7 +1599,7 @@ NMU of the source package ``foo_1.3-1'' would be numbered
 ``foo_1.3-1.0.1''.
        <p>
 The way to invoke <prgn>dpkg-buildpackage</prgn> is as
-<tt>dpkg-buildpackage -B -m<var>porter-email</var></tt>.  Of course,
+<tt>dpkg-buildpackage -B -e<var>porter-email</var></tt>.  Of course,
 set <var>porter-email</var> to your email address.  This will do a
 binary-only build of only the architecture-dependant portions of the
 package, using the `binary-arch' target in <file>debian/rules</file>.
@@ -1711,8 +1730,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
@@ -1753,8 +1772,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.
@@ -1764,8 +1783,8 @@ obsolete name.
 If you can no longer maintain a package, you need to inform the others
 about that, and see that the package is marked as orphaned.
 you should set the package maintainer to <tt>Debian QA Group
-&lt;debian-qa@lists.debian.org&gt;</tt> and submit a bug report
-against the pseudo package <tt>wnpp</tt>.  The bug report should be
+&orphan-address;</tt> and submit a bug report
+against the pseudo package <package>wnpp</package>.  The bug report should be
 titled <tt>O: <var>package</var> -- <var>short description</var></tt>
 indicating that the package is now orphaned.  The severity of the bug
 should be set to <em>normal</em>.  If the package is especially