chiark / gitweb /
replaced evil latin1-only «» quotation marks, replaced mentions of important severity...
[developers-reference.git] / developers-reference.sgml
index 7a19db8931a77659aff1c1eba7d8dcbf098b3c6c..4149d206a6f458a9055d7d99d77e2e2eb154f539 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.43 $">
+  <!entity cvs-rev "$Revision: 1.46 $">
 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->
@@ -310,9 +310,9 @@ In order to inform the other developers, there's two things that you should do.
 First send a mail to &email-debian-private; giving the period of time when
 you will be on vacation.  You can also give some special instructions on what to
 do if any problem occurs. Next you should update your information
-available in the Debian LDAP database and mark yourself as « on vacation »
+available in the Debian LDAP database and mark yourself as ``on vacation''
 (this information is only accessible to debian developers). Don't forget
-to remove the « on vacation » flag when you come back.
+to remove the ``on vacation'' flag when you come back.
 
       <sect id="upstream-coordination">Coordination With Upstream Developers
        <p>
@@ -336,9 +336,9 @@ need, always try not to fork from the upstream sources.
 
       <sect id="rc-bugs">Managing Release Critical Bugs
         <p>
-Release Critical Bugs (RCB) are the bugs of severity
-«&nbsp;critical&nbsp;», «&nbsp;grave&nbsp;» and
-«&nbsp;important&nbsp;». Those bugs can delay the Debian release
+Release Critical Bugs (RCB) are all bugs that have severity
+<em>critical</em>, <em>grave</em> or <em>serious</em>.
+Those bugs can delay the Debian release
 and/or can justify the removal of a package at freeze time. That's why
 those bugs needs to be corrected as fast as possible.  You must be
 aware that some developers who are part of the <url
@@ -419,7 +419,7 @@ other mailing lists are available for a variety of special topics; see
 <url id="&url-debian-lists-subscribe;"> for a list.  Cross-posting
 (sending the same message to multiple lists) is discouraged.
        <p>
-&email-debian-private; is a special mailing lists for private
+&email-debian-private; is a special mailing list for private
 discussions amongst Debian developers.  It is meant to be used for
 posts which for whatever reason should not be published publically.
 As such, it is a low volume list, and users are urged not to use
@@ -486,17 +486,17 @@ an email to &email-ftpmaster;, but also see the procedures in
       <sect1 id="servers-www">The WWW server
        <p>
 The main web server, <tt>www.debian.org</tt>, is also known as
-<tt>va.debian.org</tt>.  All developers are given accounts on this
+<tt>klecker.debian.org</tt>.  All developers are given accounts on this
 machine.
        <p>
 If you have some Debian-specific information which you want to serve
 up on the web, you can do this by putting material in the
-<file>public_html</file> directory under your home directory.  You can
-do this on <tt>va.debian.org</tt>. Any material you put in those areas
+<file>public_html</file> directory under your home directory.  You should
+do this on <tt>klecker.debian.org</tt>. Any material you put in those areas
 are accessible via the URL
-<tt>http://www.debian.org/~<var>user-id</var>/</tt>.
-If necessary, you can use other Debian machines for this; the procedure
-is analogous to the above. Please do not put any material on Debian
+<tt>http://people.debian.org/~<var>user-id</var>/</tt>.
+You should only use this particular location because it will be backed up,
+whereas on other hosts it won't. Please do not put any material on Debian
 servers not relating to Debian, unless you have prior permission.
 Send mail to &email-debian-devel; if you have any questions.
        <p>
@@ -509,7 +509,7 @@ else has already reported the problem on the
 
       <sect1 id="servers-cvs">The CVS server
        <p>
-<tt>cvs.debian.org</tt> is also known as <tt>va.debian.org</tt>,
+<tt>cvs.debian.org</tt> is also known as <tt>klecker.debian.org</tt>,
 discussed above.  If you need to use a publically accessible CVS
 server, for instance, to help coordinate work on a package between
 many different developers, you can request a CVS area on the server.
@@ -521,8 +521,7 @@ be accessed read-only via the Web at <url id="&url-cvsweb;">.
        <p>
 To request a CVS area, send a request via email to
 &email-debian-admin;.  Include the name of the requested CVS area,
-what <tt>va.debian.org</tt> user account should own the CVS root area,
-and why you need it.
+Debian account should own the CVS root area, and why you need it.
 
 
       <sect1 id="servers-mirrors">Mirrors of Debian servers
@@ -799,11 +798,11 @@ area, so that testers can get early access.
          <p>
 However, using <em>experimental</em> as a personal staging area is not
 always the best idea.  You can't replace or upgrade the files in there
-on your own (<prgn>dinstall</prgn> and the Debian archive maintainers
-do that).  Additionally, you'll have to remember to ask the archive
+on your own (it is done with Debian archive maintenance software).
+Additionally, you'll have to remember to ask the archive
 maintainers to delete the package once you have uploaded it to
 <em>unstable</em>.  Using your personal web space on
-<tt>va.debian.org</tt> is generally a better idea, so that you put
+<tt>klecker.debian.org</tt> is generally a better idea, so that you put
 less strain on the Debian archive maintainers.
 
 
@@ -863,7 +862,7 @@ prospective package and the current URL where it can be downloaded
 from.  You should set the subject of the bug to ``ITP: <var>foo</var>
 -- <var>short description</var>'', substituting the name of the new
 package for <var>foo</var>.  The severity of the bug report must be
-set to <em>normal</em>.  Please include a <tt>Closes:
+set to <em>wishlist</em>.  Please include a <tt>Closes:
 bug#<var>nnnnn</var></tt> entry on the changelog of the new package in
 order for the bug report to be automatically closed once the new
 package is installed on the archive (<ref id="upload-bugfix">).
@@ -977,15 +976,15 @@ some guidelines:
 <list>
                <item>
 Fixes for bugs of severity <em>critical</em>, <em>grave</em>, or
-<em>important</em> severity are always allowed for those packages that
+<em>serious</em> severity are always allowed for those packages that
 must exist in the final release
                <item>
-<em>critical</em>, <em>grave</em>, and <em>important</em> bug fixes
-are only allowed for non-necessary packages if they don't add any new
+<em>critical</em>, <em>grave</em>, and <em>serious</em> bug fixes are
+allowed for non-necessary packages but only if they don't add any new
 features
                <item>
-normal bug fixes are allowed (though discouraged) on all packages if
-and only if there are no new features
+important, normal and minor bug fixes are allowed (though discouraged)
+on all packages if and only if there are no new features
                <item>
 wishlist fixes are not allowed (they are, after all, not really bugs)
                <item>
@@ -1060,9 +1059,9 @@ defaults for uploading via <prgn>ftp</prgn> to <tt>ftp-master</tt>,
 use <prgn>ssh</prgn> or <prgn>rsync</prgn>.  See <manref name="dupload"
 section="1"> and <manref name="dupload" section="5"> for more information.
          <p>
-After uploading your package, you can check how dinstall will
-process it by running dinstall on your changes file:
-<example>/org/ftp.debian.org/scripts/dinstall/dinstall -n foo.changes</example>
+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)
          <p>
@@ -1076,11 +1075,9 @@ 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.
          <p>
-Similar to the way it's done on <tt>ftp-master</tt>, you can check your
-upload with:
-<example>
-/org/non-us.debian.org/scripts/dinstall/dinstall -n foo.changes
-</example>
+You can check your upload the same way it's done on <tt>ftp-master</tt>,
+with:
+<example>dinstall -n foo.changes</example>
       
        <sect1>Uploads via <tt>chiark</tt>
          <p>
@@ -1145,10 +1142,10 @@ anonymous FTP to <url id="&url-upload-jp;">.
       <sect id="upload-announce">Announcing package uploads
        <p>
 When a package is uploaded, an announcement should be posted to one of
-the ``debian-changes'' lists. This is now done automatically by
-<tt>dinstall</tt> when it runs (usually once a day).  You just need to
-use a recent <package>dpkg-dev</package> (&gt;= 1.4.1.2). The mail
-generated by <tt>dinstall</tt> will contain the PGP/GPG signed
+the ``debian-changes'' lists. This is now done automatically by the archive
+maintenance software when it runs (usually once a day). You just need to use
+a recent <package>dpkg-dev</package> (&gt;= 1.4.1.2). The mail generated by
+the archive maintenance software will contain the PGP/GPG signed 
 <tt>.changes</tt> files that you uploaded with your package.
 Previously, <prgn>dupload</prgn> used to send those announcements, so
 please make sure that you configured your <prgn>dupload</prgn> not to
@@ -1176,12 +1173,13 @@ announcement to the right list.  See <ref id="dupload">.
        <p>
 The Debian archive maintainers are responsible for handling package
 uploads.  For the most part, uploads are automatically handled on a
-daily basis by an archive maintenance tool called
-<prgn>dinstall</prgn>.  Specifically, updates to existing packages to
+daily basis by archive maintenance tools `dak'
+(also referred to as <prgn>katie</prgn> or <prgn>dinstall</prgn>).
+Specifically, updates to existing packages to
 the `unstable' distribution are handled automatically. In other cases,
 notably new packages, placing the uploaded package into the
 distribution is handled manually. When uploads are handled manually,
-the change to the archive may take up to a week to occur.  Please be
+the change to the archive may take up to a month to occur. Please be
 patient.
        <p>
 In any case, you will receive email notification indicating that the
@@ -1289,7 +1287,7 @@ cannot be reached in time, the Security Manager may upload a fixed
 package (i.e., do a source NMU).
        <p>
 During the release freeze (see <ref id="upload-frozen">), NMUs which
-fix important or higher severity bugs are encouraged and accepted.
+fix serious or higher severity bugs are encouraged and accepted.
 Even during this window, however, you should endeavor to reach the
 current maintainer of the package; they might be just about to upload
 a fix for the problem.  As with any source NMU, the guidelines found
@@ -1500,10 +1498,8 @@ 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="http://www.debian.org/doc/packaging-manuals/packaging.html/"
-name="Debian Packaging Manual">.  Setting your architecture to ``i386''
-is usually incorrect.
+instructions in the <url id="&url-pkg-manual;" name="Debian Packaging
+Manual">.  Setting your architecture to ``i386'' is usually incorrect.
            <item>
 Make sure your source package is correct.  Do <tt>dpkg-source -x
 <var>package</var>.dsc</tt> to make sure your source package unpacks
@@ -1590,7 +1586,7 @@ the porting effort, at the discretion of the porter group.  (Remember,
 none of this is Policy, just mutually agreed upon guidelines.)
          <p>
 Secondly, porters doing source NMUs should make sure that the bug they
-submit to the BTS should be of severity `important' or greater.  This
+submit to the BTS should be of severity `serious' or greater.  This
 ensures that a single source package can be used to compile every
 supported Debian architecture by release time.  It is very important
 that we have one version of the binary and source package for all
@@ -1697,13 +1693,13 @@ 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
 location be removed.  Give details on what you did, since it might be
-a <prgn>dinstall</prgn> bug.
+a bug in the archive maintenance software.
        <p>
 If, on the other hand, you need to change the <em>subsection</em> of
 one of your packages (e.g., ``devel'', ``admin''), the procedure is
 slightly different.  Correct the subsection as found in the control
-file of the package, and reupload that.  Also, you'll need to update
-the override file, as described in <ref id="override-file">.
+file of the package, and reupload that.  Also, you'll need to get the
+override file updated, as described in <ref id="override-file">.
 
 
       <sect id="removing-pkgs">Removing packages
@@ -1776,9 +1772,10 @@ without leave), post a query to &email-debian-private;.
 If you take over an old package, you probably want to be listed as the
 package's official maintainer in the bug system. This will happen
 automatically once you upload a new version with an updated
-<tt>Maintainer:</tt> field, although it can take a couple of weeks. If
-you do not expect to upload a new version for a while, send an email
-to &email-override; so that bug reports will go to you right away.
+<tt>Maintainer:</tt> field, although it can take a few hours after the
+upload is done. If you do not expect to upload a new version for a while,
+send an email to &email-override; so that bug reports will go to you
+right away.
 
 
 
@@ -1793,9 +1790,9 @@ packages.  The BTS contains all the open bugs against your packages.
        <p>
 Maintainers interact with the BTS via email addresses at
 <tt>bugs.debian.org</tt>.  Documentation on available commands can be
-found at <url id="http://www.debian.org/Bugs/">, or, if you have
-installed the <package>debian-doc</package> package, you can look at
-the local files <file>/usr/doc/debian/bug-*</file>.
+found at <url id="&url-bts;">, or, if you have installed the
+<package>doc-debian</package> package, you can look at the local files
+<file>/usr/doc/debian/bug-*</file>.
        <p>
 Some find it useful to get periodic reports on open bugs.  You can add
 a cron job such as the following if you want to get a weekly email
@@ -1846,10 +1843,10 @@ been accepted into the Debian archive.  Therefore, once you get
 notification that your updated package has been installed into the
 archive, you can and should close the bug in the BTS.
        <p>
-If you are using a new version of <package>dpkg-dev</package> and you
-do your changelog entry properly, <prgn>dinstall</prgn> will close the
-bugs automatically.  All you have to do is follow a certain syntax
-in your <file>debian/changelog</file> file:
+If you are using a new version of <package>dpkg-dev</package> and you do
+your changelog entry properly, the archive maintenance software will close
+the bugs automatically.  All you have to do is follow a certain syntax in
+your <file>debian/changelog</file> file:
 <example>
 acme-cannon (3.1415) unstable; urgency=low