<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
+ <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
]>
<chapter id="resources">
<title>Resources for Debian Developers</title>
<para>
Much of the conversation between Debian developers (and users) is managed
through a wide array of mailing lists we host at <literal><ulink
-url="http://&lists-host;/">&lists-host;</ulink></literal>. To find out
-more on how to subscribe or unsubscribe, how to post and how not to post, where
-to find old posts and how to search them, how to contact the list maintainers
-and see various other information about the mailing lists, please read <ulink
-url="&url-debian-lists;"></ulink>. This section will only
-cover aspects of mailing lists that are of particular interest to developers.
+url="http://&lists-host;/">&lists-host;</ulink></literal>.
+To find out more on how to subscribe or unsubscribe, how to post and how not to
+post, where to find old posts and how to search them, how to contact the list
+maintainers and see various other information about the mailing lists, please
+read <ulink url="&url-debian-lists;"></ulink>. This section
+will only cover aspects of mailing lists that are of particular interest to
+developers.
</para>
<section id="mailing-lists-rules">
<title>Basic rules for use</title>
<para>
Please read the <ulink
url="&url-debian-lists;#codeofconduct">code of conduct</ulink>
-for more information.
+for more information. The <ulink url="&url-dcg;">Debian Community
+Guidelines</ulink> are also worth reading.
</para>
</section>
<itemizedlist>
<listitem>
<para>
-<email>debian-devel-announce@&lists-host;</email>, used to announce
-important things to developers. All developers are expected to be subscribed
-to this list.
+&email-debian-devel-announce;, used to announce important
+things to developers. All developers are expected to be subscribed to this
+list.
</para>
</listitem>
<listitem>
<para>
-<email>debian-devel@&lists-host;</email>, used to discuss various
-development related technical issues.
+&email-debian-devel;, used to discuss various development
+related technical issues.
</para>
</listitem>
<listitem>
<para>
-<email>debian-policy@&lists-host;</email>, where the Debian Policy is
-discussed and voted on.
+&email-debian-policy;, where the Debian Policy is discussed
+and voted on.
</para>
</listitem>
<listitem>
<para>
-<email>debian-project@&lists-host;</email>, used to discuss various
-non-technical issues related to the project.
+&email-debian-project;, used to discuss various non-technical
+issues related to the project.
</para>
</listitem>
</itemizedlist>
<section id="mailing-lists-special">
<title>Special lists</title>
<para>
-<email>debian-private@&lists-host;</email> 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 publicly. As such, it
-is a low volume list, and users are urged not to use
-<email>debian-private@&lists-host;</email> unless it is really necessary.
+&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 publicly. As such, it is a low
+volume list, and users are urged not to use
+&email-debian-private; unless it is really necessary.
Moreover, do <emphasis>not</emphasis> forward email from that list to anyone.
Archives of this list are not available on the web for obvious reasons, but you
can see them using your shell account on <literal>&lists-host;</literal>
directory.
</para>
<para>
-<email>debian-email@&lists-host;</email> is a special mailing list used as
-a grab-bag for Debian related correspondence such as contacting upstream
-authors about licenses, bugs, etc. or discussing the project with others where
-it might be useful to have the discussion archived somewhere.
+&email-debian-email; is a special mailing list used as a
+grab-bag for Debian related correspondence such as contacting upstream authors
+about licenses, bugs, etc. or discussing the project with others where it
+might be useful to have the discussion archived somewhere.
</para>
</section>
<title>IRC channels</title>
<para>
Several IRC channels are dedicated to Debian's development. They are mainly
-hosted on the <ulink url="http://www.oftc.net/oftc/">Open and free technology
+hosted on the <ulink url="&url-oftc;">Open and free technology
community (OFTC)</ulink> network. The <literal>irc.debian.org</literal> DNS
entry is an alias to <literal>irc.oftc.net</literal>.
</para>
<para>
Since <emphasis>#debian-devel</emphasis> is an open channel, you should not
speak there of issues that are discussed in
-<email>debian-private@&lists-host;</email>. There's another channel for
-this purpose, it's called <emphasis>#debian-private</emphasis> and it's
-protected by a key. This key is available in the archives of debian-private in
-<filename>master.debian.org:&file-debian-private-archive;</filename>, just
-<command>zgrep</command> for <emphasis>#debian-private</emphasis> in all the
-files.
+&email-debian-private;. There's another channel for this
+purpose, it's called <emphasis>#debian-private</emphasis> and it's protected by
+a key. This key is available in the archives of debian-private in
+<filename>master.debian.org:&file-debian-private-archive;</filename>,
+just <command>zgrep</command> for <emphasis>#debian-private</emphasis> in all
+the files.
</para>
<para>
There are other additional channels dedicated to specific subjects.
the debian-installer. <emphasis>#debian-doc</emphasis> is occasionally used to
talk about documentation, like the document you are reading. Other channels
are dedicated to an architecture or a set of packages:
-<emphasis>#debian-bsd</emphasis>, <emphasis>#debian-kde</emphasis>,
+<emphasis>#debian-kde</emphasis>, <emphasis>#debian-dpkg</emphasis>,
<emphasis>#debian-jr</emphasis>, <emphasis>#debian-edu</emphasis>,
-<emphasis>#debian-sf</emphasis> (SourceForge package),
<emphasis>#debian-oo</emphasis> (OpenOffice package) ...
</para>
<para>
</para>
<para>
Channels dedicated to Debian also exist on other IRC networks, notably on the
-<ulink url="http://www.freenode.net/">freenode</ulink> IRC network, which was
-pointed at by the <literal>irc.debian.org</literal> alias until 4th June 2006.
+<ulink url="&url-openprojects;">freenode</ulink> IRC network,
+which was pointed at by the <literal>irc.debian.org</literal> alias until 4th
+June 2006.
</para>
<para>
To get a cloak on freenode, you send Jörg Jaspert <joerg@debian.org> a
activities, and they all have a permanent connection to the Internet.
</para>
<para>
-Most of the machines are available for individual developers to use, as long as
+Some of the machines are available for individual developers to use, as long as
the developers follow the rules set forth in the <ulink
-url="&url-devel-docs;dmup">Debian Machine Usage Policies</ulink>.
+url="&url-dmup;">Debian Machine Usage Policies</ulink>.
</para>
<para>
Generally speaking, you can use these machines for Debian-related purposes as
</para>
<para>
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, the Debian system
-administrator team is reachable at
-<email>debian-admin@&lists-host;</email>.
+the system operators need to be notified of this problem, you can check
+the list of open issues in the DSA queue of our request tracker at <ulink
+url="&url-rt;" /> (you can login with user "guest" and password "readonly").
+To report a new problem, simply send a mail to &email-rt-dsa; and make
+sure to put the string "Debian RT" somewhere in the subject.
</para>
<para>
If you have a problem with a certain service, not related to the system
<section id="servers-bugs">
<title>The bugs server</title>
<para>
-<literal>&bugs-host;</literal> is the canonical location for the Bug
-Tracking System (BTS).
+<literal>&bugs-host;</literal> is the canonical location for
+the Bug Tracking System (BTS).
</para>
<para>
It is restricted; a mirror is available on <literal>merkel</literal>.
<para>
If you plan on doing some statistical analysis or processing of Debian bugs,
this would be the place to do it. Please describe your plans on
-<email>debian-devel@&lists-host;</email> before implementing anything,
-however, to reduce unnecessary duplication of effort or wasted processing time.
+&email-debian-devel; before implementing anything, however, to
+reduce unnecessary duplication of effort or wasted processing time.
</para>
</section>
<title>The ftp-master server</title>
<para>
The <literal>&ftp-master-host;</literal> server holds the canonical copy of
-the Debian archive (excluding the non-US packages). Generally, package uploads
-go to this server; see <xref linkend="upload"/> .
+the Debian archive. Generally, package uploads go to this server; see
+<xref linkend="upload"/>.
</para>
<para>
It is restricted; a mirror is available on <literal>merkel</literal>.
<para>
Problems with the Debian FTP archive generally need to be reported as bugs
against the <systemitem role="package">&ftp-debian-org;</systemitem>
-pseudo-package or an email to <email>ftpmaster@debian.org</email>, but also see
+pseudo-package or an email to &email-ftpmaster;, but also see
the procedures in <xref linkend="archive-manip"/> .
</para>
</section>
-<section id="servers-non-us">
-<title>The non-US server</title>
-<para>
-The non-US server <literal>&non-us-host;</literal> was discontinued with
-the release of sarge. The pseudo-package <systemitem
-role="package">nonus.debian.org</systemitem> still exists for now.
-</para>
-</section>
-
<section id="servers-www">
<title>The www-master server</title>
<para>
<para>
If you find a problem with the Debian web server, you should generally submit a
bug against the pseudo-package, <systemitem
-role="package">&www-debian-org;</systemitem>. Remember to check whether or not
+role="package">www.debian.org</systemitem>. Remember to check whether or not
someone else has already reported the problem to the <ulink
url="http://&bugs-host;/&www-debian-org;">Bug Tracking System</ulink>.
</para>
one of the other servers located outside the United States.
</para>
<para>
-Send mail to <email>debian-devel@&lists-host;</email> if you have any
-questions.
+Send mail to &email-debian-devel; if you have any questions.
</para>
</section>
-<section id="servers-cvs">
-<title>The CVS server</title>
-<!-- TODO: document svn.debian.org, arch.debian.org also -->
-<para>
-Our CVS server is located on <literal>cvs.debian.org</literal>.
-</para>
+<section id="servers-vcs">
+<title>The VCS servers</title>
<para>
-If you need to use a publicly 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.
+If you need to use a Version Control System for any of your Debian work,
+you can use one the existing repositories hosted on Alioth or you can
+request a new project and ask for the VCS repository of your choice.
+Alioth supports CVS (alioth.debian.org), Subversion
+(svn.debian.org), Arch (tla/baz, both on arch.debian.org), Bazaar
+(bzr.debian.org), Darcs (darcs.debian.org), Mercurial (hg.debian.org) and Git
+(git.debian.org). Checkout <ulink url="&url-alioth-pkg;" /> if you plan
+to maintain packages in a VCS repository. See <xref linkend="alioth"/> for
+information on the services provided by Alioth.
</para>
<para>
-Generally, <literal>cvs.debian.org</literal> offers a combination of local CVS
-access, anonymous client-server read-only access, and full client-server access
-through <command>ssh</command>. Also, the CVS area can be accessed read-only
-via the Web at <ulink url="&url-cvsweb;"></ulink>.
-</para>
-<para>
-To request a CVS area, send a request via email to
-<email>debian-admin@debian.org</email>. Include the name of the requested CVS
-area, the Debian account that should own the CVS root area, and why you need
-it.
+Historically, Debian first used <literal>cvs.debian.org</literal> to host
+CVS repositories. But that service is deprecated in favor of Alioth.
+Only a few projects are still using it.
</para>
</section>
<section id="devel-db">
<title>The Developers Database</title>
<para>
-The Developers Database, at <ulink url="&url-debian-db;"></ulink>, is an
-LDAP directory for managing Debian developer attributes. You can use this
-resource to search the list of Debian developers. Part of this information is
-also available through the finger service on Debian servers, try
-<command>finger yourlogin@db.debian.org</command> to see what it reports.
+The Developers Database, at <ulink
+url="&url-debian-db;"></ulink>, is an LDAP directory for
+managing Debian developer attributes. You can use this resource to search the
+list of Debian developers. Part of this information is also available through
+the finger service on Debian servers, try <command>finger
+yourlogin@db.debian.org</command> to see what it reports.
</para>
<para>
Developers can <ulink url="&url-debian-db-login;">log into the
<para>
personal information such as your address, country, the latitude and longitude
of the place where you live for use in <ulink
-url="&url-devel-docs;developers.loc">the world map of Debian
+url="&url-worldmap;">the world map of Debian
developers</ulink>, phone and fax numbers, IRC nickname and web page
</para>
</listitem>
<title>The Debian archive</title>
<para>
The &debian-formal; distribution consists of a lot of packages
-(<filename>.deb</filename>'s, currently around &number-of-pkgs;) and a few additional files
-(such as documentation and installation disk images).
+(<filename>.deb</filename>'s, currently around
+&number-of-pkgs;) and a few additional files (such as
+documentation and installation disk images).
</para>
<para>
Here is an example directory tree of a complete Debian archive:
<para>
All the information on Debian mirrors, including a list of the available public
FTP/HTTP servers, can be found at <ulink
-url="url-debian-mirroring"></ulink>. This useful page also includes
-information and tools which can be helpful if you are interested in setting up
-your own mirror, either for internal or public access.
+url="&url-debian-mirrors;"></ulink>. This useful page also
+includes information and tools which can be helpful if you are interested in
+setting up your own mirror, either for internal or public access.
</para>
<para>
Note that mirrors are generally run by third-parties who are interested in
Once the package is accepted, the system sends a confirmation mail to the
maintainer and closes all the bugs marked as fixed by the upload, and the
auto-builders may start recompiling it. The package is now publicly accessible
-at <ulink url="http://incoming.debian.org/"></ulink> until it is really
+at <ulink url="&url-incoming;"></ulink> until it is really
installed in the Debian archive. This happens only once a day (and is also
called the `dinstall run' for historical reasons); the package is then removed
from incoming and installed in the pool along with all the other packages.
<filename>.changes</filename> file that you uploaded to the appropriate mailing
lists. If a package is released with the <literal>Distribution:</literal> set
to `stable', the announcement is sent to
-<email>debian-changes@&lists-host;</email>. If a package is released with
+&email-debian-changes;. If a package is released with
<literal>Distribution:</literal> set to `unstable' or `experimental', the
-announcement will be posted to
-<email>debian-devel-changes@&lists-host;</email> instead.
+announcement will be posted to &email-debian-devel-changes;
+instead.
</para>
<para>
Though ftp-master is restricted, a copy of the installation is available to all
</listitem>
</varlistentry>
<varlistentry>
+<term><literal>contact</literal></term>
+<listitem>
+<para>
+Mails sent to the maintainer through the *@packages.debian.org email
+aliases.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
<term><literal>summary</literal></term>
<listitem>
<para>
<term><literal>cvs</literal></term>
<listitem>
<para>
-CVS commit notifications, if the package has a CVS repository and the
-maintainer has set up forwarding commit notifications to the PTS.
+VCS commit notifications, if the package has a VCS repository and the
+maintainer has set up forwarding of commit notifications to the PTS. The
+"cvs" name is historic, in most cases commit notifications will come
+from some other VCS like subversion or git.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
<literal>bts-control</literal>: reply to mails sent to
-<email>control@&bugs-host;</email>
+&email-bts-control;
</para>
</listitem>
<listitem>
</listitem>
<listitem>
<para>
-<literal>cvs</literal>: notification of CVS commits
+<literal>contact</literal>: mails sent to the maintainer through the
+*@packages.debian.org aliases
+</para>
+</listitem>
+<listitem>
+<para>
+<literal>cvs</literal>: notification of VCS commits
</para>
</listitem>
<listitem>
X-Loop: dpkg@&pts-host;
X-PTS-Package: dpkg
X-PTS-Keyword: upload-source
-X-Unsubscribe: echo 'unsubscribe dpkg' | mail pts@qa.debian.org
+List-Unsubscribe: <mailto:pts@qa.debian.org?body=unsubscribe+dpkg>
</screen>
</section>
-<section id="pts-cvs-commit">
-<title>Forwarding CVS commits in the PTS</title>
+<section id="pts-vcs-commit">
+<title>Forwarding VCS commits in the PTS</title>
<para>
-If you use a publicly accessible CVS repository for maintaining your Debian
+If you use a publicly accessible VCS repository for maintaining your Debian
package, you may want to forward the commit notification to the PTS so that the
subscribers (and possible co-maintainers) can closely follow the package's
evolution.
</para>
<para>
-Once you set up the CVS repository to generate commit notifications, you just
+Once you set up the VCS repository to generate commit notifications, you just
have to make sure it sends a copy of those mails to
<literal><replaceable>sourcepackage</replaceable>_cvs@&pts-host;</literal>.
Only the people who accept the <emphasis>cvs</emphasis> keyword will receive
-these notifications.
+these notifications. Note that the mail need to be sent from a
+<literal>debian.org</literal> machine, otherwise you'll have to add
+the <literal>X-PTS-Approved: 1</literal> header.
+</para>
+<para>
+For Subversion repositories, the usage of svnmailer is recommended.
+See <ulink url="&url-alioth-pkg;" /> for an example on how to do it.
</para>
</section>
<title>Developer's packages overview</title>
<para>
A QA (quality assurance) web portal is available at <ulink
-url="&url-debian-qa;developer.php"></ulink> which displays a table
-listing all the packages of a single developer (including those where the party
-is listed as a co-maintainer). The table gives a good summary about the
-developer's packages: number of bugs by severity, list of available versions in
-each distribution, testing status and much more including links to any other
-useful information.
+url="&url-ddpo;"></ulink> which displays a table listing all
+the packages of a single developer (including those where the party is listed
+as a co-maintainer). The table gives a good summary about the developer's
+packages: number of bugs by severity, list of available versions in each
+distribution, testing status and much more including links to any other useful
+information.
</para>
<para>
It is a good idea to look up your own data regularly so that you don't forget
</section>
<section id="alioth">
-<title>Debian *Forge: Alioth</title>
+<title>Debian's GForge installation: Alioth</title>
<para>
-Alioth is a fairly new Debian service, based on a slightly modified version of
-the GForge software (which evolved from SourceForge). This software offers
-developers access to easy-to-use tools such as bug trackers, patch manager,
-project/task managers, file hosting services, mailing lists, CVS repositories
-etc. All these tools are managed via a web interface.
+Alioth is a Debian service based on a slightly modified version of the
+GForge software (which evolved from SourceForge). This software offers
+developers access to easy-to-use tools such as bug trackers, patch
+manager, project/task managers, file hosting services, mailing lists, CVS
+repositories etc. All these tools are managed via a web interface.
</para>
<para>
It is intended to provide facilities to free software projects backed or led by
Debian, facilitate contributions from external developers to projects started
by Debian, and help projects whose goals are the promotion of Debian or its
-derivatives.
+derivatives. It's heavily used by many Debian teams and provides
+hosting for all sorts of VCS repositories.
</para>
<para>
All Debian developers automatically have an account on Alioth. They can
request guest accounts on Alioth.
</para>
<para>
-For more information please visit <ulink
-url="http://alioth.debian.org/"></ulink>.
+For more information please visit the following links:
</para>
+<itemizedlist>
+<listitem><para><ulink url="&url-alioth-wiki;" /></para></listitem>
+<listitem><para><ulink url="&url-alioth-faq;" /></para></listitem>
+<listitem><para><ulink url="&url-alioth-pkg;" /></para></listitem>
+<listitem><para><ulink url="&url-alioth;" /></para></listitem>
+</itemizedlist>
</section>
<section id="developer-misc">
~ianmdlvl / developers-reference.git / blobdiff