chiark / gitweb /
- dpkg-dev-el: new section
authoraph <aph@313b444b-1b9f-4f58-a734-7bb04f332e8d>
Mon, 8 Apr 2002 06:35:18 +0000 (06:35 +0000)
committeraph <aph@313b444b-1b9f-4f58-a734-7bb04f332e8d>
Mon, 8 Apr 2002 06:35:18 +0000 (06:35 +0000)
    - Ch "Package uploads":
      - new Sec "Adding an entry to debian/changelog"
      - rename Sec "Announcing new packages" to "New packages"
    - crypto is in main, non-US is for patent restrictions, so:
      - excise some text from "Registering as a Debian developer"
      - changes in Sec "Uploading to ftp-master"
      - changes in Sec "Uploading to non-US"

git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@1544 313b444b-1b9f-4f58-a734-7bb04f332e8d

debian/changelog
developers-reference.sgml

index 5d562c9d97124ff79115881b1e65add4059e74af..e024e1b994ff49a1c5fbec2f3fbca60f4725f82e 100644 (file)
@@ -1,9 +1,9 @@
-developers-reference (2.10.1) unstable; urgency=low
+developers-reference (2.11) unstable; urgency=low
 
   * Antoine Hulin:
     - some grammar corrections
     - update French translation
-  * from Martin Michlmayr
+  * Martin Michlmayr:
     - changes in upload situation, not possible to remove from Incoming
       anymore; closes: #135559
     - also talk about dput a tiny bit
@@ -16,10 +16,19 @@ developers-reference (2.10.1) unstable; urgency=low
       - debhelper: don't talk about debmake; mention how to get info on the dh-* pkgs
       - dput: new section, closes: #129378
       - debootstrap: new section, closes: #129377
+      - dpkg-dev-el: new section
       - other minor wording changes
     - Sec "Mailing Lists": where to find private archives, closes: #96780
-
- -- Adam Di Carlo <aph@debian.org>  Sun,  7 Apr 2002 22:38:09 -0700
+    - Ch "Package uploads":
+      - new Sec "Adding an entry to debian/changelog"
+      - rename Sec "Announcing new packages" to "New packages"
+    - crypto is in main, non-US is for patent restrictions, so:
+      - excise some text from "Registering as a Debian developer"
+      - changes in Sec "Uploading to ftp-master"
+      - changes in Sec "Uploading to non-US"
+  * old bugs closed out, closes: #110573
+
+ -- Adam Di Carlo <aph@debian.org>  Sun,  7 Apr 2002 23:34:08 -0700
 
 developers-reference (2.10.0) unstable; urgency=low
 
index cd1afddb347d697430027bdb87dc2786e2936cea..af972e7fc7ae67b7b5508c071192ec50b7277b37 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.86 $">
+  <!entity cvs-rev "$Revision: 1.87 $">
 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->
@@ -204,11 +204,6 @@ That document contains instructions on how to put your key on the
 public key servers.  The New Maintainer Group will put your public key
 on the servers if it isn't already there.
        <p>
-Due to export restrictions by the United States government some Debian
-packages, including <package>gnupg</package>, are located on ftp sites
-outside of the United States. You can find the current locations of
-those packages at <url id="&url-readme-non-us;">.
-       <p>
 Some countries restrict the use of cryptographic software by their
 citizens.  This need not impede one's activities as a Debian package
 maintainer however, as it may be perfectly legal to use cryptographic
@@ -482,7 +477,7 @@ full, suspicious activity, or whatever, send an email to
        <p>
 The ftp-master server, <tt>ftp-master.debian.org</tt> (or
 <tt>auric.debian.org</tt>), holds the canonical copy of the Debian
-archive (excluding the non-U.S. packages). Generally, package uploads
+archive (excluding the non-US packages). Generally, package uploads
 go to this server; see <ref id="upload">.
        <p>
 Problems with the Debian FTP archive generally need to be reported as
@@ -875,7 +870,7 @@ symbolic links for <em>stable</em>, <em>testing</em>, and
 
     <chapt id="upload">Package uploads
 
-      <sect>Announcing new packages
+      <sect>New packages
        <p>
 If you want to create a new package for the Debian distribution, you
 should first check the <url id="&url-wnpp;" name="Work-Needing and
@@ -927,6 +922,39 @@ The announcements give maintainers and other interested parties a
 better feel of what is going on, and what is new, in the project.
          </list>
 
+      <sect id="changelog-entries">
+        <heading>Adding an entry to <file>debian/changelog</file></heading>
+         <p>
+Changes that you make to the package need to be recorded in the
+<file>debian/changelog</file>.  These changes should provide a concise
+description of what was changed, why (if it's in doubt), and note if
+any bugs were closed.  They also record when the packages was
+completed.  This file will be installed in
+<file>/usr/share/doc/<var>package</var>/changelog.Debian.gz</file>, or
+<file>/usr/share/doc/<var>package</var>/changelog.gz</file> for native
+packages.
+         <p>
+The <file>debian/changelog</file> file conform to a certain structure,
+with a number of different fields.  One field of note, the
+<em>distribution</em>, is described in <ref id="upload-dist">.  More
+information about the structure structure of this file can be found in
+the Debian Policy section titled "<file>debian/changelog</file>".
+         <p>
+Changelog entries can be used to automatically close Debian bugs when
+the package is installed into the archive.  See <ref
+id="upload-bugfix">.
+         <p>
+It is conventional that the changelog entry notating that the package
+contains a new upstream version of the software looks like this:
+<example>
+  * new upstream version
+</example>
+         <p>
+There are tools to help you create entries and finalize the
+<file>changelog</file> for release &mdash; see <ref id="devscripts">
+and <ref id="dpkg-dev-el">.
+
+
 
       <sect id="upload-checking">Checking the package prior to upload
          <p>
@@ -1120,14 +1148,14 @@ directory on <tt>ftp-master</tt> and then move them to
 <tt>&us-upload-dir;</tt>.
           <p>
 <em>Note:</em> Do not upload to <tt>ftp-master</tt> packages
-containing software that is export-controlled by the United States
-government, nor to the overseas upload queues on <tt>chiark</tt> or
-<tt>erlangen</tt>.  This prohibition covers almost all cryptographic
-software, and even sometimes software that contains ``hooks'' to
-cryptographic software, such as electronic mail readers that support
-PGP encryption and authentication.  Uploads of such software should go
-to <tt>non-us</tt> (see <ref id="upload-non-us">).  If you are not
-sure whether U.S. export controls apply to your package, post a
+containing software that is patent-restricted by the United States
+government, any cryptographic packages which belong in
+<em>contrib</em> or <em>non-free</em>.  If you can't upload it to
+<tt>ftp-master</tt>, then neither can you upload it to the overseas
+upload queues on <tt>chiark</tt> or <tt>erlangen</tt>.  Uploads of
+such software should go to <tt>non-us</tt> (see <ref
+id="upload-non-us">).  If you are not sure whether U.S. patent
+controls or cryptographic controls apply to your package, post a
 message to &email-debian-devel; and ask.
          <p>
 You may also find the Debian packages <package>dupload</package> or
@@ -1146,25 +1174,28 @@ file: <example>dinstall -n foo.changes</example>
        <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 <prgn>rsync</prgn>
-to copy the package to <ftpsite>non-us.debian.org</ftpsite>, placing
-the files in <tt>&non-us-upload-dir;</tt>. By default, you can
-use the same account/password that works on <tt>ftp-master</tt>.
-If you use anonymous FTP to upload, place the files into
-<ftppath>/pub/UploadQueue/</ftppath>.
-         <p>
-The program <prgn>dupload</prgn> comes with support for uploading to
-<tt>non-us</tt>; please refer to the documentation that comes with
-the program for details.
+to <tt>ftp-master</tt>.  Instead, upload the package to
+<ftpsite>non-us.debian.org</ftpsite>, placing the files in
+<tt>&non-us-upload-dir;</tt> (both <ref id="dupload"> and <ref
+id="dput"> can be used also, with the right invokation). By default,
+you can use the same account/password that works on
+<tt>ftp-master</tt>.  If you use anonymous FTP to upload, place the
+files into <ftppath>/pub/UploadQueue/</ftppath>.
          <p>
 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.
+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.  However, this
+restriction has been waived for software which is already available
+outside the U.S.  Therefore, any cryptographic software which belongs
+in the <em>main</em> section of the Debian archive and does not depend
+on any package outside of <em>main</em> (e.g., does not depend on
+anything in <em>non-US/main</em>) can be uploaded to ftp-master or its
+queues, described above.
          <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
@@ -1172,11 +1203,12 @@ 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.
+For packages in <em>non-US/main</em>, <em>non-US/contrib</em>,
+developers should at least follow the <url id="&url-u.s.-export;"
+name="procedure outlined by the US Government">.  Maintainers of
+<em>non-US/non-free</em> packages should further consult the <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
@@ -2291,6 +2323,17 @@ file from the command-line, and <prgn>debuild</prgn>, which is a
 wrapper around <prgn>dpkg-buildpackage</prgn>.
 
 
+
+      <sect id="dpkg-dev-el">
+       <heading><package>dpkg-dev-el</package>
+       <p>
+<package>dpkg-dev-el</package> is an Emacs lisp package which provides
+assistance when editing some of the files in the <file>debian</file>
+directory of your package.  For instance, when editing
+<file>debian/changelog</file>, there are handy functions for
+finalizing a version and listing the package's current bugs.
+
+
       <sect id="debget">
        <heading><package>debget</package>
        <p>
@@ -2303,8 +2346,6 @@ thing).
 
 <!-- FIXME: add the following
   dpkg-awk
-  dpkg-cross
-  dpkg-dev-el
   alien
   dpkg-repack
   grep-dctrl