X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=resources.dbk;h=dc4a748c5be35bbfc01e4f0baf21fd5b3c34bc8d;hp=a1679154178c1919efa0328c09673b21dacaa3e3;hb=a6030264a6e43fbaa26bd1b2c18a7d469e653836;hpb=8a77d09ebb4f5b985db6da174892a3a66d5aa272 diff --git a/resources.dbk b/resources.dbk index a167915..dc4a748 100644 --- a/resources.dbk +++ b/resources.dbk @@ -1,6 +1,8 @@ + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + %commondata; +]> Resources for Debian Developers @@ -13,12 +15,13 @@ all the other resources that are available to help you in your maintainer work. Much of the conversation between Debian developers (and users) is managed through a wide array of mailing lists we host at lists.debian.org. 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 . This section will only -cover aspects of mailing lists that are of particular interest to developers. +url="http://&lists-host;/">&lists-host;. +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 . This section +will only cover aspects of mailing lists that are of particular interest to +developers.
Basic rules for use @@ -35,8 +38,9 @@ In general, please adhere to the usual conventions for posting messages. Please read the code of conduct -for more information. +url="&url-debian-lists;#codeofconduct">code of conduct +for more information. The Debian Community +Guidelines are also worth reading.
@@ -48,55 +52,55 @@ The core Debian mailing lists that developers should use are: -debian-devel-announce@lists.debian.org, 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. -debian-devel@lists.debian.org, used to discuss various -development related technical issues. +&email-debian-devel;, used to discuss various development +related technical issues. -debian-policy@lists.debian.org, where the Debian Policy is -discussed and voted on. +&email-debian-policy;, where the Debian Policy is discussed +and voted on. -debian-project@lists.debian.org, 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. There are other mailing lists available for a variety of special topics; see - for a list. + for a list.
Special lists -debian-private@lists.debian.org 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 -debian-private@lists.debian.org 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 not 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 lists.debian.org -and looking in the ~debian/archive/debian-private +can see them using your shell account on &lists-host; +and looking in the &file-debian-private-archive; directory. -debian-email@lists.debian.org 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.
@@ -111,9 +115,9 @@ a self-managed mailing list on Alioth is more appropriate. -If you decide that a regular mailing list on lists.debian.org is really what +If you decide that a regular mailing list on &lists-host; is really what you want, go ahead and fill in a request, following the HOWTO. +url="&url-debian-lists-new;">the HOWTO. @@ -123,7 +127,7 @@ url="http://www.debian.org/MailingLists/HOWTO_start_list">the HOWTO. IRC channels Several IRC channels are dedicated to Debian's development. They are mainly -hosted on the Open and free technology +hosted on the Open and free technology community (OFTC) network. The irc.debian.org DNS entry is an alias to irc.oftc.net. @@ -146,12 +150,12 @@ information for developers. Since #debian-devel is an open channel, you should not speak there of issues that are discussed in -debian-private@lists.debian.org. There's another channel for -this purpose, it's called #debian-private and it's -protected by a key. This key is available in the archives of debian-private in -master.debian.org:~debian/archive/debian-private/, just -zgrep for #debian-private in all the -files. +&email-debian-private;. There's another channel for this +purpose, it's called #debian-private and it's protected by +a key. This key is available in the archives of debian-private in +master.debian.org:&file-debian-private-archive;, +just zgrep for #debian-private in all +the files. There are other additional channels dedicated to specific subjects. @@ -160,9 +164,8 @@ parties. #debian-boot is used to coordinate the work on the debian-installer. #debian-doc 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: -#debian-bsd, #debian-kde, +#debian-kde, #debian-dpkg, #debian-jr, #debian-edu, -#debian-sf (SourceForge package), #debian-oo (OpenOffice package) ... @@ -172,8 +175,9 @@ Debian's development. Channels dedicated to Debian also exist on other IRC networks, notably on the -freenode IRC network, which was -pointed at by the irc.debian.org alias until 4th June 2006. +freenode IRC network, +which was pointed at by the irc.debian.org alias until 4th +June 2006. To get a cloak on freenode, you send Jörg Jaspert <joerg@debian.org> a @@ -191,7 +195,7 @@ documentation for more information about cloaks. This document contains a lot of information which is useful to Debian developers, but it cannot contain everything. Most of the other interesting -documents are linked from The +documents are linked from The Developers' Corner. Take the time to browse all the links, you will learn many more things. @@ -205,9 +209,9 @@ functions in the Debian project. Most of the machines are used for porting activities, and they all have a permanent connection to the Internet. -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 Debian Machine Usage Policies. +url="&url-dmup;">Debian Machine Usage Policies. Generally speaking, you can use these machines for Debian-related purposes as @@ -227,15 +231,17 @@ servers, unless you have prior permission. The current list of Debian machines is available at . That web page contains +url="&url-devel-machines;">. That web page contains machine names, contact information, information about who can log in, SSH keys etc. 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 -debian-admin@lists.debian.org. +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 (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. If you have a problem with a certain service, not related to the system @@ -251,8 +257,8 @@ mirrored to another server.
The bugs server -bugs.debian.org is the canonical location for the Bug -Tracking System (BTS). +&bugs-host; is the canonical location for +the Bug Tracking System (BTS). It is restricted; a mirror is available on merkel. @@ -260,38 +266,29 @@ It is restricted; a mirror is available on merkel. 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 -debian-devel@lists.debian.org 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.
The ftp-master server -The ftp-master.debian.org server holds the canonical copy of -the Debian archive (excluding the non-US packages). Generally, package uploads -go to this server; see . +The &ftp-master-host; server holds the canonical copy of +the Debian archive. Generally, package uploads go to this server; see +. It is restricted; a mirror is available on merkel. Problems with the Debian FTP archive generally need to be reported as bugs -against the ftp.debian.org -pseudo-package or an email to ftpmaster@debian.org, but also see +against the &ftp-debian-org; +pseudo-package or an email to &email-ftpmaster;, but also see the procedures in .
-
-The non-US server - -The non-US server non-us.debian.org was discontinued with -the release of sarge. The pseudo-package nonus.debian.org still exists for now. - -
-
The www-master server @@ -303,7 +300,7 @@ If you find a problem with the Debian web server, you should generally submit a bug against the pseudo-package, www.debian.org. Remember to check whether or not someone else has already reported the problem to the Bug Tracking System. +url="http://&bugs-host;/&www-debian-org;">Bug Tracking System.
@@ -330,32 +327,27 @@ materials subject to the U.S. export restrictions, in which case you can use one of the other servers located outside the United States. -Send mail to debian-devel@lists.debian.org if you have any -questions. +Send mail to &email-debian-devel; if you have any questions. -
-The CVS server - -Our CVS server is located on cvs.debian.org. - - -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. - +
+The VCS servers -Generally, cvs.debian.org offers a combination of local CVS -access, anonymous client-server read-only access, and full client-server access -through ssh. Also, the CVS area can be accessed read-only -via the Web at . +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 if you plan +to maintain packages in a VCS repository. See for +information on the services provided by Alioth. -To request a CVS area, send a request via email to -debian-admin@debian.org. 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 cvs.debian.org to host +CVS repositories. But that service is deprecated in favor of Alioth. +Only a few projects are still using it.
@@ -366,13 +358,13 @@ On some machines, there are chroots to different distributions available. You can use them like this: -% dchroot unstable +vore$ dchroot unstable Executing shell in chroot: /org/vore.debian.org/chroots/user/unstable In all chroots, the normal user home directories are available. You can find out which chroots are available via -http://db.debian.org/machines.cgi. +&url-devel-machines;.
@@ -381,14 +373,15 @@ out which chroots are available via
The Developers Database -The Developers Database, at , 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 -finger yourlogin@db.debian.org to see what it reports. +The Developers Database, at , 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 finger +yourlogin@db.debian.org to see what it reports. -Developers can log into the +Developers can log into the database to change various information about themselves, such as: @@ -411,7 +404,7 @@ whether you are on vacation personal information such as your address, country, the latitude and longitude of the place where you live for use in the world map of Debian +url="&url-worldmap;">the world map of Debian developers, phone and fax numbers, IRC nickname and web page @@ -424,86 +417,28 @@ password and preferred shell on Debian Project machines Most of the information is not accessible to the public, naturally. For more information please read the online documentation that you can find at . +url="&url-debian-db-doc;">. Developers can also submit their SSH keys to be used for authorization on the official Debian machines, and even add new *.debian.net DNS entries. Those features are documented at . +url="&url-debian-db-mail-gw;">.
The Debian archive -The Debian GNU/Linux distribution consists of a lot of packages -(.deb's, currently around 9000) and a few additional files -(such as documentation and installation disk images). +The &debian-formal; distribution consists of a lot of packages +(.deb's, currently around +&number-of-pkgs;) and a few additional files (such as +documentation and installation disk images). Here is an example directory tree of a complete Debian archive: - -/stable/main/ -dists/stable/main/binary-i386/ -dists/stable/main/binary-m68k/ -dists/stable/main/binary-alpha/ - ... -dists/stable/main/source/ - ... -dists/stable/main/disks-i386/ -dists/stable/main/disks-m68k/ -dists/stable/main/disks-alpha/ - ... - -dists/stable/contrib/ -dists/stable/contrib/binary-i386/ -dists/stable/contrib/binary-m68k/ -dists/stable/contrib/binary-alpha/ - ... -dists/stable/contrib/source/ - -dists/stable/non-free/ -dists/stable/non-free/binary-i386/ -dists/stable/non-free/binary-m68k/ -dists/stable/non-free/binary-alpha/ - ... -dists/stable/non-free/source/ - -dists/testing/ -dists/testing/main/ - ... -dists/testing/contrib/ - ... -dists/testing/non-free/ - ... - -dists/unstable -dists/unstable/main/ - ... -dists/unstable/contrib/ - ... -dists/unstable/non-free/ - ... - -pool/ -pool/main/a/ -pool/main/a/apt/ - ... -pool/main/b/ -pool/main/b/bash/ - ... -pool/main/liba/ -pool/main/liba/libalias-perl/ - ... -pool/main/m/ -pool/main/m/mailx/ - ... -pool/non-free/n/ -pool/non-free/n/netscape/ - ... - +&sample-dist-dirtree; As you can see, the top-level directory contains two directories, dists/ and pool/. The latter is a @@ -538,17 +473,17 @@ installing the Debian distribution on a specific architecture Sections The main section of the Debian archive is what makes up -the official Debian GNU/Linux distribution. +the official &debian-formal; distribution. The main 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 GNU/Linux. +&debian-formal;. Every package in the main section must fully comply with the Debian Free Software +url="&url-dfsg;">Debian Free Software Guidelines (DFSG) and with all other policy requirements as described -in the Debian Policy +in the Debian Policy Manual. The DFSG is our definition of “free software.” Check out the Debian Policy Manual for details. @@ -565,7 +500,7 @@ infrastructure (such as our bug-tracking system and mailing lists) for non-free software packages. -The Debian Policy +The Debian Policy Manual contains a more exact definition of the three sections. The above discussion is just an introduction. @@ -615,7 +550,7 @@ is m68k, alpha, mipsel and sh as of this writing. -Debian GNU/Linux 1.3 is only available as i386. Debian +&debian-formal; 1.3 is only available as i386. Debian 2.0 shipped for i386 and m68k architectures. Debian 2.1 ships for the i386, m68k, alpha, and @@ -627,7 +562,7 @@ and mipsel. Information for developers and users about the specific ports are available at -the Debian Ports web pages. +the Debian Ports web pages.
@@ -723,7 +658,7 @@ the Release Team, the distribution is released. Releasing means that new copy is created for the new testing, and the previous stable is renamed to oldstable and stays there until it is finally archived. On archiving, the contents are moved -to archive.debian.org). +to &archive-host;). This development cycle is based on the assumption that the @@ -779,10 +714,10 @@ These are the sources.list 5 lines for experimental: - - http://ftp.xy.debian.org/debian/ experimental main + +deb http://ftp.xy.debian.org/debian/ experimental main deb-src http://ftp.xy.debian.org/debian/ experimental main - + 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 experimental. For @@ -887,9 +822,9 @@ push mirroring). All the information on Debian mirrors, including a list of the available public FTP/HTTP servers, can be found at . 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;">. 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. Note that mirrors are generally run by third-parties who are interested in @@ -903,7 +838,7 @@ machines. The Incoming system is responsible for collecting updated packages and installing them in the Debian archive. It consists of a set of directories and -scripts that are installed on ftp-master.debian.org. +scripts that are installed on &ftp-master-host;. Packages are uploaded by all the maintainers into a directory called @@ -928,7 +863,7 @@ package is refused and is moved to the reject directory. 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 until it is really +at 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. @@ -941,15 +876,72 @@ The archive maintenance software will also send the OpenPGP/GnuPG signed .changes file that you uploaded to the appropriate mailing lists. If a package is released with the Distribution: set to `stable', the announcement is sent to -debian-changes@lists.debian.org. If a package is released with +&email-debian-changes;. If a package is released with Distribution: set to `unstable' or `experimental', the -announcement will be posted to -debian-devel-changes@lists.debian.org instead. +announcement will be posted to &email-debian-devel-changes; +instead. Though ftp-master is restricted, a copy of the installation is available to all -developers on merkel.debian.org. +developers on &ftp-master-mirror;. + +
@@ -958,7 +950,7 @@ developers on merkel.debian.org. On the web Each package has several dedicated web pages. -http://packages.debian.org/package-name +http://&packages-host;/package-name displays each version of the package available in the various distributions. Each version links to a page which provides information, including the package description, the dependencies, and package download links. @@ -966,7 +958,7 @@ description, the dependencies, and package download links. The bug tracking system tracks bugs for each package. You can view the bugs of a given package at the URL -http://bugs.debian.org/package-name. +http://&bugs-host;/package-name.
@@ -974,8 +966,8 @@ a given package at the URL The <command>madison</command> utility madison is a command-line utility that is available on -ftp-master.debian.org, and on the mirror on -merkel.debian.org. It uses a single argument corresponding +&ftp-master-host;, and on the mirror on +&ftp-master-mirror;. It uses a single argument corresponding to a package name. In result it displays which version of the package is available for each architecture and distribution combination. An example will explain it better. @@ -1024,7 +1016,7 @@ All the bug reports and following discussions. bts-control -The email notifications from control@bugs.debian.org about bug +The email notifications from control@&bugs-host; about bug report status changes. @@ -1053,13 +1045,22 @@ override disparity for the section and/or the priority field). Any non-automatic email sent to the PTS by people who wanted to contact the subscribers of the package. This can be done by sending mail to -sourcepackage@packages.qa.debian.org. +sourcepackage@&pts-host;. In order to prevent spam, all messages sent to these addresses must contain the X-PTS-Approved header with a non-empty value. +contact + + +Mails sent to the maintainer through the *@packages.debian.org email +aliases. + + + + summary @@ -1088,8 +1089,10 @@ how your package gets recompiled for all architectures. cvs -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. @@ -1177,7 +1180,7 @@ summary: bts-control: reply to mails sent to -control@bugs.debian.org +&email-bts-control; @@ -1188,7 +1191,13 @@ package -cvs: notification of CVS commits +contact: mails sent to the maintainer through the +*@packages.debian.org aliases + + + + +cvs: notification of VCS commits @@ -1287,7 +1296,7 @@ upload. Filtering PTS mails Once you are subscribed to a package, you will get the mails sent to -sourcepackage@packages.qa.debian.org. +sourcepackage@&pts-host;. Those mails have special headers appended to let you filter them in a special mailbox (e.g. with procmail). The added headers are X-Loop, X-PTS-Package, @@ -1298,27 +1307,33 @@ Here is an example of added headers for a source upload notification on the dpkg package: --Loop: dpkg@packages.qa.debian.org +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> -
-Forwarding CVS commits in the PTS +
+Forwarding VCS commits in the PTS -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. -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 -sourcepackage_cvs@packages.qa.debian.org. +sourcepackage_cvs@&pts-host;. Only the people who accept the cvs keyword will receive -these notifications. +these notifications. Note that the mail need to be sent from a +debian.org machine, otherwise you'll have to add +the X-PTS-Approved: 1 header. + + +For Subversion repositories, the usage of svnmailer is recommended. +See for an example on how to do it.
@@ -1326,7 +1341,7 @@ these notifications. The PTS web interface The PTS has a web interface at that puts together a lot of +url="http://&pts-host;/"> that puts together a lot of information about each source package. It features many useful links (BTS, QA stats, contact information, DDTP translation status, buildd logs) and gathers much more information from various places (30 latest changelog entries, testing @@ -1337,7 +1352,7 @@ subscription to the PTS via email. You can jump directly to the web page concerning a specific source package with a URL like -http://packages.qa.debian.org/sourcepackage. +http://&pts-host;/sourcepackage. This web interface has been designed like a portal for the development of @@ -1434,12 +1449,12 @@ The first one adds a link to the cvsweb interface of debian-cd in the Static information section: -: Raphael Hertzog <hertzog@debian.org> +From: Raphael Hertzog <hertzog@debian.org> To: pts-static-news@qa.debian.org Subject: Browse debian-cd CVS repository with cvsweb Package: debian-cd -Url: http://cvs.debian.org/debian-cd/ +Url: &url-cvsweb;debian-cd/ The second one is an announcement sent to a mailing list which is also sent to @@ -1448,7 +1463,7 @@ use of the BCC field to avoid answers sent to the PTS by mistake. : Raphael Hertzog <hertzog@debian.org> -To: debian-gtk-gnome@lists.debian.org +To: debian-gtk-gnome@&lists-host; Bcc: pts-news@qa.debian.org Subject: Galeon 2.0 backported for woody X-PTS-Package: galeon @@ -1473,12 +1488,12 @@ contained in the previous one. Developer's packages overview A QA (quality assurance) web portal is available at 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;"> 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. It is a good idea to look up your own data regularly so that you don't forget @@ -1488,19 +1503,20 @@ responsibility.
-Debian *Forge: Alioth +Debian's GForge installation: Alioth -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. 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. All Debian developers automatically have an account on Alioth. They can @@ -1508,9 +1524,14 @@ activate it by using the recover password facility. External developers can request guest accounts on Alioth. -For more information please visit . +For more information please visit the following links: + + + + + +
@@ -1521,7 +1542,7 @@ url="http://alioth.debian.org/">. Since October of 2002, HP has sponsored a subscription to LWN for all interested Debian developers. Details on how to get access to this benefit are in . +url="http://&lists-host;/debian-devel-announce/2002/10/msg00018.html">.