<!-- common, language independant entities -->
<!entity % commondata SYSTEM "common.ent" > %commondata;
<!-- CVS revision of this document -->
- <!entity cvs-rev "$Revision: 1.39 $">
+ <!entity cvs-rev "$Revision: 1.79 $">
<!-- if you are translating this document, please notate the RCS
revision of the developers reference here -->
<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>
-copyright ©1998, 1999 Adam Di Carlo</copyrightsummary>
+copyright ©1998 &ndash 2001 Adam Di Carlo</copyrightsummary>
<copyrightsummary>
copyright ©1997, 1998 Christian Schwarz</copyrightsummary>
<p>
General Public License for more details.
<p>
A copy of the GNU General Public License is available as &file-GPL; in
-the Debian GNU/Linux distribution or on the World Wide Web at <url
+the &debian-formal; distribution or on the World Wide Web at <url
id="&url-gpl;" name="the GNU website">. You can also obtain it by
writing to the &fsf-addr;.
The resources discussed in this reference include the mailing lists
and servers (<ref id="servers">); a discussion of the structure of the
Debian archive (<ref id="archive">); explanation of the different
-servers which accept package uploads (<ref id="upload-master">); and a
+servers which accept package uploads (<ref id="upload-ftp-master">); and a
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
Linux People IRC network (e.g., <tt>irc.debian.org</tt>) can also be
helpful.
+ <p>
+When you know how you want to contribute to &debian-formal;, you
+should get in contact with existing Debian maintainers who are working
+on similar tasks. That way, you can learn from experienced developers.
+For example, if you are interested in packaging existing software for
+Debian you should try to get a sponsor. A sponsor will work together
+with you on your package and upload it to the Debian archive once he
+is happy with the packaging work you have done. You can find a sponsor
+by mailing the &email-debian-mentors; mailing list, describing your
+package and yourself and asking for a sponsor (see <ref id="sponsoring">
+for more information on sponsoring). On the other hand, if you are
+interested in porting Debian to alternative architectures or kernels
+you can subscribe to port specific mailing lists and ask there how to
+get started. Finally, if you are interested in documentation or
+Quality Assurance (QA) work you can join maintainers already working on
+these tasks and submit patches and improvements.
+
<sect id="registering">Registering as a Debian developer
<p>
-Before you decide to register with the Debian Project, you will need
-to read the <url id="&url-social-contract;" name="Debian Social
-Contract">. Registering as a developer means that you agree with and
-pledge to uphold the Debian Social Contract; it is very important that
-maintainers are in accord with the essential ideas behind Debian
-GNU/Linux. Reading the <url id="&url-gnu-manifesto;" name="GNU
+Before you decide to register with &debian-formal;, you will need to
+read all the information available at the <url id="&url-newmaint;"
+name="New Maintainer's Corner">. It describes exactly the
+preparations you have to do before you can register to become a Debian
+developer.
+
+For example, before you apply, you have to to read the <url
+id="&url-social-contract;" name="Debian Social Contract">.
+Registering as a developer means that you agree with and pledge to
+uphold the Debian Social Contract; it is very important that
+maintainers are in accord with the essential ideas behind
+&debian-formal;. Reading the <url id="&url-gnu-manifesto;" name="GNU
Manifesto"> would also be a good idea.
<p>
The process of registering as a developer is a process of verifying
-your identity and intentions. As the number of people working on
-Debian GNU/Linux has grown to over &number-of-maintainers; people and
-our systems are used in several very important places we have to be
-careful about being compromised. Therefore, we need to verify new
-maintainers before we can give them accounts on our servers and
-letting them upload packages.
- <p>
-Registration requires that the following information be sent to
-&email-new-maintainer; as part of the registration application:
-<list>
- <item>
-Your name.
- <item>
-Your preferred login name on <tt>master</tt> (eight characters or
-less), as well as the email address at which you'd prefer to be
-subscribed to &email-debian-private; (typically this will be either
-your primary mail address or your new <tt>debian.org</tt> address).
- <item>
-A phone number where we can call you. Remember that the new
-maintainer team usually calls during evening hours to save on long
-distance tolls. Please do not give a work number, unless you are
-generally there in the evening.
- <item>
-A statement of intention, that is, what package(s) you intend to work
-on, which Debian port you will be assisting, or how you intend to
-contribute to Debian.
- <item>
-A statement that you have read and agree to uphold the <url
-id="&url-social-contract;" name="Debian Social Contract">.
- <item>
-Some mechanism by which we can verify your real-life identity. For
-example, any of the following mechanisms would suffice:
-<list>
- <item>
-An OpenPGP key signed by any well-known signature, such as:
-<list>
- <item>
-Any current Debian developer you have met <em>in real life</em>.
- <item>
-Any formal certification service (such as Verisign, etc.) that
-verifies your identity. A certification that verifies your email
-address, and not you identity, is not sufficient.
- </list>
- <item>
-Alternatively, you may identify yourself with a scanned (or physically
-mailed) copy of any formal documents certifying your identity (such as
-a birth certificate, national ID card, U.S. Driver's License, etc.).
-If emailed, please sign the mail with your OpenPGP key.
- </list>
- </list>
+your identity and intentions, and checking your technical skills. As
+the number of people working on &debian-formal; has grown to over
+&number-of-maintainers; people and our systems are used in several
+very important places we have to be careful about being compromised.
+Therefore, we need to verify new maintainers before we can give them
+accounts on our servers and let them upload packages.
+ <p>
+Before you actually register you should have shown that you can do
+competent work and will be a good contributor. You can show this by
+submitting patches through the Bug Tracking System or having a package
+sponsored by an existing maintainer for a while. Also, we expect that
+contributors are interested in the whole project and not just in
+maintaining their own packages. If you can help other maintainers by
+providing further information on a bug or even a patch, then do so!
+ <p>
+Registration requires that you are familiar with Debian's philosophy
+and technical documentation. Furthermore, you need a GPG key which
+has been signed by an existing Debian maintainer. If your GPG key
+is not signed yet, you should try to meet a Debian maintainer in
+person to get your key signed. There's a <url id="&url-gpg-coord;"
+name="GPG Key Signing Coordination page"> which should help you find
+a maintainer close to you (If you cannot find a Debian maintainer
+close to you, there's an alternative way to pass the ID check. You
+can send in a photo ID signed with your GPG key. Having your GPG
+key signed is the preferred way, however. See the
+<url id="&url-newmaint-id;" name="identification page"> for more
+information about these two options.)
+
<p>
If you do not have an OpenPGP key yet, generate one. Every developer
needs a OpenPGP key in order to sign and verify package uploads. You
much important information which is critical to its security. Many
more security failures are due to human error than to software failure
or high-powered spy techniques. See <ref id="key-maint"> for more
-information on maintianing your public key.
+information on maintaining your public key.
<p>
Debian uses the <prgn>GNU Privacy Guard</prgn> (package
<package>gnupg</package> version 1 or better as its baseline standard.
ID; this prevents user ID tampering. <prgn>gpg</prgn> does this
automatically.
<p>
-Also remember that one of the names on your key must match the email
-address you list as the official maintainer for your packages. For
-instance, I set the maintainer of the
-<package>developers-reference</package> package to ``Adam Di Carlo
-<aph@debian.org>''; therefore, one of the user IDs on my key is
-that same value, ``Adam Di Carlo <aph@debian.org>''.
- <p>
If your public key isn't on public key servers such as &pgp-keyserv;,
please read the documentation available locally in &file-keyservs;.
That document contains instructions on how to put your key on the
citizens. This need not impede one's activities as a Debian package
maintainer however, as it may be perfectly legal to use cryptographic
products for authentication, rather than encryption purposes (as is
-the case in France). The Debian Project does not require the use of
+the case in France). &debian-formal; does not require the use of
cryptography <em>qua</em> cryptography in any manner. If you live in a
country where use of cryptography even for authentication is forbidden
then please contact us so we can make special arrangements.
<p>
-Once you have all your information ready, and your public key is
-available on public key servers, send a message to
-&email-new-maintainer; to register as an offical Debian developer so
-that you will be able to upload your packages. This message must
-contain all the information discussed above. The message must also
-contain your public key (extracted using <tt>gpg --armor --export
-<var>user_id</var></tt> in the case of <prgn>gpg</prgn>) for the
-database of keys which is distributed from
-<url id="&url-debian-keyring;"> and the <package>debian-keyring</package>
-package. Please be sure to sign your request message with your chosen
-public key.
- <p>
-Once this information is received and processed, you should be
-contacted with information about your new Debian maintainer account.
-If you don't hear anything within a month, please send a followup
-message asking if your original application was received. Do
-<em>not</em> re-send your original application, that will just confuse
-the New Maintainer Group. Please be patient, especially near release
-points; mistakes do occasionally happen, and people do sometimes run
-out of volunteer time.
+When you are ready to apply, you need an existing Debian maintainer
+to verify your application (an <em>advocate</em>). After you have
+contributed to Debian for a while, and you want to apply to become a
+registered developer, an existing developer with whom you
+have worked over the past months has to express his belief that you
+can contribute to Debian successfully.
+ <p>
+When you have found an advocate, have your GPG key signed and have
+already contributed to Debian for a while, you're ready to apply.
+You can simply register on our <url id="&url-newmaint-apply;"
+name="application page">. After you have signed up, your advocate
+has to confirm your application. When your advocate has completed
+this step you will be assigned an Application Manager who will
+go with you through the necessary steps of the New Maintainer process.
+You can always check your status on the <url id="&url-newmaint-db;"
+name="applications status board">.
+ <p>
+For more details, please consult <url id="&url-newmaint;" name="New
+Maintainer's Corner"> at the Debian web site. Make sure that you
+are familiar with the necessary steps of the New Maintainer process
+before actually applying. If you are prepared well, you can save
+a lot of timer later on.
<sect id="mentors">Debian Mentors
There's a LDAP database containing many informations concerning all
developers, you can access it at <url id="&url-debian-db;">. You can
update your password (this password is propagated to most of the machines
-that are accessible to you), your adress, your country, the latitude and
-longitude from the point where you live, phone and fax numbers, your
+that are accessible to you), your address, your country, the latitude and
+longitude of the point where you live, phone and fax numbers, your
preferred shell, your IRC nickname, your web page and the email that
you're using as alias for your debian.org email. Most of the information
is not accessible to the public, for more details about this
database, please read its online documentation that you can find
-here : <url id="&url-debian-db-doc;">.
+at <url id="&url-debian-db-doc;">.
<p>
You have to keep the information available there up to date.
Read the documentation that comes with your software; read the <url
id="&url-pgp-faq;" name="PGP FAQ">.
<p>
-If you add or remove signatures from your public key, or add or remove
-user identities, you need to update the key servers and mail your
-public key to &email-debian-keyring;. The same key extraction
-routines discussed in <ref id="registering"> apply.
+If you add signatures to your public key, or add user identities, you
+can update the debian keyring by sending your key to the key server at
+<tt>&keyserver-host;</tt>. If you need to add a completely new key,
+or remove an old key, send mail to &email-debian-keyring;. The same
+key extraction routines discussed in <ref id="registering"> apply.
<p>
You can find a more in-depth discussion of Debian key maintenance in
the documentation for the <package>debian-keyring</package> package.
<sect id="inform-vacation">Going On Vacation Gracefully
<p>
-Most of the developers take vacation, usually this means that they can't
+Most developers take vacations, and usually this means that they can't
work for Debian and they can't be reached by email if any problem occurs.
The other developers need to know that you're on vacation so that they'll
do whatever is needed when such a problem occurs. Usually this means that
-other developers are allowed to NMU your package if a big problem (release
-critical bugs, security update, ...) occurs while you're on vacation.
+other developers are allowed to NMU (see <ref id="nmu">) your package if a
+big problem (release critical bugs, security update, ...) occurs while
+you're on vacation.
<p>
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 »
+you will be on vacation. You can also give some special instructions on what to
+do if any problem occurs. Be aware that some people don't care for vacation
+notices and don't want to read them; you should prepend "[VAC] " to the
+subject of your message so that it can be easily filtered.
+ <p>
+Next you should update your information
+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>
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 so you have to forward the bugs to the upstream developers
-(of course, if you are able to fix them, you can ...). This way the bug
-may be corrected when the next upstream version comes out. 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 so that you won't have to
+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>
+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.
<sect id="rc-bugs">Managing Release Critical Bugs
<p>
-Release Critical Bugs (RCB) are the bugs of severity « critical »,
-« grave » and « important ». 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
-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 gives your plan to fix it by sending a mail to the
-concerned bug report. Otherwise people from the QA group may want to do a
-Non Maintainer Upload (NMU) after trying to contact you (they might wait
-not as long as usually before they do their NMU if they have seen no
-recent activity from you on the BTS).
+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
+these bugs need to be corrected as quickly as possible. You must be
+aware that some developers who are part of the <url
+id="&url-debian-qa;" name="Debian Quality Assurance"> effort are
+following those bugs and try to help you whenever they are able. 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 explain your difficulties and present a plan to fix
+them by sending a mail to the proper bug 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
+usual before they do their NMU if they have seen no recent activity from you
+in the BTS).
<sect id="qa-effort">Quality Assurance Effort
<p>
-Even if there is a dedicated group of people for Quality Assurance, QA is
-not reserved to them. You can participate to this effort by keeping your
-packages as bug free as possible, as lintian-clean (see <ref
-id="lintian-reports">) as possible. If you think that it's quite impossible,
-then you should consider orphaning (see <ref id="orphaning">) some of your
-packages so that you can do a good job with the other packages that you
-maintain. Alternatively you may ask the help of other people in order to
-catch up the backlog of bugs that you have (you can ask for help on
-&email-debian-qa; or &email-debian-devel;).
+Even though there is a dedicated group of people for Quality
+Assurance, QA duties are not reserved solely for them. You can
+participate in this effort by keeping your packages as bug-free as
+possible, and as lintian-clean (see <ref id="lintian-reports">) as
+possible. If you do not find that possible, then you should consider
+orphaning some of your packages (see <ref
+id="orphaning">). Alternatively, you may ask the help of other people
+in order to catch up the backlog of bugs that you have (you can ask
+for help on &email-debian-qa; or &email-debian-devel;).
+
+ <sect id="mia-qa">Dealing with unreachable maintainers
+ <p>
+If you notice that a package is lacking maintenance, you should
+make sure the maintainer is active and will continue to work on
+their packages. Try contacting them yourself.
+ <p>
+If you do not get a reply after a few weeks you should collect all
+useful information about this maintainer. Start by logging in to
+the <url id="http://db.debian.org" name="Debian Developer's Database">
+and doing a full search to check whether the maintainer is on vacation
+and when they were last seen. Collect any important package names
+they maintain and any Release Critical bugs filled against them.
+ <p>
+Send all this information to &email-debian-qa;, in order to let the
+QA people do whatever is needed.
<sect>Retiring Gracefully
<p>
&email-debian-policy;, &email-debian-user;, &email-debian-private;,
&email-debian-announce;, and &email-debian-devel-announce;. All
developers are expected to be subscribed to at least
-&email-debian-private and &email-debian-devel-announce;. There are
-other mailing lists are available for a variety of special topics; see
+&email-debian-devel-announce;. There are
+other mailing lists 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
posting messages.
<p>
Online archives of mailing lists are available at <url
-id="&url-debian-list-archives;">.
+id="&url-lists-archives;">.
<sect id="server-machines">Debian servers
in the Debian project. Every developer should know what these servers
are and what they do.
<p>
-If you have a problem with the operation of Debian server, and you
+If you have a problem with the operation of a Debian server, and you
think that the system operators need to be notified of this problem,
-please find the contact address for the particular role at <url
-id="&url-debian-contacts;">. If you have a non-operating problems
+please find the contact address for the particular machine at <url
+id="&url-devel-machines;">. If you have a non-operating problems
(such as packages to be remove, suggestions for the web site, etc.),
generally you'll report a bug against a ``pseudo-package''. See <ref
id="submit-bug"> for information on how to submit bugs.
<sect1 id="servers-master">The master server
<p>
-The master server, <tt>master.debian.org</tt>, holds the canonical copy
-of the Debian archive (excluding the non-U.S. packages). Generally,
-package uploads go to this server; see <ref id="upload">.
- <p>
<tt>master.debian.org</tt> is the canonical location for the Bug
Tracking System (BTS). If you plan on doing some statistical analysis
or processing of Debian bugs, this would be the place to do it.
<p>
If you find a problem with <tt>master.debian.org</tt> such as disk
full, suspicious activity, or whatever, send an email to
-&email-debian-admin;. Problems with the Debian FTP archive generally
-need to be reported as bugs against the
-<package>ftp.debian.org</package> pseudo-package or an email to
-&email-ftpmaster;, but also see the procedures in <ref
-id="archive-manip">.
+&email-debian-admin;.
+
+ <sect1 id="servers-ftp-master">The ftp-master server
+ <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
+go to this server; see <ref id="upload">.
+ <p>
+Problems with the Debian FTP archive generally need to be reported as
+bugs against the <package>ftp.debian.org</package> pseudo-package or
+an email to &email-ftpmaster;, but also see the procedures in
+<ref id="archive-manip">.
- <sect1 id="servers-www">The WWW servers
+ <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 do this by putting material in the
-<file>public_html</file> directory under your home directory. You can
-do this on either <tt>va.debian.org</tt> or
-<tt>master.debian.org</tt>. Any material you put in those areas are
-accessible via the URLs
-<tt>http://www.debian.org/~<var>user-id</var>/</tt> and
-<tt>http://master.debian.org/~<var>user-id</var>/</tt>, respectively.
-Generally, you'll want to use <tt>va</tt>, for the
-<tt>www.debian.org</tt> address, although in some cases you may need
-to put it on <tt>master</tt>. 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.
+up on the web, you can do this by putting material in the
+<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://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>
If you find a problem with the Debian web server, you should generally
submit a bug against the pseudo-package,
<package>www.debian.org</package>. First check whether or not someone
-else has already reported the problem on the <url
-id="&url-bts;db/pa/lwww.debian.org.html" name="Bug Tracking System">.
+else has already reported the problem on the
+<url id="http://bugs.debian.org/www.debian.org" name="Bug Tracking System">.
<sect1 id="servers-cvs">The CVS server
<p>
-<tt>cvs.debian.org</tt> is also known as <tt>va.debian.org</tt>,
-discussed above. If you need the use of a publically accessible CVS
+<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.
<p>
<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
Note that mirrors are generally run by third-parties who are
interested in helping Debian. As such, developers generally do not
have accounts on these machines.
- <p>
-Please do not mirror off of <tt>master.debian.org</tt>. This host
-already has too much load. Check the sites above for information, or
-email <email>debian-devel@lists.debian.org</email>.
<sect id="other-machines">Other Debian Machines
<sect>Overview
<p>
-The Debian GNU/Linux distribution consists of a lot of Debian packages
+The &debian-formal; distribution consists of a lot of Debian packages
(<tt>.deb</tt>'s, currently around &number-of-pkgs;) and a few
additional files (documentation, installation disk images, etc.).
<p>
-Here is an example directory tree of a complete Debian distribution:
+Here is an example directory tree of a complete Debian archive:
<p>
&sample-dist-dirtree;
<p>
-As you can see, the top-level directory of the distribution contains
-three directories, namely <em>main</em>, <em>contrib</em>, and
-<em>non-free</em>. These directories are called <em>sections</em>.
- <p>
-In each section, there is a directory with the source packages
-(source), a directory for each supported architecture
+As you can see, the top-level directory contains two directories,
+<tt>dists/</tt> and <tt>pool/</tt>. The latter is a ``pool'' in which the
+packages actually are, and which is handled by the archive maintenance
+database and the accompanying programs. The former contains the
+distributions, <em>stable</em>, <em>testing</em> and <em>unstable</em>.
+Each of those distribution directories is divided in equivalent
+subdirectories purpose of which is equal, so we will only explain how it
+looks in stable. The <tt>Packages</tt> and <tt>Sources</tt> files in the
+distribution subdirectories can reference files in the <tt>pool/</tt>
+directory.
+ <p>
+<tt>dists/stable</tt> contains three directories, namely <em>main</em>,
+<em>contrib</em>, and <em>non-free</em>.
+ <p>
+In each of the areas, there is a directory with the source packages
+(<tt>source</tt>), a directory for each supported architecture
(<tt>binary-i386</tt>, <tt>binary-m68k</tt>, etc.), and a directory
for architecture independent packages (<tt>binary-all</tt>).
<p>
-The <em>main</em> section contains additional directories which holds
+The <em>main</em> area contains additional directories which holds
the disk images and some essential pieces of documentation required
for installing the Debian distribution on a specific architecture
(<tt>disks-i386</tt>, <tt>disks-m68k</tt>, etc.).
<p>
-The <em>binary</em> and <em>source</em> directories are divided
+The <em>binary-*</em> and <em>source</em> directories are divided
further into <em>subsections</em>.
<sect>Sections
<p>
-The <em>main</em> section is what makes up the <em>official Debian
-GNU/Linux distribution</em>. The <em>main</em> section is official
-because it fully complies with all our guidelines. The other two
-sections do not, to different degrees; as such, they are not
-officially part of Debian.
+The <em>main</em> section of the Debian archive is what makes up the
+<strong>official &debian-formal; distribution</strong>. The
+<em>main</em> section is official because it fully complies with all
+our guidelines. The other two sections do not, to different degrees;
+as such, they are <strong>not</strong> officially part of
+&debian-formal;.
<p>
Every package in the main section must fully comply with the <url
id="&url-dfsg;" name="Debian Free Software Guidelines"> (DFSG) and
our definition of ``free software.'' Check out the Debian Policy
Manual for details.
<p>
-The packages which do not apply to the DFSG are placed in the
+Packages in the <em>contrib</em> section have to comply with the DFSG,
+but may fail other requirements. For instance, they may depend on
+non-free packages.
+ <p>
+Packages which do not apply to the DFSG are placed in the
<em>non-free</em> section. These packages are not considered as part
of the Debian distribution, though we support their use, and we
provide infrastructure (such as our bug-tracking system and mailing
lists) for non-free software packages.
<p>
-Packages in the <em>contrib</em> section have to comply with the DFSG,
-but may fail other requirements. For instance, they may depend on
-non-free packages.
- <p>
The <url id="&url-debian-policy;" name="Debian Policy Manual">
contains a more exact definition of the three sections. The above
discussion is just an introduction.
<p>
On the other hand, a CD-ROM vendor could easily check the individual
package licenses of the packages in <em>non-free</em> and include as
-many on the CD-ROMs as he's allowed. (Since this varies greatly from
+many on the CD-ROMs as he's allowed to. (Since this varies greatly from
vendor to vendor, this job can't be done by the Debian developers.)
<em>alpha</em>, <em>powerpc</em>, <em>sparc</em>, <em>hurd-i386</em>,
and <em>arm</em>, as of this writing.
<p>
-Debian GNU/Linux 1.3 is only available as <em>i386</em>. Debian 2.0
+&debian-formal; 1.3 is only available as <em>i386</em>. Debian 2.0
shipped for <em>i386</em> and <em>m68k</em> architectures. Debian 2.1
ships for the <em>i386</em>, <em>m68k</em>, <em>alpha</em>, and
<em>sparc</em> architectures. Debian 2.2 adds support for the
-<em>powerpc</em> architecture.
+<em>powerpc</em> and <em>arm</em> architectures.
<p>
Information for developers or uses about the specific ports are
available at the <url id="&url-debian-ports;" name="Debian Ports web
The sections <em>main</em>, <em>contrib</em>, and <em>non-free</em>
are split into <em>subsections</em> to simplify the installation
process and the maintainance of the archive. Subsections are not
-formally defined, excepting perhaps the `base' subsection.
-Subsections exist simply to simplify the organization and browsing of
+formally defined, except perhaps the `base' subsection.
+Subsections simply exist to simplify the organization and browsing of
available packages. Please check the current Debian distribution to
see which sections are available.
-
+ <p>
+Note however that with the introduction of package pools (see the top-level
+<em>pool/</em> directory), the subsections in the form of subdirectories
+will eventually cease to exist. They will be kept in the packages' `Section'
+header fields, though.
<sect>Packages
<p>
<sect>Distribution directories
<p>
-The directory system described in the previous chapter, are themselves
-contained within <em>distribution directories</em>. Every
-distribution is contained in the <tt>dists</tt> directory in the
-top-level of the Debian archive itself (the symlinks from the
-top-level directory to the distributions themselves are for backwards
-compatability and are deprecated).
+The directory system described in the previous chapter is itself
+contained within <em>distribution directories</em>. Each
+distribution is actually contained in the <tt>pool</tt> directory in the
+top-level of the Debian archive itself.
<p>
To summarize, the Debian archive has a root directory within an FTP
server. For instance, at the mirror site,
<ftpsite>ftp.us.debian.org</ftpsite>, the Debian archive itself is
contained in <ftppath>/debian</ftppath>, which is a common location
-(another is <ftppath>/pub/debian</ftppath>).
- <p>
-Within that archive root, the actual distributions are contained in
-the <tt>dists</tt> directory. Here is an overview of the layout:
+(another is <tt>/pub/debian</tt>).
<p>
-<example>
-<var>archive root</var>/dists/<var>distribution</var>/<var>section</var>/<var>architecture</var>/<var>subsection</var>/<var>packages</var>
-</example>
+A distribution is comprised of Debian source and binary packages, and the
+respective <tt>Sources</tt> and <tt>Packages</tt> index files, containing
+the header information from all those packages. The former are kept in the
+<tt>pool/</tt> directory, while the latter are kept in the <tt>dists/</tt>
+directory of the archive (because of backwards compatibility).
-Extrapolating from this layout, you know that to find the i386 base
-packages for the distribution <em>slink</em>, you would look in
-<ftppath>/debian/dists/slink/main/binary-i386/base/</ftppath>.
- <sect1>Stable, unstable, and sometimes frozen
+ <sect1 id="sec-dists">Stable, testing, and unstable
<p>
-There is always a distribution called <em>stable</em> (residing in
-<tt>dists/stable</tt>) and one called <em>unstable</em> (residing in
+There are always distributions called <em>stable</em> (residing in
+<tt>dists/stable</tt>), one called <em>testing</em> (residing in
+<tt>dists/testing</tt>), and one called <em>unstable</em> (residing in
<tt>dists/unstable</tt>). This reflects the development process of the
Debian project.
<p>
distribution</em>). Every Debian developer can update his or her
packages in this distribution at any time. Thus, the contents of this
distribution change from day-to-day. Since no special effort is done
-to test this distribution, it is sometimes ``unstable.''
- <p>
-After a period of development, the <em>unstable</em> distribution is
-copied in a new distribution directory, called <em>frozen</em>. When
-that occurs, no changes are allowed to the frozen distribution except
-bug fixes; that's why it's called ``frozen.'' After another month or
-a little longer, the <em>frozen</em> distribution is renamed to
-<em>stable</em>, overriding the old <em>stable</em> distribution,
-which is removed at that time.
+to make sure everything in this distribution is working properly, it is
+sometimes ``unstable.''
+ <p>
+Packages get copied from <em>unstable</em> to <em>testing</em> if they
+satisfy certain criteria. To get into <em>testing</em> distribution, a
+package needs to be in the archive for two weeks and not have any
+release critical bugs. After that period, it will propagate into
+<em>testing</em> as soon as anything it depends on is also added. This
+process is automatic. You can see some notes on this system as well
+as <tt>update_excuses</tt> (describing which packages are valid
+candidates, which are not, and why not) at <url
+id="&url-testing-maint;">.
+ <p>
+After a period of development, once the release manager deems fit, the
+<em>testing</em> distribution is frozen, meaning that the policies
+which control how packages move from <em>unstable</em> to testing are
+tightened. Packages which are too buggy are removed. No changes are
+allowed into <em>testing</em> except for bug fixes. After some time
+has elapsed, depending on progress, the <em>testing</em> distribution
+goes into a `deep freeze', when no changes are made to it except those
+needed for the installation system. This is called a ``test cycle'',
+and it can last up to two weeks. There can be several test cycles,
+until the distribution is prepared for release, as decided by the
+release manager. At the end of the last test cycle, the
+<em>testing</em> distribution is renamed to <em>stable</em>,
+overriding the old <em>stable</em> distribution, which is removed at
+that time (although they can be found at <tt>archive-host;</tt>).
<p>
This development cycle is based on the assumption that the
<em>unstable</em> distribution becomes <em>stable</em> after passing a
-period of testing as <em>frozen</em>. Even once a distribution is
-considered stable, a few bugs inevitably remain--that's why the stable
-distribution is updated every now and then. However, these updates are
-tested very carefully and have to be introduced into the archive
-individually to reduce the risk of introducing new bugs. You can find
-proposed additions to <em>stable</em> in the <tt>proposed-updates</tt>
-directory. Those packages in <tt>proposed-updates</tt> that pass
-muster are periodically moved as a batch into the stable distribution
-and the revision level of the stable distribution is incremented
-(e.g., `1.3' becomes `1.3r1', `2.0r2' becomes `2.0r3', and so forth).
- <p>
-Note that development under <em>unstable</em> is continued during the
-``freeze'' period, since a new <em>unstable</em> distribution is be
-created when the older <em>unstable</em> is moved to <em>frozen</em>.
-Another wrinkle is that when the <em>frozen</em> distribution is
-offically released, the old stable distribution is completely removed
-from the Debian archives (although they do live on at
-<tt>archive-host;</tt>).
- <p>
-In summary, there is always a <em>stable</em> and an <em>unstable</em>
-distribution available, and the <em>frozen</em> distribution shows up
-for a month or so from time to time.
-
+period of being in <em>testing</em>. Even once a distribution is
+considered stable, a few bugs inevitably remain &mdash that's why the
+stable distribution is updated every now and then. However, these
+updates are tested very carefully and have to be introduced into the
+archive individually to reduce the risk of introducing new bugs. You
+can find proposed additions to <em>stable</em> in the
+<tt>proposed-updates</tt> directory. Those packages in
+<tt>proposed-updates</tt> that pass muster are periodically moved as a
+batch into the stable distribution and the revision level of the
+stable distribution is incremented (e.g., `1.3' becomes `1.3r1',
+`2.0r2' becomes `2.0r3', and so forth).
+ <p>
+Note that development under <em>unstable</em> continues during the
+``freeze'' period, since the <em>unstable</em> distribution remains in
+place in parallel with <em>testing</em>.
<sect1>Experimental
<p>
The <em>experimental</em> distribution is a specialty distribution.
-It is not a full distribution in the same sense that `stable' and
+It is not a full distribution in the same sense as `stable' and
`unstable' are. Instead, it is meant to be a temporary staging area
for highly experimental software where there's a good chance that the
-software could break your system. Users who download and install
+software could break your system, or software that's just too unstable
+even for the <em>unstable</em> distribution (but there is a reason to
+package it nevertheless). Users who download and install
packages from <em>experimental</em> are expected to have been duly
warned. In short, all bets are off for the <em>experimental</em>
distribution.
<p>
-Developers should be very selective in the use of the
-<em>experimental</em> distribution. Even if a package is highly
-unstable, it could well still go into <em>unstable</em>; just state a
-few warnings in the description. However, if there is a chance that
-the software could do grave damage to a system, it might be better to
-put it into <em>experimental</em>.
- <p>
-For instance, an experimental encrypted file system should probably go
-into <em>experimental</em>. A new, beta, version of some software
-which uses completely different configuration might go into
-<em>experimental</em> at the maintainer's discretion. New software
-which isn't likely to damage your system can go into
-<em>unstable</em>. If you are working on an incompatible or complex
-upgrade situation, you can also use <em>experimental</em> as a staging
-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
-maintainers to delete the package one 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
-less strain on the Debian archive maintainers.
+If there is a chance that the software could do grave damage to a system,
+it is likely to be better to put it into <em>experimental</em>.
+For instance, an experimental compressed file system should probably go
+into <em>experimental</em>.
+ <p>
+Whenever there is a new upstream version of a package that introduces new
+features but breaks a lot of old ones, it should either not be uploaded, or
+be uploaded to <em>experimental</em>. A new, beta, version of some software
+which uses completely different configuration can go into
+<em>experimental</em>, at the maintainer's discretion. If you are working
+on an incompatible or complex upgrade situation, you can also use
+<em>experimental</em> as a staging area, so that testers can get early
+access.
+ <p>
+Some experimental software can still go into <em>unstable</em>, with a few
+warnings in the description, but that isn't recommended because packages
+from <em>unstable</em> are expected to propagate to <em>testing</em> and
+thus to <em>stable</em>.
+ <p>
+New software which isn't likely to damage your system can go directly into
+<em>unstable</em>.
+ <p>
+An alternative to <em>experimental</em> is to use your personal web space
+on <tt>people.debian.org</tt> (<tt>klecker.debian.org</tt>).
<sect id="codenames">Release code names
<p>
Every released Debian distribution has a <em>code name</em>: Debian
1.1 is called `buzz'; Debian 1.2, `rex'; Debian 1.3, `bo'; Debian 2.0,
-`hamm'; Debian 2.1, `slink'; and Debian 2.2, `potato'. There is also
-a ``pseudo-distribution'', called `sid' which is contains packages for
-architectures which are not yet officially supported or released by
-Debian. These architectures are planned to be integrated into the
-mainstream distribution at some future date.
- <p>
-Since the Debian has an open development model (i.e., everyone can
-participate and follow the development) even the unstable distribution
-is distributed via the Internet on the Debian FTP and HTTP server
-network. Thus, if we had called the directory which contains the
-development version `unstable', then we would have to rename it to
-`stable' when the version is released, which would cause all FTP
-mirrors to re-retrieve the whole distribution (which is already very
-large!).
+`hamm'; Debian 2.1, `slink'; Debian 2.2, `potato'; and Debian 3.0, `woody'. There is also
+a ``pseudo-distribution'', called `sid', which is the current
+`unstable' distribution; since packages are moved from `unstable' to
+`testing' as they approach stability, `sid' itself is never released.
+As well as the usual contents of a Debian distribution, `sid' contains
+packages for architectures which are not yet officially supported or
+released by Debian. These architectures are planned to be integrated
+into the mainstream distribution at some future date.
+ <p>
+Since Debian has an open development model (i.e., everyone can
+participate and follow the development) even the `unstable' and `testing'
+distributions are distributed to the Internet through the Debian FTP and
+HTTP server network. Thus, if we had called the directory which contains
+the release candidate version `testing', then we would have to rename it
+to `stable' when the version is released, which would cause all FTP
+mirrors to re-retrieve the whole distribution (which is quite large).
<p>
On the other hand, if we called the distribution directories
<em>Debian-x.y</em> from the beginning, people would think that Debian
1.1, and not 1.0.)
<p>
Thus, the names of the distribution directories in the archive are
-determined by their code names and not their release status (i.e.,
+determined by their code names and not their release status (e.g.,
`slink'). These names stay the same during the development period and
-after the release; symbolic links, which can be changed, are made to
+after the release; symbolic links, which can be changed easily,
indicate the currently released stable distribution. That's why the
-real distribution directories use the <em>code names</em> and symbolic
-links for <em>stable</em>, <em>unstable</em>, and <em>frozen</em>
-point to the appropriate release directories.
+real distribution directories use the <em>code names</em>, while
+symbolic links for <em>stable</em>, <em>testing</em>, and
+<em>unstable</em> point to the appropriate release directories.
<chapt id="upload">Package uploads
<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
-Prospective Packages (WNPP)"> list. Checking the WNPP ensures that no
-one is already working on packaging that software, and that effort is
-not duplicated. Assuming no one else is already working on your
-prospective package, you must then send a short email to
-&email-debian-devel; describing your plan to create a new package.
-You should set the subject of the email to ``intent to package
-<var>foo</var>'', substituting the name of the new package for
-<var>foo</var>.
- <p>
-There are a number of reasons why we ask maintainers to follow these
-steps:
+Prospective Packages (WNPP)"> list. Checking the WNPP list ensures that
+no one is already working on packaging that software, and that effort is
+not duplicated. Read the <url id="&url-wnpp;" name="WNPP web pages"> for
+more information.
+ <p>
+Assuming no one else is already working on your prospective package,
+you must then submit a bug report (<ref id="submit-bug">) against the
+pseudo package <tt>wnpp</tt>
+describing your plan to create a new package, including, but not
+limiting yourself to, a description of the package, the license of the
+prospective package and the current URL where it can be downloaded
+from.
+ <p>
+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>wishlist</em>. If you feel it's necessary, send a copy to
+&email-debian-devel; by putting the address in the <tt>X-Debbugs-CC:</tt> header
+of the message (no, don't use <tt>CC:</tt>, because that way the message's subject
+won't indicate the bug number).
+ <p>
+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">).
+ <p>
+There are a number of reasons why we ask maintainers to announce their
+intentions:
<list compact>
<item>
It helps the (potentially new) maintainer to tap into the experience
-of people on the list, and lets them know if any one else is working
+of people on the list, and lets them know if anyone else is working
on it already.
<item>
It lets other people thinking about working on the package know that
-there already is a volunteer, and efforts may be shared. The ``intent
-to package'' message to &email-debian-devel@; will be picked up the
-the WNPP maintainer, and your intention will be published in
-subsequent versions of the WNPP document.
+there already is a volunteer, so efforts may be shared.
<item>
It lets the rest of the maintainers know more about the package than
-the one line description and the changelog entry ``Initial version''
-that generally gets posted to <tt>debian-devel-changes</tt> by
-default.
+the one line description and the usual changelog entry ``Initial release''
+that gets posted to <tt>debian-devel-changes</tt>.
<item>
It is helpful to the people who live off unstable (and form our first
-line of testers); we should encourage these people.
+line of testers). We should encourage these people.
<item>
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="uploading">Uploading a package
+ <sect id="upload-checking">Checking the package prior to upload
+ <p>
+Before you upload your package, you should do basic testing on it. At
+a minimum, you should try the following activities (you'll need to
+have an older version of the same Debian package around):
+<list>
+ <item>
+Install the package and make sure the software works, or upgrade the
+package from an older version to your new version if a Debian package
+for it already exists.
+ <item>
+Run <prgn>lintian</prgn> over the package. You can run
+<prgn>lintian</prgn> as follows: <tt>lintian -v
+<var>package-version</var>.changes</tt>. This will check the source
+package as well as the binary package. If you don't understand the
+output that <prgn>lintian</prgn> generates, try adding the <tt>-i</tt>
+switch, which will cause <prgn>lintian</prgn> to output a very verbose
+description of the problem.
+ <p>
+Normally, a package should <em>not</em> be uploaded if it causes lintian
+to emit errors (they will start with <tt>E</tt>).
+ <p>
+For more information on <prgn>lintian</prgn>, see <ref id="lintian">.
+ <item>
+Downgrade the package to the previous version (if one exists) — this
+tests the <tt>postrm</tt> and <tt>prerm</tt> scripts.
+ <item>
+Remove the package, then reinstall it.
+ </list>
+
- <sect1>Generating the changes file
+ <sect>Generating the changes file
<p>
When a package is uploaded to the Debian FTP archive, it must be
accompanied by a <tt>.changes</tt> file, which gives directions to the
&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
-id="upload-bugfix">. Only the <tt>Distribution</tt> field is
-discussed in this section, since it relates to the archive maintenance
-policies.
+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">.
- <sect1 id="upload-dist">Picking a distribution
- <p>
-Notably, the <tt>Distribution</tt> field, which originates from the
-<file>debian/changelog</file> file, indicates which distribution the
-package is intended for. There are four possible values for this
-field: `stable', `unstable', `frozen', or `experimental'; these values
-can also be combined. For instance, if you have a crucial security
-fix release of a package, and the package has not diverged between the
-<em>stable</em> and <em>unstable</em> distributions, then you might
-put `stable unstable' in the <file>changelog</file>'s
-<tt>Distribution</tt> field. Or, if Debian has been frozen, and you
-want to get a bug-fix release into <em>frozen</em>, you would set the
-distribution to `frozen unstable'. (See <ref id="upload-frozen"> for
-more information on when to upload to <em>frozen</em>.) Note that it
-never makes sense to combine the <em>experimental</em> distribution with
-anything else. Also note that setting the distribution to `stable' means
-that the package will be placed into the <tt>proposed-updates</tt>
-directory of the Debian archive for further testing before it is actually
-included in <em>stable</em>. The Release Team (which can be reached at
-&email-debian-release;) will decide if your package can be included in
-stable, therefore if your changelog entry is not clear enough, you may
-want to explain them why you uploaded your package to stable by sending
-them a short explication.
+ <sect1>The original source tarball
<p>
The first time a version is uploaded which corresponds to a particular
-upstream version the original source tar file should be uploaded and
-included in the <tt>.changes</tt> file; subsequent times the very same
+upstream version, the original source tar file should be uploaded and
+included in the <tt>.changes</tt> file. Subsequently, this very same
tar file should be used to build the new diffs and <tt>.dsc</tt>
-files, and it need not then be uploaded.
+files, and will not need to be re-uploaded.
<p>
-By default <prgn>dpkg-genchanges</prgn> and
+By default
, <prgn>dpkg-genchanges</prgn> and
<prgn>dpkg-buildpackage</prgn> will include the original source tar
file if and only if the Debian revision part of the source version
number is 0 or 1, indicating a new upstream version. This behaviour
may be modified by using <tt>-sa</tt> to always include it or
<tt>-sd</tt> to always leave it out.
<p>
-If no original source is included in the upload then the original
+If no original source is included in the upload, the original
source tar-file used by <prgn>dpkg-source</prgn> when constructing the
<tt>.dsc</tt> file and diff to be uploaded <em>must</em> be
byte-for-byte identical with the one already in the archive. If there
-is some reason why this is not the case then the new version of the
+is some reason why this is not the case, the new version of the
original source should be uploaded, possibly by using the <tt>-sa</tt>
flag.
+
+ <sect1 id="upload-dist">Picking a distribution
+ <p>
+The <tt>Distribution</tt> field, which originates from the first line of
+the <file>debian/changelog</file> file, indicates which distribution the
+package is intended for.
+ <p>
+There are three possible values for this field: `stable', `unstable',
+and `experimental'. Normally, packages are uploaded into
+<em>unstable</em>.
+ <p>
+You should avoid combining `stable' with others because of potential
+problems with library dependencies (for your package and for the package
+built by the build daemons for other architecture).
+See <ref id="upload-stable"> for more information on when and how to
+upload to <em>stable</em>.
+ <p>
+It never makes sense to combine the <em>experimental</em> distribution
+with anything else.
+
+<!--
<sect2 id="upload-frozen">Uploading to <em>frozen</em>
<p>
The Debian freeze is a crucial time for Debian. It is our chance to
<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>
important
</list>
<p>
-Remember, there is statistically a 15% chance that every bug fix will
-introduce a new bug. The introduction and discovery of new bugs
-either delays release or weakens the final product. There is little
-correlation between the severity of the original bug and the severity
-of the introduced bug.
+Experience has shown that there is statistically a 15% chance that
+every bug fix will introduce a new bug. The introduction and
+discovery of new bugs either delays release or weakens the final
+product. There is little correlation between the severity of the
+original bug fixed and the severity of the bug newly introduced by the
+fix.
+ -->
- <sect1 id="upload-checking">Checking the package prior to upload
- <p>
-Before you upload your package, you should do basic testing on it.
-Make sure you try the following activities (you'll need to have an
-older version of the Debian package around).
+ <sect2 id="upload-stable">Uploading to <em>stable</em>
+ <p>
+Uploading to <em>stable</em> means that the package will be placed into the
+<tt>proposed-updates</tt> directory of the Debian archive for further
+testing before it is actually included in <em>stable</em>.
+ <p>
+Extra care should be taken when uploading to <em>stable</em>. Basically, a
+package should only be uploaded to stable if one of the following happens:
<list>
- <item>
-Install the package and make sure the software works, or upgrade the
-package from an older version to your new version if a Debian package
-for it already exists.
- <item>
-Run <prgn>lintian</prgn> over the package. You can run
-<prgn>lintian</prgn> as follows: <tt>lintian -v
-<var>package-version</var>.changes</tt>. This will check the source
-package as well as the binary package. If you don't understand the
-output that <prgn>lintian</prgn> generates, try adding the <tt>-i</tt>
-switch, which will cause <prgn>lintian</prgn> to output a very verbose
-description of the problem.
- <p>
-Normally, a package should <em>not</em> be uploaded if it causes lintian
-to emit errors (they will start with <tt>E</tt>).
- <p>
-For more information on <prgn>lintian</prgn>, see <ref id="lintian">.
- <item>
-Downgrade the package to the previous version (if one exists) -- this
-tests the <tt>postrm</tt> and <tt>prerm</tt> scripts.
- <item>
-Remove the package, then reinstall it.
- </list>
+ <item>a security problem (e.g. a Debian security advisory)
+ <item>a truely critical functionality problem
+ <item>the package becomes uninstallable
+ <item>a released architecture lacks the package
+</list>
+ <p>
+It is discouraged to change anything else in the package that isn't
+important, because even trivial fixes can cause bugs later on. Uploading
+new upstream versions to fix security problems is deprecated; applying the
+specific patch from the new upstream version to the old one ("backporting"
+the patch) is the right thing to do in most cases.
+ <p>
+Packages uploaded to <em>stable</em> need to be compiled on systems running
+<em>stable</em>, so that their dependencies are limited to the libraries
+(and other packages) available in <em>stable</em>; for example, a package
+uploaded to <em>stable</em> that depends on a library package that only
+exists in unstable will be rejected. Making changes to dependencies of other
+packages (by messing with <tt>Provides</tt> or shlibs files), possibly making
+those other packages uninstallable, is strongly discouraged.
+ <p>
+The Release Team (which can be reached at &email-debian-release;) will
+regularly evaluate the uploads in <em>proposed-updates</em> and decide if
+your package can be included in <em>stable</em>. Please be clear (and
+verbose, if necessary) in your changelog entries for uploads to
+<em>stable</em>, because otherwise the package won't be considered for
+inclusion.
+
- <sect1 id="upload-master">Uploading to <tt>master</tt>
+ <sect id="uploading">Uploading a package
+
+ <sect1 id="upload-ftp-master">Uploading to <tt>ftp-master</tt>
<p>
To upload a package, you need a personal account on
-<ftpsite>master.debian.org</ftpsite>. All maintainers should already
-have this account, see <ref id="servers-master">. You can use either
-<prgn>scp</prgn> or <prgn>ftp</prgn> to transfer the files. In either
-case, the files need to be placed into
-<ftppath>&master-upload-dir</ftppath>. (You cannot upload to Incoming
-on master using anonymous FTP -- you must use your user-name and
-password.)
+<ftpsite>ftp-master.debian.org</ftpsite>, which you should have as an
+official maintainer. If you use <prgn>scp</prgn> or <prgn>rsync</prgn>
+to transfer the files, place them into <tt>&us-upload-dir;</tt>;
+if you use anonymous FTP to upload, place them into
+<ftppath>/pub/UploadQueue/</ftppath>.
<p>
-<em>Note:</em> Do not upload packages containing software that is
-export-controlled by the United States government to <tt>master</tt>,
-nor to the overseas upload queues on <tt>chiark</tt> or
+<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
<p>
You may also find the Debian package <package>dupload</package> useful
when uploading packages. This handy program is distributed with
-defaults for uploading via <prgn>ftp</prgn> to <tt>master</tt>,
+defaults for uploading via <prgn>ftp</prgn> to <tt>ftp-master</tt>,
<tt>chiark</tt>, and <tt>erlangen</tt>. It can also be configured to
-use <prgn>ssh</prgn>. See <manref name="dupload" section="1"> and
-<manref name="dupload" section="5"> for more information.
+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>~maor/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>pandora</tt> (non-us)
+ <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>master</tt>. Instead, use non-anonymous FTP or
-<prgn>scp</prgn> to copy the package to
-<ftpsite>pandora.debian.org</ftpsite>, placing the files in
-<ftppath>&non-us-upload-dir</ftppath>. By default, you can use your
-same account which works on <tt>master</tt>.
+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>pandora</tt>; please refer to the documentation that comes with
+<tt>non-us</tt>; please refer to the documentation that comes with
the program for details.
<p>
-Just as for an upload to master, 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>
+ <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>master</tt>, there are
+If you have a slow network connection to <tt>ftp-master</tt>, there are
alternatives. One is to upload files to <tt>Incoming</tt> via a
upload queue in Europe on <tt>chiark</tt>. For details connect to
<url id="&url-chiark-readme;">.
<p>
<em>Note:</em> Do not upload packages containing software that is
export-controlled by the United States government to the queue on
-<tt>chiark</tt>. Since this upload queue goes to <tt>master</tt>, the
-prescription found in <ref id="upload-master"> applies here as well.
+<tt>chiark</tt>. Since this upload queue goes to <tt>ftp-master</tt>, the
+prescription found in <ref id="upload-ftp-master"> applies here as well.
<p>
The program <prgn>dupload</prgn> comes with support for uploading to
<tt>chiark</tt>; please refer to the documentation that comes with the
via anonymous FTP to <url id="&url-upload-erlangen;">.
<p>
The upload must be a complete Debian upload, as you would put it into
-<tt>master</tt>'s <tt>Incoming</tt>, i.e., a <tt>.changes</tt> files
+<tt>ftp-master</tt>'s <tt>Incoming</tt>, i.e., a <tt>.changes</tt> files
along with the other files mentioned in the <tt>.changes</tt>. The
queue daemon also checks that the <tt>.changes</tt> is correctly
PGP-signed by a Debian developer, so that no bogus files can find
-their way to <tt>master</tt> via the queue. Please also make sure that
+their way to <tt>ftp-master</tt> via this queue. Please also make sure that
the <tt>Maintainer</tt> field in the <tt>.changes</tt> contains
<em>your</em> e-mail address. The address found there is used for all
-replies, just as on <tt>master</tt>.
+replies, just as on <tt>ftp-master</tt>.
<p>
There's no need to move your files into a second directory after the
-upload as on <tt>chiark</tt>. And, in any case, you should get some
-mail reply from the queue daemon what happened to your
-upload. Hopefully it should have been moved to <tt>master</tt>, but in
+upload, as on <tt>chiark</tt>. And, in any case, you should get a
+mail reply from the queue daemon explaining what happened to your
+upload. Hopefully it should have been moved to <tt>ftp-master</tt>, but in
case of errors you're notified, too.
<p>
<em>Note:</em> Do not upload packages containing software that is
export-controlled by the United States government to the queue on
-<tt>erlangen</tt>. Since this upload queue goes to <tt>master</tt>, the
-prescription found in <ref id="upload-master"> applies here as well.
+<tt>erlangen</tt>. Since this upload queue goes to <tt>ftp-master</tt>, the
+prescription found in <ref id="upload-ftp-master"> applies here as well.
<p>
The program <prgn>dupload</prgn> comes with support for uploading to
<tt>erlangen</tt>; please refer to the documentation that comes with
<sect1>Other Upload Queues
<p>
Another upload queue is available which is based in the US, and is a
-good backup when there are problems reaching <tt>master</tt>. You can
+good backup when there are problems reaching <tt>ftp-master</tt>. You can
upload files, just as in <tt>erlangen</tt>, to <url
id="&url-upload-samosa;">.
<p>
<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 dinstall
-when it runs (usually once a day), you just need to use a recent
-<package>dpkg-dev</package> (>= 1.4.1.2). Before that,
-<prgn>dupload</prgn> was used to send those announcements, please make
-sure that you configured your <prgn>dupload</prgn> to no more send those
-announcements (check its documentation and look for dinstall_runs). The
-mail generated by dinstall will contain the PGP/GPG signed .changes files
-that you uploaded with your package.
+When a package is uploaded, an announcement should be posted to one of
+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> (>= 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
+send those announcements (check its documentation and look for
+``dinstall_runs'').
<p>
If a package is released with the <tt>Distribution:</tt> set to
`stable', the announcement is sent to &email-debian-changes;. If a
package is released with <tt>Distribution:</tt> set to `unstable',
-`experimental', or `frozen' (when present), the announcement will be
+or `experimental', the announcement will be
posted to &email-debian-devel-changes; instead.
<p>
-On occasion, it is necessary to upload a package to both the
-<em>stable</em> and <em>unstable</em> distributions; this is done by
-putting both distributions in the <tt>Distribution:</tt> line. In
-such a case the upload announcement will go to both of the above
-mailing lists.
- <p>
-The <prgn>dupload</prgn> program is clever enough to determine for itself
+The <prgn>dupload</prgn> program is clever enough to determine
where the announcement should go, and will automatically mail the
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 the archive maintenance tools, <prgn>katie</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
-patient).
+the change to the archive may take up to a month to occur. Please be
+patient.
<p>
-In any case, you will receive notification indicating that the package
-has been uploaded via email. Please examine this notification
-carefully. You may notice that the package didn't go into the section
-you thought you set it to go into. Read on for why.
+In any case, you will receive email notification indicating that the
+package has added to the archive, which also indicates which bugs will
+be closed by the upload. Please examine this notification carefully,
+checking if any bugs you meant to close didn't get triggered.
+ <p>
+The installation notification also includes information on what
+section the package was inserted into. If there is a disparity, you
+will receive a separate email notifying you of that. Read on below.
<sect1 id="override-file">The override file
<p>
<file>debian/control</file> file are actually just hints.
<p>
The archive maintainers keep track of the canonical sections and
-priorities for packages in the <em>override file</em>. Sometimes the
-<em>override file</em> needs correcting. Simply changing the
-package's <file>control</file> file is not going to work. Instead,
-you should email &email-override; or submit a bug against
-<package>ftp.debian.org</package>.
+priorities for packages in the <em>override file</em>. If there is a
+disparity between the <em>override file</em> and the package's fields
+as indicated in <file>debian/control</file>, then you will receive an
+email noting the divergence when the package is installed into the
+archive. You can either correct your <file>debian/control</file> file
+for your next upload, or else you may wish to make a change in the
+<em>override file</em>.
+ <p>
+To alter the actual section that a package is put in, you need to
+first make sure that the <file>debian/control</file> in your package
+is accurate. Next, send an email &email-override; or submit a bug
+against <package>ftp.debian.org</package> requesting that the section
+or priority for your package be changed from the old section or
+priority to the new one. Be sure to explain your reasoning.
<p>
For more information about <em>override files</em>, see <manref
name="dpkg-scanpackages" section="8">, &file-bts-mailing;, and
<p>
This chapter contains information providing guidelines for when and
how NMUs should be done. A fundamental distinction is made between
-source and binary NMUs, which is explained in the next section.
+source and binary-only NMUs, which is explained in the next section.
<sect id="nmu-terms">Terminology
<p>
-There are two new terms used throughout this section: ``binary NMU''
+There are two new terms used throughout this section: ``binary-only NMU''
and ``source NMU''. These terms are used with specific technical
-meaning throughout this document. Both binary and source NMUs are
+meaning throughout this document. Both binary-only and source NMUs are
similar, since they involve an upload of a package by a developer who
is not the official maintainer of that package. That is why it's a
<em>non-maintainer</em> upload.
<p>
-A source NMU is a upload of a package by a developer who is not the
+A source NMU is an upload of a package by a developer who is not the
official maintainer, for the purposes of fixing a bug in the package.
Source NMUs always involves changes to the source (even if it is just
-a change to <file>debian/changelog</file>). This can be either a change
-to the upstream source, or a change to the Debian bits of the source.
- <p>
-A binary NMU is a recompilation and upload of a binary package for a
-new architecture. As such, it is usually part of a porting effort. A
-binary NMU is non-maintainer uploaded binary version of a package
-(often for another architecture), with no source changes required.
-There are many cases where porters must fix problems in the source in
-order to get them to compile for their target architecture; that would
-be considered a source NMU rather than a binary NMU. As you can see,
-we don't distinguish in terminology between porter NMUs and non-porter
-NMUs.
- <p>
-Both classes of NMUs, source and binary, can be lumped by the term
-``NMU''. However, this often leads to confusion, since most people
-think ``source NMU'' when they think ``NMU''. So it's best to be
-careful. In this chapter, if I use the unqualified term ``NMU'', I
-mean both source and binary NMUs.
+a change to <file>debian/changelog</file>). This can be either a
+change to the upstream source, or a change to the Debian bits of the
+source. Note, however, that source NMUs may also include
+architecture-dependent packages, as well as an updated Debian diff
+(or, more rarely, new upstream source as well).
+ <p>
+A binary-only NMU is a recompilation and upload of a binary package
+for a given architecture. As such, it is usually part of a porting
+effort. A binary-only NMU is a non-maintainer uploaded binary version
+of a package, with no source changes required. There are many cases
+where porters must fix problems in the source in order to get them to
+compile for their target architecture; that would be considered a
+source NMU rather than a binary-only NMU. As you can see, we don't
+distinguish in terminology between porter NMUs and non-porter NMUs.
+ <p>
+Both classes of NMUs, source and binary-only, can be lumped by the
+term ``NMU''. However, this often leads to confusion, since most
+people think ``source NMU'' when they think ``NMU''. So it's best to
+be careful. In this chapter, if we use the unqualified term ``NMU'',
+we refer to any type of non-maintainer upload NMUs, whether source and
+binary, or binary-only.
<sect id="nmu-who">Who can do an NMU
<sect id="nmu-when">When to do a source NMU
<p>
Guidelines for when to do a source NMU depend on the target
-distribution, i.e., stable, unstable, or frozen. Porters have
+distribution, i.e., stable, unstable, or experimental. Porters have
slightly different rules than non-porters, due to their unique
circumstances (see <ref id="source-nmu-when-porter">).
<p>
-Only critical changes or security bug fixes make it into stable. When
-a security bug is detected a fixed package should be uploaded as soon
-as possible. In this case, the Debian Security Managers should get in
+When a security bug is detected, a fixed package should be uploaded
+as soon as possible. In this case, the Debian security officers get in
contact with the package maintainer to make sure a fixed package is
uploaded within a reasonable time (less than 48 hours). If the package
maintainer cannot provide a fixed package fast enough or if he/she
-cannot be reached in time, the Security Manager may upload a fixed
+cannot be reached in time, a security officer 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.
-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
-in <ref id="nmu-guidelines"> need to be followed.
+During the release cycle (see <ref id="sec-dists">), NMUs which 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 in <ref
+id="nmu-guidelines"> need to be followed.
<p>
Bug fixes to unstable by non-maintainers are also acceptable, but only
as a last resort or with permission. Try the following steps first,
this, you'll have to invoke <prgn>dpkg-buildpackage</prgn> with the
<tt>-sa</tt> switch to force the build system to pick up the new
source package (normally it only looks for Debian revisions of '0' or
-'1' -- it's not yet clever enough to know about `0.1').
+'1' — it's not yet clever enough to know about `0.1').
<p>
Remember, porters who are simply recompiling a package for a different
architecture do not need to renumber. Porters should use new version
to be linked against, a bug was fixed in
<package>debhelper</package>), there must still be a changelog entry;
therefore, there will be a patch. If you are a porter, you are
-probably just doing a binary NMU. (Note: this leaves out in the cold
-porters who have to do recompiles -- chalk it up as a weakness in how
+probably just doing a binary-only NMU. (Note: this leaves out in the cold
+porters who have to do recompiles — chalk it up as a weakness in how
we maintain our archive.)
<p>
If the source NMU (non-maintainer upload) fixes some existing bugs,
-the bugs in the Bug Tracking System which are fixed need to be
-<em>notified</em> but not actually <em>closed</em> by the
-non-maintainer. Technically, only the official package maintainer or
-the original bug submitter are allowed to close bugs. However, the
-person making the non-maintainer release must send a short message to
-the relevant bugs explaining that the bugs have been fixed by the NMU.
-Using <email>control@bugs.debian.org</email>, the party doing the NMU
-should also set the severity of the bugs fixed in the NMU to `fixed'.
-This ensures that everyone knows that the bug was fixed in an NMU;
-however the bug is left open until the changes in the NMU are
-incorporated officially into the package by the official package
-maintainer. Also, open a bug with the patches needed to fix the
-problem, or make sure that one of the other (already open) bugs has
-the patches.
- <p>
-The normal maintainer will either apply the patch or employ an
-alternate method of fixing the problem. Sometimes bugs are fixed
-independently upstream, which is another good reason to back out an
-NMU's patch. If the maintainer decides not to apply the NMU's patch
-but to release a new version, the maintainer needs to ensure that the
-new upstream version really fixes each problem that was fixed in the
-non-maintainer release.
+these bugs should be tagged <em>fixed</em> in the Bug Tracking
+System rather than closed. By convention, only the official package
+maintainer or the original bug submitter are allowed to close bugs.
+Fortunately, Debian's archive system recognizes NMUs and thus marks
+the bugs fixed in the NMU appropriately if the person doing the NMU
+has listed all bugs in the changelog with the <tt>Closes:
+bug#<var>nnnnn</var></tt> syntax (see <ref id="upload-bugfix"> for
+more information describing how to close bugs via the changelog).
+Tagging the bugs <em>fixed</em> ensures that everyone knows that the
+bug was fixed in an NMU; however the bug is left open until the
+changes in the NMU are incorporated officially into the package by
+the official package maintainer.
+ <p>
+Also, after doing an NMU, you have to open a new bug and include a
+patch showing all the changes you have made. The normal maintainer
+will either apply the patch or employ an alternate method of fixing
+the problem. Sometimes bugs are fixed independently upstream, which
+is another good reason to back out an NMU's patch. If the maintainer
+decides not to apply the NMU's patch but to release a new version,
+the maintainer needs to ensure that the new upstream version really
+fixes each problem that was fixed in the non-maintainer release.
<p>
In addition, the normal maintainer should <em>always</em> retain the
entry in the changelog file documenting the non-maintainer upload.
the need to announce the NMU to the proper lists.
<p>
Make sure you do <em>not</em> change the value of the maintainer in
-the <file>debian/control</file> file. Your name from the NMU entry of
+the <file>debian/control</file> file. Your name as given in the NMU entry of
the <file>debian/changelog</file> file will be used for signing the
changes file.
portability. Therefore, even if you are not a porter, you should read
most of this chapter.
<p>
-Porting is the act of building Debian packages for architectures which
+Porting is the act of building Debian packages for architectures that
is different from the original architecture of the package
maintainer's binary package. It is a unique and essential activity.
In fact, porters do most of the actual compiling of Debian packages.
-For instance, for one <em>i386</em> binary package, there has to be a
-recompile for each architecture, which is around five more builds.
+For instance, for a single <em>i386</em> binary package, there must be
+a recompile for each architecture, which is amounts to
+&number-of-arches; more builds.
<sect id="kind-to-porters">Being Kind to Porters
<p>
Porters have a difficult and unique task, since they are required to
deal with a large volume of packages. Ideally, every source package
-should build right out of the box; unfortunately, this is often not
+should build right out of the box. Unfortunately, this is often not
the case. This section contains a checklist of ``gotchas'' often
-committed by Debian maintainers -- common problems which often stymie
-porters, and make their jobs unnecessarily more difficult.
+committed by Debian maintainers — common problems which often stymie
+porters, and make their jobs unnecessarily difficult.
<p>
The first and most important watchword is to respond quickly to bug or
issues raised by porters. Please treat porters with courtesy, as if
they were in fact co-maintainers of your package (which in a way, they
-are).
+are). Please be tolerant of succinct or even unclear bug reports,
+doing your best to hunt down whatever the problem is.
<p>
By far, most of the problems encountered by porters are caused by
<em>packaging bugs</em> in the source packages. Here is a checklist
<enumlist>
<item>
+Make sure that your <tt>Build-Depends</tt> and
+<tt>Build-Depends-Indep</tt> settings in <file>debian/control</file>
+are set properly. The best way to validate this is to use the
+<package>debootstrap</package> package to create an unstable chroot
+environment. Within that chrooted environment, install the
+<package>build-essential</package> package and any package
+dependancies mention in <tt>Build-Depends</tt> and/or
+<tt>Build-Depends-Indep</tt>. Finally, try building your package
+within that chrooted environment.
+ <p>
+See the <url id="&url-debian-policy;" name="Debian Policy
+Manual"> for instructions on setting build dependencies.
+ <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-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
<var>package</var>.dsc</tt> to make sure your source package unpacks
be setup in a special way. Try building your package on another
machine, even if it's the same architecture.
<item>
-Don't depend on the package your building already being installed (a
+Don't depend on the package you're building already being installed (a
sub-case of the above issue).
<item>
-Don't rely on <prgn>egcc</prgn> being available; don't rely on
-<prgn>gcc</prgn> being a certain version.
+Don't rely on the compiler being a certain version, if possible. If
+not, then make sure your build dependencies reflect the restrictions,
+although you are probably asking for trouble, since different
+architectures sometimes standardize on different compilers.
<item>
Make sure your debian/rules contains separate ``binary-arch'' and
``binary-indep'' targets, as the Debian Packaging Manual requires.
<p>
If the package builds out of the box for the architecture to be ported
to, you are in luck and your job is easy. This section applies to
-that case; it describes how to build and upload your binary NMU so
+that case; it describes how to build and upload your binary-only NMU so
that it is properly installed into the archive. If you do have to
patch the package in order to get it to compile for the other
architecture, you are actually doing a source NMU, so consult <ref
id="nmu-guidelines"> instead.
<p>
-In a binary NMU, no real changes are being made to the source. You do
+In a binary-only NMU, no real changes are being made to the source. You do
not need to touch any of the files in the source package. This
includes <file>debian/changelog</file>.
<p>
-Sometimes you need to recompile a packages against other packages
-which have been updated, such as libraries. You do have to bump the
-version number in this case, so that the upgrade system can function
-properly. Even so, these are considered binary-only NMUs -- there is
-no need in this case for all architectures to recompile. You should
-set the version number as in the case of NMU versioning, but add a
-``.0.'' before the the NMU version. For instance, a recompile-only
-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>.
+ <sect1 id="recompile-nmu-versioning">
+ <heading>Recompilation Binary-Only NMU Versioning</heading>
+ <p>
+Sometimes you need to recompile a package against other packages which
+have been updated, such as libraries. You do have to bump the version
+number in this case, so that the version comparison system can
+function properly. Even so, these are considered binary-only NMUs
+— there is no need in this case to trigger all other
+architectures to consider themselves out of date or requiring
+recompilation.
+ <p>
+Such recompilations require special ``magic'' version numbering, so that
+the archive maintenance tools recognize that, even though there is a
+new Debian version, there is no corresponding source update. If you
+get this wrong, the archive maintainers will reject your upload (due
+to lack of corresponding source code).
+ <p>
+The ``magic'' for a recompilation-only NMU is triggered by using the
+third-level number on the Debian part of the version. For instance,
+if the latest version you are recompiling against was version
+``2.9-3'', your NMU should carry a version of ``2.9-3.0.1''. If the
+latest version was ``3.4-2.1'', your NMU should have a version number
+of ``3.4-2.1.1''.
+
<sect1 id="source-nmu-when-porter">
<heading>When to do a source NMU if you are a porter</heading>
the wait cycle for a porter's source NMU is smaller than for a
non-porter, since porters have to cope with a large quantity of
packages.
- <p>
Again, the situation varies depending on the distribution they are
-uploading to. Crucial fixes (i.e., changes need to get a source
+uploading to.
+
+<!--
+FIXME: commented out until I can work out how to upload to testing directly
+
+ Crucial fixes (i.e., changes need to get a source
package to compile for a released-targeted architecture) can be
uploaded with <em>no</em> waiting period for the `frozen' distribution.
+ -->
<p>
However, if you are a porter doing an NMU for `unstable', the above
guidelines for porting should be followed, with two variations.
-Firstly, the acceptable waiting period -- the time between when the
-bug is submitted to the BTS and when it is OK to do an NMU -- is seven
+Firstly, the acceptable waiting period &mdash the time between when the
+bug is submitted to the BTS and when it is OK to do an NMU — is seven
days for porters working on the unstable distribution. This period
can be shortened if the problem is critical and imposes hardship on
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
<sect>Moving packages
<p>
-Sometimes a package will change either its section. For instance, a
+Sometimes a package will change its section. For instance, a
package from the `non-free' section might be GPL'd in a later version,
in which case, the package should be moved to `main' or
`contrib'.<footnote> See the <url id="&url-debian-policy;"
<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
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
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.
-
-
<sect id="orphaning">Orphaning a package
<p>
-If you can no longer maintain a package, then you should set the
-package maintainer to <tt>Debian QA Group
-<debian-qa@lists.debian.org></tt> and email &email-wnpp;
-indicating that the package is now orphaned. If the package is
-especially crucial to Debian, you should instead email
-&email-debian-devel; asking for a new maintainer.
-
+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
+&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 you feel it's necessary, send a copy
+to &email-debian-devel; by putting the address in the X-Debbugs-CC: header
+of the message (no, don't use CC:, because that way the message's subject
+won't indicate the bug number).
+ <p>
+If the package is especially crucial to Debian, you should instead submit
+a bug against <tt>wnpp</tt> and title it <tt>RFA: <var>package</var> --
+<var>short description</var></tt> and set its severity to
+<em>important</em>. Definitely copy the message to debian-devel in this
+case, as described above.
+ <p>
+Read instructions on the <url id="&url-wnpp;" name="WNPP web pages">
+for more information.
<sect id="adopting">Adopting a package
<p>
-Periodically, a listing of packages in need of new maintainers will be
-sent to &email-debian-devel list. This list is also available at in
-the Work-Needing and Prospective Packages document (WNPP), <url
-id="&url-wnpp;">. If you wish to take over maintenance of any of the
-packages listed in the WNPP, or if you can no longer maintain a
-packages you have, or you simply want to know if any one is working on
-a new package, send a message to &email-wnpp;.
+A list of packages in need of a new maintainer is available at in the
+<url name="Work-Needing and Prospective Packages list (WNPP)"
+id="&url-wnpp;">. If you wish to take over maintenance of any of the
+packages listed in the WNPP, please take a look at the aforementioned
+page for information and procedures.
<p>
It is not OK to simply take over a package that you feel is neglected
--- that would be package hijacking. You can, of course, contact the
+— that would be package hijacking. You can, of course, contact the
current maintainer and ask them if you may take over the package.
However, without their assent, you may not take over the package.
Even if they ignore you, that is still not grounds to take over a
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.
<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
For extra credit, you can go through other packages, merging bugs
which are reported more than once, or setting bug severities to
`fixed' when they have already been fixed. Note that when you are
-neither the bug submitter nor the package maintainer, you are should
+neither the bug submitter nor the package maintainer, you should
not actually close the bug (unless you secure permission from the
maintainer).
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
* Frobbed with options (closes: Bug#98339)
- * Added safety to prevent operator dismemberment, closes: bug #98765,
- bug #98713, #98714.
- * Added manpage. closes: #98725.
+ * Added safety to prevent operator dismemberment, closes: bug#98765,
+ bug#98713, #98714.
+ * Added manpage. Closes: #98725.
</example>
Technically speaking, the following Perl regular expression is what is
used:
<example>
- /closes:\s*(bug)?\#\d+(,\s*(bug)?\#\d+)*/gi
+ /closes:\s*(?:bug)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig
</example>
The author prefers the <tt>(closes: Bug#<var>XXX</var>)</tt> syntax,
<sect>Reporting lots of bugs at once
<p>
Reporting a great number of bugs for the same problem on a great
-number of different packages -- i.e., more than 10 -- is a deprecated
+number of different packages &mdash i.e., more than 10 &mdash is a deprecated
practice. Take all possible steps to avoid submitting bulk bugs at
all. For instance, if checking for the problem can be automated, add
a new check to <package>lintian</package> so that an error or warning
list.
+ <chapt id="newmaint">
+ <heading>Interaction with Prospective Developers</heading>
+
+ <p>
+This chapter describes procedures that existing Debian developers should
+follow when it comes to dealing with wannabe developers.
+
+ <sect id="sponsoring">Sponsoring packages
+ <p>
+Sponsoring a package means uploading a package for a maintainer who is not
+able to do it on their own, a new maintainer applicant. Sponsoring a package
+also means accepting responsibility for it.
+ <p>
+New maintainers usually have certain difficulties creating Debian packages
+— this is quite understandable. That is why the sponsor is there, to check
+the package and verify that it is good enough for inclusion in Debian.
+(Note that if the sponsored package is new, the FTP admins will also have to
+inspect it before letting it in.)
+ <p>
+Sponsoring merely by signing the upload or just recompiling is
+<strong>definitely not recommended</strong>. You need to build the source
+package just like you would build a package of your own. Remember that it
+doesn't matter that you left the prospective developer's name both in the
+changelog and the control file, the upload can still be traced to you.
+ <p>
+If you are an application manager for a prospective developer, you can also
+be their sponsor. That way you can also verify the how the applicant is
+handling the `Tasks and Skills' part of their application.
+
+ <sect>Advocating new developers
+ <p>
+See the page about <url id="&url-newmaint-advocate;"
+name="advocating a prospective developer"> at the Debian web site.
+
+ <sect>Handling new maintainer applications
+ <p>
+Please see <url id="&url-newmaint-amchecklist;" name="Checklist for
+Application Managers"> at the Debian web site.
+
+
+
<chapt id="tools">Overview of Debian Maintainer Tools
<p>
This section contains a rough overview of the tools available to
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>
<p>
<package>equivs</package> is another package for making packages. It
is often suggested for local use if you need to make a package simply
-to fulfill dependancies. It is also sometimes used when making
+to fulfill dependencies. It is also sometimes used when making
``meta-packages'', which are packages whose only purpose is to depend
on other packages.
~ianmdlvl / developers-reference.git / blobdiff