| 1 |
<?xml version="1.0" encoding="utf-8"?>
|
| 2 |
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
| 3 |
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
| 4 |
<!ENTITY % commondata SYSTEM "common.ent" > %commondata;
|
| 5 |
]>
|
| 6 |
<chapter id="resources">
|
| 7 |
<title>Resources for Debian Developers</title>
|
| 8 |
<para>
|
| 9 |
In this chapter you will find a very brief road map of the Debian mailing
|
| 10 |
lists, the Debian machines which may be available to you as a developer, and
|
| 11 |
all the other resources that are available to help you in your maintainer work.
|
| 12 |
</para>
|
| 13 |
<section id="mailing-lists">
|
| 14 |
<title>Mailing lists</title>
|
| 15 |
<para>
|
| 16 |
Much of the conversation between Debian developers (and users) is managed
|
| 17 |
through a wide array of mailing lists we host at <literal><ulink
|
| 18 |
url="http://&lists-host;/">&lists-host;</ulink></literal>.
|
| 19 |
To find out more on how to subscribe or unsubscribe, how to post and how not to
|
| 20 |
post, where to find old posts and how to search them, how to contact the list
|
| 21 |
maintainers and see various other information about the mailing lists, please
|
| 22 |
read <ulink url="&url-debian-lists;"></ulink>. This section
|
| 23 |
will only cover aspects of mailing lists that are of particular interest to
|
| 24 |
developers.
|
| 25 |
</para>
|
| 26 |
<section id="mailing-lists-rules">
|
| 27 |
<title>Basic rules for use</title>
|
| 28 |
<para>
|
| 29 |
When replying to messages on the mailing list, please do not send a carbon copy
|
| 30 |
(<literal>CC</literal>) to the original poster unless they explicitly request
|
| 31 |
to be copied. Anyone who posts to a mailing list should read it to see the
|
| 32 |
responses.
|
| 33 |
</para>
|
| 34 |
<para>
|
| 35 |
Cross-posting (sending the same message to multiple lists) is discouraged. As
|
| 36 |
ever on the net, please trim down the quoting of articles you're replying to.
|
| 37 |
In general, please adhere to the usual conventions for posting messages.
|
| 38 |
</para>
|
| 39 |
<para>
|
| 40 |
Please read the <ulink
|
| 41 |
url="&url-debian-lists;#codeofconduct">code of conduct</ulink>
|
| 42 |
for more information. The <ulink url="&url-dcg;">Debian Community
|
| 43 |
Guidelines</ulink> are also worth reading.
|
| 44 |
</para>
|
| 45 |
</section>
|
| 46 |
|
| 47 |
<section id="core-devel-mailing-lists">
|
| 48 |
<title>Core development mailing lists</title>
|
| 49 |
<para>
|
| 50 |
The core Debian mailing lists that developers should use are:
|
| 51 |
</para>
|
| 52 |
<itemizedlist>
|
| 53 |
<listitem>
|
| 54 |
<para>
|
| 55 |
&email-debian-devel-announce;, used to announce important
|
| 56 |
things to developers. All developers are expected to be subscribed to this
|
| 57 |
list.
|
| 58 |
</para>
|
| 59 |
</listitem>
|
| 60 |
<listitem>
|
| 61 |
<para>
|
| 62 |
&email-debian-devel;, used to discuss various development
|
| 63 |
related technical issues.
|
| 64 |
</para>
|
| 65 |
</listitem>
|
| 66 |
<listitem>
|
| 67 |
<para>
|
| 68 |
&email-debian-policy;, where the Debian Policy is discussed
|
| 69 |
and voted on.
|
| 70 |
</para>
|
| 71 |
</listitem>
|
| 72 |
<listitem>
|
| 73 |
<para>
|
| 74 |
&email-debian-project;, used to discuss various non-technical
|
| 75 |
issues related to the project.
|
| 76 |
</para>
|
| 77 |
</listitem>
|
| 78 |
</itemizedlist>
|
| 79 |
<para>
|
| 80 |
There are other mailing lists available for a variety of special topics; see
|
| 81 |
<ulink url="http://&lists-host;/"></ulink> for a list.
|
| 82 |
</para>
|
| 83 |
</section>
|
| 84 |
|
| 85 |
<section id="mailing-lists-special">
|
| 86 |
<title>Special lists</title>
|
| 87 |
<para>
|
| 88 |
&email-debian-private; is a special mailing list for private
|
| 89 |
discussions amongst Debian developers. It is meant to be used for posts which
|
| 90 |
for whatever reason should not be published publicly. As such, it is a low
|
| 91 |
volume list, and users are urged not to use
|
| 92 |
&email-debian-private; unless it is really necessary.
|
| 93 |
Moreover, do <emphasis>not</emphasis> forward email from that list to anyone.
|
| 94 |
Archives of this list are not available on the web for obvious reasons, but you
|
| 95 |
can see them using your shell account on <literal>&master-host;</literal>
|
| 96 |
and looking in the <filename>&file-debian-private-archive;</filename>
|
| 97 |
directory.
|
| 98 |
</para>
|
| 99 |
<para>
|
| 100 |
&email-debian-email; is a special mailing list used as a
|
| 101 |
grab-bag for Debian related correspondence such as contacting upstream authors
|
| 102 |
about licenses, bugs, etc. or discussing the project with others where it
|
| 103 |
might be useful to have the discussion archived somewhere.
|
| 104 |
</para>
|
| 105 |
</section>
|
| 106 |
|
| 107 |
<section id="mailing-lists-new">
|
| 108 |
<title>Requesting new development-related lists</title>
|
| 109 |
<para>
|
| 110 |
Before requesting a mailing list that relates to the development of a package
|
| 111 |
(or a small group of related packages), please consider if using an alias (via
|
| 112 |
a .forward-aliasname file on master.debian.org, which translates into a
|
| 113 |
reasonably nice <replaceable>you-aliasname@debian.org</replaceable> address) or
|
| 114 |
a self-managed mailing list on <link linkend="alioth">Alioth</link> is
|
| 115 |
more appropriate.
|
| 116 |
</para>
|
| 117 |
<para>
|
| 118 |
If you decide that a regular mailing list on &lists-host; is really what
|
| 119 |
you want, go ahead and fill in a request, following <ulink
|
| 120 |
url="&url-debian-lists-new;">the HOWTO</ulink>.
|
| 121 |
</para>
|
| 122 |
</section>
|
| 123 |
|
| 124 |
</section>
|
| 125 |
|
| 126 |
<section id="irc-channels">
|
| 127 |
<title>IRC channels</title>
|
| 128 |
<para>
|
| 129 |
Several IRC channels are dedicated to Debian's development. They are mainly
|
| 130 |
hosted on the <ulink url="&url-oftc;">Open and free technology
|
| 131 |
community (OFTC)</ulink> network. The <literal>irc.debian.org</literal> DNS
|
| 132 |
entry is an alias to <literal>irc.oftc.net</literal>.
|
| 133 |
</para>
|
| 134 |
<para>
|
| 135 |
The main channel for Debian in general is <literal>#debian</literal>. This
|
| 136 |
is a large, general-purpose channel where users can find recent news in the
|
| 137 |
topic and served by bots. <literal>#debian</literal> is for English
|
| 138 |
speakers; there are also <literal>#debian.de</literal>,
|
| 139 |
<literal>#debian-fr</literal>, <literal>#debian-br</literal> and other
|
| 140 |
similarly named channels for speakers of other languages.
|
| 141 |
</para>
|
| 142 |
<para>
|
| 143 |
The main channel for Debian development is <literal>#debian-devel</literal>.
|
| 144 |
It is a very active channel since usually over 150 people are always logged in.
|
| 145 |
It's a channel for people who work on Debian, it's not a support channel
|
| 146 |
(there's <literal>#debian</literal> for that). It is however open to anyone
|
| 147 |
who wants to lurk (and learn). Its topic is commonly full of interesting
|
| 148 |
information for developers.
|
| 149 |
</para>
|
| 150 |
<para>
|
| 151 |
Since <literal>#debian-devel</literal> is an open channel, you should not
|
| 152 |
speak there of issues that are discussed in
|
| 153 |
&email-debian-private;. There's another channel for this
|
| 154 |
purpose, it's called <literal>#debian-private</literal> and it's protected by
|
| 155 |
a key. This key is available at
|
| 156 |
<filename>master.debian.org:&file-debian-private-key;</filename>.
|
| 157 |
</para>
|
| 158 |
<para>
|
| 159 |
There are other additional channels dedicated to specific subjects.
|
| 160 |
<literal>#debian-bugs</literal> is used for coordinating bug squashing
|
| 161 |
parties. <literal>#debian-boot</literal> is used to coordinate the work on
|
| 162 |
the debian-installer. <literal>#debian-doc</literal> is occasionally used to
|
| 163 |
talk about documentation, like the document you are reading. Other channels
|
| 164 |
are dedicated to an architecture or a set of packages:
|
| 165 |
<literal>#debian-kde</literal>, <literal>#debian-dpkg</literal>,
|
| 166 |
<literal>#debian-jr</literal>, <literal>#debian-edu</literal>,
|
| 167 |
<literal>#debian-oo</literal> (OpenOffice package) ...
|
| 168 |
</para>
|
| 169 |
<para>
|
| 170 |
Some non-English developers' channels exist as well, for example
|
| 171 |
<literal>#debian-devel-fr</literal> for French speaking people interested in
|
| 172 |
Debian's development.
|
| 173 |
</para>
|
| 174 |
<para>
|
| 175 |
Channels dedicated to Debian also exist on other IRC networks, notably on the
|
| 176 |
<ulink url="&url-openprojects;">freenode</ulink> IRC network,
|
| 177 |
which was pointed at by the <literal>irc.debian.org</literal> alias until 4th
|
| 178 |
June 2006.
|
| 179 |
</para>
|
| 180 |
<para>
|
| 181 |
To get a cloak on freenode, you send Jörg Jaspert <joerg@debian.org> a
|
| 182 |
signed mail where you tell what your nick is. Put cloak somewhere in the
|
| 183 |
Subject: header. The nick should be registered: <ulink
|
| 184 |
url="http://freenode.net/faq.shtml#nicksetup">Nick Setup Page</ulink>. The
|
| 185 |
mail needs to be signed by a key in the Debian keyring. Please see <ulink
|
| 186 |
url="http://freenode.net/faq.shtml#projectcloak">Freenodes
|
| 187 |
documentation</ulink> for more information about cloaks.
|
| 188 |
</para>
|
| 189 |
</section>
|
| 190 |
|
| 191 |
<section id="doc-rsrcs">
|
| 192 |
<title>Documentation</title>
|
| 193 |
<para>
|
| 194 |
This document contains a lot of information which is useful to Debian
|
| 195 |
developers, but it cannot contain everything. Most of the other interesting
|
| 196 |
documents are linked from <ulink url="&url-devel-docs;">The
|
| 197 |
Developers' Corner</ulink>. Take the time to browse all the links, you will
|
| 198 |
learn many more things.
|
| 199 |
</para>
|
| 200 |
</section>
|
| 201 |
|
| 202 |
<section id="server-machines">
|
| 203 |
<title>Debian machines</title>
|
| 204 |
<para>
|
| 205 |
Debian has several computers working as servers, most of which serve critical
|
| 206 |
functions in the Debian project. Most of the machines are used for porting
|
| 207 |
activities, and they all have a permanent connection to the Internet.
|
| 208 |
</para>
|
| 209 |
<para>
|
| 210 |
Some of the machines are available for individual developers to use, as long as
|
| 211 |
the developers follow the rules set forth in the <ulink
|
| 212 |
url="&url-dmup;">Debian Machine Usage Policies</ulink>.
|
| 213 |
</para>
|
| 214 |
<para>
|
| 215 |
Generally speaking, you can use these machines for Debian-related purposes as
|
| 216 |
you see fit. Please be kind to system administrators, and do not use up tons
|
| 217 |
and tons of disk space, network bandwidth, or CPU without first getting the
|
| 218 |
approval of the system administrators. Usually these machines are run by
|
| 219 |
volunteers.
|
| 220 |
</para>
|
| 221 |
<para>
|
| 222 |
Please take care to protect your Debian passwords and SSH keys installed on
|
| 223 |
Debian machines. Avoid login or upload methods which send passwords over the
|
| 224 |
Internet in the clear, such as telnet, FTP, POP etc.
|
| 225 |
</para>
|
| 226 |
<para>
|
| 227 |
Please do not put any material that doesn't relate to Debian on the Debian
|
| 228 |
servers, unless you have prior permission.
|
| 229 |
</para>
|
| 230 |
<para>
|
| 231 |
The current list of Debian machines is available at <ulink
|
| 232 |
url="&url-devel-machines;"></ulink>. That web page contains
|
| 233 |
machine names, contact information, information about who can log in, SSH keys
|
| 234 |
etc.
|
| 235 |
</para>
|
| 236 |
<para>
|
| 237 |
If you have a problem with the operation of a Debian server, and you think that
|
| 238 |
the system operators need to be notified of this problem, you can check
|
| 239 |
the list of open issues in the DSA queue of our request tracker at <ulink
|
| 240 |
url="&url-rt;" /> (you can login with user "guest" and password "readonly").
|
| 241 |
To report a new problem, simply send a mail to &email-rt-dsa; and make
|
| 242 |
sure to put the string "Debian RT" somewhere in the subject.
|
| 243 |
</para>
|
| 244 |
<para>
|
| 245 |
If you have a problem with a certain service, not related to the system
|
| 246 |
administration (such as packages to be removed from the archive, suggestions
|
| 247 |
for the web site, etc.), generally you'll report a bug against a
|
| 248 |
``pseudo-package''. See <xref linkend="submit-bug"/> for information on how to
|
| 249 |
submit bugs.
|
| 250 |
</para>
|
| 251 |
<para>
|
| 252 |
Some of the core servers are restricted, but the information from there is
|
| 253 |
mirrored to another server.
|
| 254 |
</para>
|
| 255 |
<section id="servers-bugs">
|
| 256 |
<title>The bugs server</title>
|
| 257 |
<para>
|
| 258 |
<literal>&bugs-host;</literal> is the canonical location for
|
| 259 |
the Bug Tracking System (BTS).
|
| 260 |
</para>
|
| 261 |
<para>
|
| 262 |
It is restricted; a mirror is available on <literal>merkel</literal>.
|
| 263 |
</para>
|
| 264 |
<para>
|
| 265 |
If you plan on doing some statistical analysis or processing of Debian bugs,
|
| 266 |
this would be the place to do it. Please describe your plans on
|
| 267 |
&email-debian-devel; before implementing anything, however, to
|
| 268 |
reduce unnecessary duplication of effort or wasted processing time.
|
| 269 |
</para>
|
| 270 |
</section>
|
| 271 |
|
| 272 |
<section id="servers-ftp-master">
|
| 273 |
<title>The ftp-master server</title>
|
| 274 |
<para>
|
| 275 |
The <literal>&ftp-master-host;</literal> server holds the canonical copy of
|
| 276 |
the Debian archive. Generally, package uploaded to &ftp-upload-host;
|
| 277 |
end up on this server, see <xref linkend="upload"/>.
|
| 278 |
</para>
|
| 279 |
<para>
|
| 280 |
It is restricted; a mirror is available on <literal>merkel</literal>.
|
| 281 |
</para>
|
| 282 |
<para>
|
| 283 |
Problems with the Debian FTP archive generally need to be reported as bugs
|
| 284 |
against the <systemitem role="package">&ftp-debian-org;</systemitem>
|
| 285 |
pseudo-package or an email to &email-ftpmaster;, but also see
|
| 286 |
the procedures in <xref linkend="archive-manip"/> .
|
| 287 |
</para>
|
| 288 |
</section>
|
| 289 |
|
| 290 |
<section id="servers-www">
|
| 291 |
<title>The www-master server</title>
|
| 292 |
<para>
|
| 293 |
The main web server is <literal>www-master.debian.org</literal>. It holds the
|
| 294 |
official web pages, the face of Debian for most newbies.
|
| 295 |
</para>
|
| 296 |
<para>
|
| 297 |
If you find a problem with the Debian web server, you should generally submit a
|
| 298 |
bug against the pseudo-package, <systemitem
|
| 299 |
role="package">www.debian.org</systemitem>. Remember to check whether or not
|
| 300 |
someone else has already reported the problem to the <ulink
|
| 301 |
url="http://&bugs-host;/&www-debian-org;">Bug Tracking System</ulink>.
|
| 302 |
</para>
|
| 303 |
</section>
|
| 304 |
|
| 305 |
<section id="servers-people">
|
| 306 |
<title>The people web server</title>
|
| 307 |
<para>
|
| 308 |
<literal>people.debian.org</literal> is the server used for developers' own web
|
| 309 |
pages about anything related to Debian.
|
| 310 |
</para>
|
| 311 |
<para>
|
| 312 |
If you have some Debian-specific information which you want to serve on the
|
| 313 |
web, you can do this by putting material in the
|
| 314 |
<filename>public_html</filename> directory under your home directory on
|
| 315 |
<literal>people.debian.org</literal>. This will be accessible at the URL
|
| 316 |
<literal>http://people.debian.org/~<replaceable>your-user-id</replaceable>/</literal>.
|
| 317 |
</para>
|
| 318 |
<para>
|
| 319 |
You should only use this particular location because it will be backed up,
|
| 320 |
whereas on other hosts it won't.
|
| 321 |
</para>
|
| 322 |
<para>
|
| 323 |
Usually the only reason to use a different host is when you need to publish
|
| 324 |
materials subject to the U.S. export restrictions, in which case you can use
|
| 325 |
one of the other servers located outside the United States.
|
| 326 |
</para>
|
| 327 |
<para>
|
| 328 |
Send mail to &email-debian-devel; if you have any questions.
|
| 329 |
</para>
|
| 330 |
</section>
|
| 331 |
|
| 332 |
<section id="servers-vcs">
|
| 333 |
<title>The VCS servers</title>
|
| 334 |
<para>
|
| 335 |
If you need to use a Version Control System for any of your Debian work,
|
| 336 |
you can use one the existing repositories hosted on Alioth or you can
|
| 337 |
request a new project and ask for the VCS repository of your choice.
|
| 338 |
Alioth supports CVS (alioth.debian.org), Subversion
|
| 339 |
(svn.debian.org), Arch (tla/baz, both on arch.debian.org), Bazaar
|
| 340 |
(bzr.debian.org), Darcs (darcs.debian.org), Mercurial (hg.debian.org) and Git
|
| 341 |
(git.debian.org). Checkout <ulink url="&url-alioth-pkg;" /> if you plan
|
| 342 |
to maintain packages in a VCS repository. See <xref linkend="alioth"/> for
|
| 343 |
information on the services provided by Alioth.
|
| 344 |
</para>
|
| 345 |
<para>
|
| 346 |
Historically, Debian first used <literal>cvs.debian.org</literal> to host
|
| 347 |
CVS repositories. But that service is deprecated in favor of Alioth.
|
| 348 |
Only a few projects are still using it.
|
| 349 |
</para>
|
| 350 |
</section>
|
| 351 |
|
| 352 |
<section id="dchroot">
|
| 353 |
<title>chroots to different distributions</title>
|
| 354 |
<para>
|
| 355 |
On some machines, there are chroots to different distributions available. You
|
| 356 |
can use them like this:
|
| 357 |
</para>
|
| 358 |
<screen>
|
| 359 |
vore$ dchroot unstable
|
| 360 |
Executing shell in chroot: /org/vore.debian.org/chroots/user/unstable
|
| 361 |
</screen>
|
| 362 |
<para>
|
| 363 |
In all chroots, the normal user home directories are available. You can find
|
| 364 |
out which chroots are available via
|
| 365 |
<literal>&url-devel-machines;</literal>.
|
| 366 |
</para>
|
| 367 |
</section>
|
| 368 |
|
| 369 |
</section>
|
| 370 |
|
| 371 |
<section id="devel-db">
|
| 372 |
<title>The Developers Database</title>
|
| 373 |
<para>
|
| 374 |
The Developers Database, at <ulink
|
| 375 |
url="&url-debian-db;"></ulink>, is an LDAP directory for
|
| 376 |
managing Debian developer attributes. You can use this resource to search the
|
| 377 |
list of Debian developers. Part of this information is also available through
|
| 378 |
the finger service on Debian servers, try <command>finger
|
| 379 |
yourlogin@db.debian.org</command> to see what it reports.
|
| 380 |
</para>
|
| 381 |
<para>
|
| 382 |
Developers can <ulink url="&url-debian-db-login;">log into the
|
| 383 |
database</ulink> to change various information about themselves, such as:
|
| 384 |
</para>
|
| 385 |
<itemizedlist>
|
| 386 |
<listitem>
|
| 387 |
<para>
|
| 388 |
forwarding address for your debian.org email
|
| 389 |
</para>
|
| 390 |
</listitem>
|
| 391 |
<listitem>
|
| 392 |
<para>
|
| 393 |
subscription to debian-private
|
| 394 |
</para>
|
| 395 |
</listitem>
|
| 396 |
<listitem>
|
| 397 |
<para>
|
| 398 |
whether you are on vacation
|
| 399 |
</para>
|
| 400 |
</listitem>
|
| 401 |
<listitem>
|
| 402 |
<para>
|
| 403 |
personal information such as your address, country, the latitude and longitude
|
| 404 |
of the place where you live for use in <ulink
|
| 405 |
url="&url-worldmap;">the world map of Debian
|
| 406 |
developers</ulink>, phone and fax numbers, IRC nickname and web page
|
| 407 |
</para>
|
| 408 |
</listitem>
|
| 409 |
<listitem>
|
| 410 |
<para>
|
| 411 |
password and preferred shell on Debian Project machines
|
| 412 |
</para>
|
| 413 |
</listitem>
|
| 414 |
</itemizedlist>
|
| 415 |
<para>
|
| 416 |
Most of the information is not accessible to the public, naturally. For more
|
| 417 |
information please read the online documentation that you can find at <ulink
|
| 418 |
url="&url-debian-db-doc;"></ulink>.
|
| 419 |
</para>
|
| 420 |
<para>
|
| 421 |
Developers can also submit their SSH keys to be used for authorization on the
|
| 422 |
official Debian machines, and even add new *.debian.net DNS entries. Those
|
| 423 |
features are documented at <ulink
|
| 424 |
url="&url-debian-db-mail-gw;"></ulink>.
|
| 425 |
</para>
|
| 426 |
</section>
|
| 427 |
|
| 428 |
<section id="archive">
|
| 429 |
<title>The Debian archive</title>
|
| 430 |
<para>
|
| 431 |
The &debian-formal; distribution consists of a lot of packages
|
| 432 |
(<filename>.deb</filename>'s, currently around
|
| 433 |
&number-of-pkgs;) and a few additional files (such as
|
| 434 |
documentation and installation disk images).
|
| 435 |
</para>
|
| 436 |
<para>
|
| 437 |
Here is an example directory tree of a complete Debian archive:
|
| 438 |
</para>
|
| 439 |
&sample-dist-dirtree;
|
| 440 |
<para>
|
| 441 |
As you can see, the top-level directory contains two directories,
|
| 442 |
<filename>dists/</filename> and <filename>pool/</filename>. The latter is a
|
| 443 |
“pool” in which the packages actually are, and which is handled by the
|
| 444 |
archive maintenance database and the accompanying programs. The former
|
| 445 |
contains the distributions, <literal>stable</literal>,
|
| 446 |
<literal>testing</literal> and <literal>unstable</literal>. The
|
| 447 |
<filename>Packages</filename> and <filename>Sources</filename> files in the
|
| 448 |
distribution subdirectories can reference files in the
|
| 449 |
<filename>pool/</filename> directory. The directory tree below each of the
|
| 450 |
distributions is arranged in an identical manner. What we describe below for
|
| 451 |
<literal>stable</literal> is equally applicable to the
|
| 452 |
<literal>unstable</literal> and <literal>testing</literal> distributions.
|
| 453 |
</para>
|
| 454 |
<para>
|
| 455 |
<filename>dists/stable</filename> contains three directories, namely
|
| 456 |
<filename>main</filename>, <filename>contrib</filename>, and
|
| 457 |
<filename>non-free</filename>.
|
| 458 |
</para>
|
| 459 |
<para>
|
| 460 |
In each of the areas, there is a directory for the source packages
|
| 461 |
(<filename>source</filename>) and a directory for each supported architecture
|
| 462 |
(<filename>binary-i386</filename>, <filename>binary-m68k</filename>, etc.).
|
| 463 |
</para>
|
| 464 |
<para>
|
| 465 |
The <filename>main</filename> area contains additional directories which hold
|
| 466 |
the disk images and some essential pieces of documentation required for
|
| 467 |
installing the Debian distribution on a specific architecture
|
| 468 |
(<filename>disks-i386</filename>, <filename>disks-m68k</filename>, etc.).
|
| 469 |
</para>
|
| 470 |
<section id="archive-sections">
|
| 471 |
<title>Sections</title>
|
| 472 |
<para>
|
| 473 |
The <literal>main</literal> section of the Debian archive is what makes up
|
| 474 |
the <emphasis role="strong">official &debian-formal; distribution</emphasis>.
|
| 475 |
The <literal>main</literal> section is official because it fully complies
|
| 476 |
with all our guidelines. The other two sections do not, to different degrees;
|
| 477 |
as such, they are <emphasis role="strong">not</emphasis> officially part of
|
| 478 |
&debian-formal;.
|
| 479 |
</para>
|
| 480 |
<para>
|
| 481 |
Every package in the main section must fully comply with the <ulink
|
| 482 |
url="&url-dfsg;">Debian Free Software
|
| 483 |
Guidelines</ulink> (DFSG) and with all other policy requirements as described
|
| 484 |
in the <ulink url="&url-debian-policy;">Debian Policy
|
| 485 |
Manual</ulink>. The DFSG is our definition of “free software.” Check out
|
| 486 |
the Debian Policy Manual for details.
|
| 487 |
</para>
|
| 488 |
<para>
|
| 489 |
Packages in the <literal>contrib</literal> section have to comply with the
|
| 490 |
DFSG, but may fail other requirements. For instance, they may depend on
|
| 491 |
non-free packages.
|
| 492 |
</para>
|
| 493 |
<para>
|
| 494 |
Packages which do not conform to the DFSG are placed in the
|
| 495 |
<literal>non-free</literal> section. These packages are not considered as
|
| 496 |
part of the Debian distribution, though we support their use, and we provide
|
| 497 |
infrastructure (such as our bug-tracking system and mailing lists) for non-free
|
| 498 |
software packages.
|
| 499 |
</para>
|
| 500 |
<para>
|
| 501 |
The <ulink url="&url-debian-policy;">Debian Policy
|
| 502 |
Manual</ulink> contains a more exact definition of the three sections. The
|
| 503 |
above discussion is just an introduction.
|
| 504 |
</para>
|
| 505 |
<para>
|
| 506 |
The separation of the three sections at the top-level of the archive is
|
| 507 |
important for all people who want to distribute Debian, either via FTP servers
|
| 508 |
on the Internet or on CD-ROMs: by distributing only the
|
| 509 |
<literal>main</literal> and <literal>contrib</literal> sections, one can
|
| 510 |
avoid any legal risks. Some packages in the <literal>non-free</literal>
|
| 511 |
section do not allow commercial distribution, for example.
|
| 512 |
</para>
|
| 513 |
<para>
|
| 514 |
On the other hand, a CD-ROM vendor could easily check the individual package
|
| 515 |
licenses of the packages in <literal>non-free</literal> and include as many
|
| 516 |
on the CD-ROMs as it's allowed to. (Since this varies greatly from vendor to
|
| 517 |
vendor, this job can't be done by the Debian developers.)
|
| 518 |
</para>
|
| 519 |
<para>
|
| 520 |
Note that the term section is also used to refer to categories which simplify
|
| 521 |
the organization and browsing of available packages, e.g.
|
| 522 |
<literal>admin</literal>, <literal>net</literal>,
|
| 523 |
<literal>utils</literal> etc. Once upon a time, these sections (subsections,
|
| 524 |
rather) existed in the form of subdirectories within the Debian archive.
|
| 525 |
Nowadays, these exist only in the Section header fields of packages.
|
| 526 |
</para>
|
| 527 |
</section>
|
| 528 |
|
| 529 |
<section id="s4.6.2">
|
| 530 |
<title>Architectures</title>
|
| 531 |
<para>
|
| 532 |
In the first days, the Linux kernel was only available for Intel i386 (or
|
| 533 |
greater) platforms, and so was Debian. But as Linux became more and more
|
| 534 |
popular, the kernel was ported to other architectures, too.
|
| 535 |
</para>
|
| 536 |
<para>
|
| 537 |
The Linux 2.0 kernel supports Intel x86, DEC Alpha, SPARC, Motorola 680x0 (like
|
| 538 |
Atari, Amiga and Macintoshes), MIPS, and PowerPC. The Linux 2.2 kernel
|
| 539 |
supports even more architectures, including ARM and UltraSPARC. Since Linux
|
| 540 |
supports these platforms, Debian decided that it should, too. Therefore,
|
| 541 |
Debian has ports underway; in fact, we also have ports underway to non-Linux
|
| 542 |
kernels. Aside from <literal>i386</literal> (our name for Intel x86), there
|
| 543 |
is <literal>m68k</literal>, <literal>alpha</literal>,
|
| 544 |
<literal>powerpc</literal>, <literal>sparc</literal>,
|
| 545 |
<literal>hurd-i386</literal>, <literal>arm</literal>,
|
| 546 |
<literal>ia64</literal>, <literal>hppa</literal>,
|
| 547 |
<literal>s390</literal>, <literal>mips</literal>,
|
| 548 |
<literal>mipsel</literal> and <literal>sh</literal> as of this writing.
|
| 549 |
</para>
|
| 550 |
<para>
|
| 551 |
&debian-formal; 1.3 is only available as <literal>i386</literal>. Debian
|
| 552 |
2.0 shipped for <literal>i386</literal> and <literal>m68k</literal>
|
| 553 |
architectures. Debian 2.1 ships for the <literal>i386</literal>,
|
| 554 |
<literal>m68k</literal>, <literal>alpha</literal>, and
|
| 555 |
<literal>sparc</literal> architectures. Debian 2.2 added support for the
|
| 556 |
<literal>powerpc</literal> and <literal>arm</literal> architectures.
|
| 557 |
Debian 3.0 added support of five new architectures: <literal>ia64</literal>,
|
| 558 |
<literal>hppa</literal>, <literal>s390</literal>, <literal>mips</literal>
|
| 559 |
and <literal>mipsel</literal>.
|
| 560 |
</para>
|
| 561 |
<para>
|
| 562 |
Information for developers and users about the specific ports are available at
|
| 563 |
the <ulink url="&url-debian-ports;">Debian Ports web pages</ulink>.
|
| 564 |
</para>
|
| 565 |
</section>
|
| 566 |
|
| 567 |
<section id="s4.6.3">
|
| 568 |
<title>Packages</title>
|
| 569 |
<para>
|
| 570 |
There are two types of Debian packages, namely <literal>source</literal> and
|
| 571 |
<literal>binary</literal> packages.
|
| 572 |
</para>
|
| 573 |
<para>
|
| 574 |
Source packages consist of either two or three files: a
|
| 575 |
<filename>.dsc</filename> file, and either a <filename>.tar.gz</filename> file
|
| 576 |
or both an <filename>.orig.tar.gz</filename> and a
|
| 577 |
<filename>.diff.gz</filename> file.
|
| 578 |
</para>
|
| 579 |
<para>
|
| 580 |
If a package is developed specially for Debian and is not distributed outside
|
| 581 |
of Debian, there is just one <filename>.tar.gz</filename> file which contains
|
| 582 |
the sources of the program. If a package is distributed elsewhere too, the
|
| 583 |
<filename>.orig.tar.gz</filename> file stores the so-called <literal>upstream
|
| 584 |
source code</literal>, that is the source code that's distributed by the
|
| 585 |
<literal>upstream maintainer</literal> (often the author of the software).
|
| 586 |
In this case, the <filename>.diff.gz</filename> contains the changes made by
|
| 587 |
the Debian maintainer.
|
| 588 |
</para>
|
| 589 |
<para>
|
| 590 |
The <filename>.dsc</filename> file lists all the files in the source package
|
| 591 |
together with checksums (<command>md5sums</command>) and some additional info
|
| 592 |
about the package (maintainer, version, etc.).
|
| 593 |
</para>
|
| 594 |
</section>
|
| 595 |
|
| 596 |
<section id="s4.6.4">
|
| 597 |
<title>Distributions</title>
|
| 598 |
<para>
|
| 599 |
The directory system described in the previous chapter is itself contained
|
| 600 |
within <literal>distribution directories</literal>. Each distribution is
|
| 601 |
actually contained in the <filename>pool</filename> directory in the top-level
|
| 602 |
of the Debian archive itself.
|
| 603 |
</para>
|
| 604 |
<para>
|
| 605 |
To summarize, the Debian archive has a root directory within an FTP server.
|
| 606 |
For instance, at the mirror site, <literal>ftp.us.debian.org</literal>, the
|
| 607 |
Debian archive itself is contained in <ulink
|
| 608 |
url="ftp://ftp.us.debian.org/debian">/debian</ulink>, which is a common
|
| 609 |
location (another is <filename>/pub/debian</filename>).
|
| 610 |
</para>
|
| 611 |
<para>
|
| 612 |
A distribution comprises Debian source and binary packages, and the respective
|
| 613 |
<filename>Sources</filename> and <filename>Packages</filename> index files,
|
| 614 |
containing the header information from all those packages. The former are kept
|
| 615 |
in the <filename>pool/</filename> directory, while the latter are kept in the
|
| 616 |
<filename>dists/</filename> directory of the archive (for backwards
|
| 617 |
compatibility).
|
| 618 |
</para>
|
| 619 |
<section id="sec-dists">
|
| 620 |
<title>Stable, testing, and unstable</title>
|
| 621 |
<para>
|
| 622 |
There are always distributions called <literal>stable</literal> (residing in
|
| 623 |
<filename>dists/stable</filename>), <literal>testing</literal> (residing in
|
| 624 |
<filename>dists/testing</filename>), and <literal>unstable</literal>
|
| 625 |
(residing in <filename>dists/unstable</filename>). This reflects the
|
| 626 |
development process of the Debian project.
|
| 627 |
</para>
|
| 628 |
<para>
|
| 629 |
Active development is done in the <literal>unstable</literal> distribution
|
| 630 |
(that's why this distribution is sometimes called the <literal>development
|
| 631 |
distribution</literal>). Every Debian developer can update his or her
|
| 632 |
packages in this distribution at any time. Thus, the contents of this
|
| 633 |
distribution change from day to day. Since no special effort is made to make
|
| 634 |
sure everything in this distribution is working properly, it is sometimes
|
| 635 |
literally unstable.
|
| 636 |
</para>
|
| 637 |
<para>
|
| 638 |
The <link linkend="testing">testing</link> distribution is generated
|
| 639 |
automatically by taking packages from <literal>unstable</literal> if they
|
| 640 |
satisfy certain criteria. Those criteria should ensure a good quality for
|
| 641 |
packages within <literal>testing</literal>. The update to <literal>testing
|
| 642 |
</literal> is launched twice each day, right after the new packages
|
| 643 |
have been installed. See <xref linkend="testing"/> .
|
| 644 |
</para>
|
| 645 |
<para>
|
| 646 |
After a period of development, once the release manager deems fit, the
|
| 647 |
<literal>testing</literal> distribution is frozen, meaning that the policies
|
| 648 |
which control how packages move from <literal>unstable</literal> to
|
| 649 |
<literal>testing</literal> are tightened. Packages which are too buggy are
|
| 650 |
removed. No changes are allowed into <literal>testing</literal> except for
|
| 651 |
bug fixes. After some time has elapsed, depending on progress, the
|
| 652 |
<literal>testing</literal> distribution is frozen even further. Details of
|
| 653 |
the handling of the testing distribution are published by the Release Team on
|
| 654 |
debian-devel-announce. After the open issues are solved to the satisfaction of
|
| 655 |
the Release Team, the distribution is released. Releasing means that
|
| 656 |
<literal>testing</literal> is renamed to <literal>stable</literal>, and a
|
| 657 |
new copy is created for the new <literal>testing</literal>, and the previous
|
| 658 |
<literal>stable</literal> is renamed to <literal>oldstable</literal> and
|
| 659 |
stays there until it is finally archived. On archiving, the contents are moved
|
| 660 |
to <literal>&archive-host;</literal>).
|
| 661 |
</para>
|
| 662 |
<para>
|
| 663 |
This development cycle is based on the assumption that the
|
| 664 |
<literal>unstable</literal> distribution becomes <literal>stable</literal>
|
| 665 |
after passing a period of being in <literal>testing</literal>. Even once a
|
| 666 |
distribution is considered stable, a few bugs inevitably remain — that's why
|
| 667 |
the stable distribution is updated every now and then. However, these updates
|
| 668 |
are tested very carefully and have to be introduced into the archive
|
| 669 |
individually to reduce the risk of introducing new bugs. You can find proposed
|
| 670 |
additions to <literal>stable</literal> in the
|
| 671 |
<filename>proposed-updates</filename> directory. Those packages in
|
| 672 |
<filename>proposed-updates</filename> that pass muster are periodically moved
|
| 673 |
as a batch into the stable distribution and the revision level of the stable
|
| 674 |
distribution is incremented (e.g., ‘3.0’ becomes ‘3.0r1’, ‘2.2r4’
|
| 675 |
becomes ‘2.2r5’, and so forth). Please refer to
|
| 676 |
<link linkend="upload-stable">uploads to the <literal>stable</literal>
|
| 677 |
distribution</link> for details.
|
| 678 |
</para>
|
| 679 |
<para>
|
| 680 |
Note that development under <literal>unstable</literal> continues during the
|
| 681 |
freeze period, since the <literal>unstable</literal> distribution remains in
|
| 682 |
place in parallel with <literal>testing</literal>.
|
| 683 |
</para>
|
| 684 |
</section>
|
| 685 |
|
| 686 |
<section id="s4.6.4.2">
|
| 687 |
<title>More information about the testing distribution</title>
|
| 688 |
<para>
|
| 689 |
Packages are usually installed into the <literal>testing</literal> distribution
|
| 690 |
after they have undergone some degree of testing in <literal>unstable</literal>.
|
| 691 |
</para>
|
| 692 |
<para>
|
| 693 |
For more details, please see the <link linkend="testing">information about
|
| 694 |
the testing distribution</link>.
|
| 695 |
</para>
|
| 696 |
</section>
|
| 697 |
|
| 698 |
<section id="experimental">
|
| 699 |
<title>Experimental</title>
|
| 700 |
<para>
|
| 701 |
The <literal>experimental</literal> distribution is a special distribution.
|
| 702 |
It is not a full distribution in the same sense as <literal>stable</literal>,
|
| 703 |
<literal>testing</literal> and <literal>unstable</literal> are.
|
| 704 |
Instead, it is meant to be a temporary staging area for highly experimental
|
| 705 |
software where there's a good chance that the software could break your system,
|
| 706 |
or software that's just too unstable even for the <literal>unstable</literal>
|
| 707 |
distribution (but there is a reason to package it nevertheless). Users who
|
| 708 |
download and install packages from <literal>experimental</literal> are
|
| 709 |
expected to have been duly warned. In short, all bets are off for the
|
| 710 |
<literal>experimental</literal> distribution.
|
| 711 |
</para>
|
| 712 |
<para>
|
| 713 |
These are the <citerefentry> <refentrytitle>sources.list</refentrytitle>
|
| 714 |
<manvolnum>5</manvolnum> </citerefentry> lines for
|
| 715 |
<literal>experimental</literal>:
|
| 716 |
</para>
|
| 717 |
<programlisting>
|
| 718 |
deb http://ftp.<replaceable>xy</replaceable>.debian.org/debian/ experimental main
|
| 719 |
deb-src http://ftp.<replaceable>xy</replaceable>.debian.org/debian/ experimental main
|
| 720 |
</programlisting>
|
| 721 |
<para>
|
| 722 |
If there is a chance that the software could do grave damage to a system, it is
|
| 723 |
likely to be better to put it into <literal>experimental</literal>. For
|
| 724 |
instance, an experimental compressed file system should probably go into
|
| 725 |
<literal>experimental</literal>.
|
| 726 |
</para>
|
| 727 |
<para>
|
| 728 |
Whenever there is a new upstream version of a package that introduces new
|
| 729 |
features but breaks a lot of old ones, it should either not be uploaded, or be
|
| 730 |
uploaded to <literal>experimental</literal>. A new, beta, version of some
|
| 731 |
software which uses a completely different configuration can go into
|
| 732 |
<literal>experimental</literal>, at the maintainer's discretion. If you are
|
| 733 |
working on an incompatible or complex upgrade situation, you can also use
|
| 734 |
<literal>experimental</literal> as a staging area, so that testers can get
|
| 735 |
early access.
|
| 736 |
</para>
|
| 737 |
<para>
|
| 738 |
Some experimental software can still go into <literal>unstable</literal>,
|
| 739 |
with a few warnings in the description, but that isn't recommended because
|
| 740 |
packages from <literal>unstable</literal> are expected to propagate to
|
| 741 |
<literal>testing</literal> and thus to <literal>stable</literal>. You
|
| 742 |
should not be afraid to use <literal>experimental</literal> since it does not
|
| 743 |
cause any pain to the ftpmasters, the experimental packages are automatically
|
| 744 |
removed once you upload the package in <literal>unstable</literal> with a
|
| 745 |
higher version number.
|
| 746 |
</para>
|
| 747 |
<para>
|
| 748 |
New software which isn't likely to damage your system can go directly into
|
| 749 |
<literal>unstable</literal>.
|
| 750 |
</para>
|
| 751 |
<para>
|
| 752 |
An alternative to <literal>experimental</literal> is to use your personal web
|
| 753 |
space on <literal>people.debian.org</literal>.
|
| 754 |
</para>
|
| 755 |
<para>
|
| 756 |
When uploading to <literal>unstable</literal> a package which had bugs fixed
|
| 757 |
in <literal>experimental</literal>, please consider using the option
|
| 758 |
<literal>-v</literal> to <command>dpkg-buildpackage</command> to finally get
|
| 759 |
them closed.
|
| 760 |
</para>
|
| 761 |
</section>
|
| 762 |
|
| 763 |
</section>
|
| 764 |
|
| 765 |
<section id="codenames">
|
| 766 |
<title>Release code names</title>
|
| 767 |
<para>
|
| 768 |
Every released Debian distribution has a <literal>code name</literal>: Debian
|
| 769 |
1.1 is called <literal>buzz</literal>; Debian 1.2, <literal>rex</literal>;
|
| 770 |
Debian 1.3, <literal>bo</literal>; Debian 2.0, <literal>hamm</literal>;
|
| 771 |
Debian 2.1, <literal>slink</literal>; Debian 2.2, <literal>potato</literal>;
|
| 772 |
Debian 3.0, <literal>woody</literal>; Debian 3.1, <literal>sarge</literal>;
|
| 773 |
Debian 4.0, <literal>etch</literal>; Debian 5.0, <literal>lenny</literal>
|
| 774 |
and the next release will be called <literal>squeeze</literal>.
|
| 775 |
There is also a ``pseudo-distribution'', called
|
| 776 |
<literal>sid</literal>, which is the current <literal>unstable</literal>
|
| 777 |
distribution; since packages are moved from <literal>unstable</literal> to
|
| 778 |
<literal>testing</literal> as they approach stability, <literal>sid</literal>
|
| 779 |
itself is never released. As well as the usual contents of a Debian
|
| 780 |
distribution, <literal>sid</literal> contains packages for architectures which
|
| 781 |
are not yet officially supported or released by Debian. These architectures
|
| 782 |
are planned to be integrated into the mainstream distribution at some future
|
| 783 |
date.
|
| 784 |
</para>
|
| 785 |
<para>
|
| 786 |
Since Debian has an open development model (i.e., everyone can participate and
|
| 787 |
follow the development) even the <literal>unstable</literal> and <literal>
|
| 788 |
testing</literal> distributions are distributed to the Internet through the
|
| 789 |
Debian FTP and HTTP server network. Thus, if we had called the directory which
|
| 790 |
contains the release candidate version <literal>testing</literal>, then we
|
| 791 |
would have to rename it to <literal>stable</literal> when the version
|
| 792 |
is released, which would cause all FTP mirrors to re-retrieve the whole
|
| 793 |
distribution (which is quite large).
|
| 794 |
</para>
|
| 795 |
<para>
|
| 796 |
On the other hand, if we called the distribution directories
|
| 797 |
<literal>Debian-x.y</literal> from the beginning, people would think that
|
| 798 |
Debian release <literal>x.y</literal> is available. (This happened in the
|
| 799 |
past, where a CD-ROM vendor built a Debian 1.0 CD-ROM based on a pre-1.0
|
| 800 |
development version. That's the reason why the first official Debian release
|
| 801 |
was 1.1, and not 1.0.)
|
| 802 |
</para>
|
| 803 |
<para>
|
| 804 |
Thus, the names of the distribution directories in the archive are determined
|
| 805 |
by their code names and not their release status (e.g., `slink'). These names
|
| 806 |
stay the same during the development period and after the release; symbolic
|
| 807 |
links, which can be changed easily, indicate the currently released stable
|
| 808 |
distribution. That's why the real distribution directories use the
|
| 809 |
<literal>code names</literal>, while symbolic links for
|
| 810 |
<literal>stable</literal>, <literal>testing</literal>, and
|
| 811 |
<literal>unstable</literal> point to the appropriate release directories.
|
| 812 |
</para>
|
| 813 |
</section>
|
| 814 |
|
| 815 |
</section>
|
| 816 |
|
| 817 |
<section id="mirrors">
|
| 818 |
<title>Debian mirrors</title>
|
| 819 |
<para>
|
| 820 |
The various download archives and the web site have several mirrors available
|
| 821 |
in order to relieve our canonical servers from heavy load. In fact, some of
|
| 822 |
the canonical servers aren't public — a first tier of mirrors balances the
|
| 823 |
load instead. That way, users always access the mirrors and get used to using
|
| 824 |
them, which allows Debian to better spread its bandwidth requirements over
|
| 825 |
several servers and networks, and basically makes users avoid hammering on one
|
| 826 |
primary location. Note that the first tier of mirrors is as up-to-date as it
|
| 827 |
can be since they update when triggered from the internal sites (we call this
|
| 828 |
push mirroring).
|
| 829 |
</para>
|
| 830 |
<para>
|
| 831 |
All the information on Debian mirrors, including a list of the available public
|
| 832 |
FTP/HTTP servers, can be found at <ulink
|
| 833 |
url="&url-debian-mirrors;"></ulink>. This useful page also
|
| 834 |
includes information and tools which can be helpful if you are interested in
|
| 835 |
setting up your own mirror, either for internal or public access.
|
| 836 |
</para>
|
| 837 |
<para>
|
| 838 |
Note that mirrors are generally run by third-parties who are interested in
|
| 839 |
helping Debian. As such, developers generally do not have accounts on these
|
| 840 |
machines.
|
| 841 |
</para>
|
| 842 |
</section>
|
| 843 |
|
| 844 |
<section id="incoming-system">
|
| 845 |
<title>The Incoming system</title>
|
| 846 |
<para>
|
| 847 |
The Incoming system is responsible for collecting updated packages and
|
| 848 |
installing them in the Debian archive. It consists of a set of directories and
|
| 849 |
scripts that are installed on <literal>&ftp-master-host;</literal>.
|
| 850 |
</para>
|
| 851 |
<para>
|
| 852 |
Packages are uploaded by all the maintainers into a directory called
|
| 853 |
<filename>UploadQueue</filename>. This directory is scanned every few minutes
|
| 854 |
by a daemon called <command>queued</command>,
|
| 855 |
<filename>*.command</filename>-files are executed, and remaining and correctly
|
| 856 |
signed <filename>*.changes</filename>-files are moved together with their
|
| 857 |
corresponding files to the <filename>unchecked</filename> directory. This
|
| 858 |
directory is not visible for most Developers, as ftp-master is restricted; it
|
| 859 |
is scanned every 15 minutes by the <command>katie</command> script, which
|
| 860 |
verifies the integrity of the uploaded packages and their cryptographic
|
| 861 |
signatures. If the package is considered ready to be installed, it is moved
|
| 862 |
into the <filename>accepted</filename> directory. If this is the first upload
|
| 863 |
of the package (or it has new binary packages), it is moved to the
|
| 864 |
<filename>new</filename> directory, where it waits for approval by the
|
| 865 |
ftpmasters. If the package contains files to be installed by hand it is moved
|
| 866 |
to the <filename>byhand</filename> directory, where it waits for manual
|
| 867 |
installation by the ftpmasters. Otherwise, if any error has been detected, the
|
| 868 |
package is refused and is moved to the <filename>reject</filename> directory.
|
| 869 |
</para>
|
| 870 |
<para>
|
| 871 |
Once the package is accepted, the system sends a confirmation mail to the
|
| 872 |
maintainer and closes all the bugs marked as fixed by the upload, and the
|
| 873 |
auto-builders may start recompiling it. The package is now publicly accessible
|
| 874 |
at <ulink url="&url-incoming;"></ulink> until it is really
|
| 875 |
installed in the Debian archive. This happens only once a day (and is also
|
| 876 |
called the `dinstall run' for historical reasons); the package is then removed
|
| 877 |
from incoming and installed in the pool along with all the other packages.
|
| 878 |
Once all the other updates (generating new <filename>Packages</filename> and
|
| 879 |
<filename>Sources</filename> index files for example) have been made, a special
|
| 880 |
script is called to ask all the primary mirrors to update themselves.
|
| 881 |
</para>
|
| 882 |
<para>
|
| 883 |
The archive maintenance software will also send the OpenPGP/GnuPG signed
|
| 884 |
<filename>.changes</filename> file that you uploaded to the appropriate mailing
|
| 885 |
lists. If a package is released with the <literal>Distribution:</literal> set
|
| 886 |
to <literal>stable</literal>, the announcement is sent to
|
| 887 |
&email-debian-changes;. If a package is released with
|
| 888 |
<literal>Distribution:</literal> set to <literal>unstable</literal> or
|
| 889 |
<literal>experimental</literal>, the announcement will be posted to
|
| 890 |
&email-debian-devel-changes; instead.
|
| 891 |
</para>
|
| 892 |
<para>
|
| 893 |
Though ftp-master is restricted, a copy of the installation is available to all
|
| 894 |
developers on <literal>&ftp-master-mirror;</literal>.
|
| 895 |
</para>
|
| 896 |
<!-- FIXME: delete it or keep it for historical purposes?
|
| 897 |
<para>
|
| 898 |
All Debian developers have write access to the <filename>unchecked</filename>
|
| 899 |
directory in order to upload their packages; they also have that access
|
| 900 |
to the <filename>reject</filename> directory in order to remove their bad uploads
|
| 901 |
or to move some files back to the <filename>unchecked</filename> directory. But
|
| 902 |
all the other directories are only writable by the ftpmasters, which is
|
| 903 |
why you cannot remove an upload once it has been accepted.
|
| 904 |
</para>
|
| 905 |
|
| 906 |
<section id="delayed-incoming-broken">
|
| 907 |
<title>Delayed incoming</title>
|
| 908 |
<para>
|
| 909 |
<emphasis>Note:</emphasis> This description here is currently not working, because
|
| 910 |
ftp-master is restricted. Please see <xref linkend="delayed-incoming"/> for
|
| 911 |
the currently working way.
|
| 912 |
</para>
|
| 913 |
<para>
|
| 914 |
The <filename>unchecked</filename> directory has a special <filename>DELAYED</filename>
|
| 915 |
subdirectory. It is itself subdivided in nine directories
|
| 916 |
called <filename>1-day</filename> to <filename>9-day</filename>. Packages which are uploaded to
|
| 917 |
one of those directories will be moved to the real unchecked
|
| 918 |
directory after the corresponding number of days.
|
| 919 |
This is done by a script which is run each day and which moves the
|
| 920 |
packages between the directories. Those which are in "1-day" are
|
| 921 |
installed in <filename>unchecked</filename> while the others are moved to the
|
| 922 |
adjacent directory (for example, a package in <filename>5-day</filename> will
|
| 923 |
be moved to <filename>4-day</filename>). This feature is particularly useful
|
| 924 |
for people who are doing non-maintainer uploads. Instead of
|
| 925 |
waiting before uploading a NMU, it is uploaded as soon as it is
|
| 926 |
ready, but to one of those <filename>DELAYED/<varname>x</varname>-day</filename> directories.
|
| 927 |
That leaves the corresponding number of days for the maintainer
|
| 928 |
to react and upload another fix themselves if they are not
|
| 929 |
completely satisfied with the NMU. Alternatively they can remove
|
| 930 |
the NMU.
|
| 931 |
</para>
|
| 932 |
<para>
|
| 933 |
The use of that delayed feature can be simplified with a bit
|
| 934 |
of integration with your upload tool. For instance, if you use
|
| 935 |
<command>dupload</command> (see <xref linkend="dupload"/>), you can add this
|
| 936 |
snippet to your configuration file:
|
| 937 |
<programlisting>
|
| 938 |
$delay = ($ENV{DELAY} || 7);
|
| 939 |
$cfg{'delayed'} = {
|
| 940 |
fqdn => "&ftp-upload-host;",
|
| 941 |
login => "yourdebianlogin",
|
| 942 |
incoming => "/org/&ftp-debian-org;/incoming/DELAYED/$delay-day/",
|
| 943 |
dinstall_runs => 1,
|
| 944 |
method => "scpb"
|
| 945 |
};
|
| 946 |
</programlisting>
|
| 947 |
Once you've made that change, <command>dupload</command> can be used to
|
| 948 |
easily upload a package in one of the delayed directories:
|
| 949 |
<literal>DELAY=5 dupload -X-to delayed <changes-file></literal>
|
| 950 |
</para>
|
| 951 |
</section>
|
| 952 |
-->
|
| 953 |
</section>
|
| 954 |
|
| 955 |
<section id="pkg-info">
|
| 956 |
<title>Package information</title>
|
| 957 |
<section id="pkg-info-web">
|
| 958 |
<title>On the web</title>
|
| 959 |
<para>
|
| 960 |
Each package has several dedicated web pages.
|
| 961 |
<literal>http://&packages-host;/<replaceable>package-name</replaceable></literal>
|
| 962 |
displays each version of the package available in the various distributions.
|
| 963 |
Each version links to a page which provides information, including the package
|
| 964 |
description, the dependencies, and package download links.
|
| 965 |
</para>
|
| 966 |
<para>
|
| 967 |
The bug tracking system tracks bugs for each package. You can view the bugs of
|
| 968 |
a given package at the URL
|
| 969 |
<literal>http://&bugs-host;/<replaceable>package-name</replaceable></literal>.
|
| 970 |
</para>
|
| 971 |
</section>
|
| 972 |
|
| 973 |
<section id="dak-ls">
|
| 974 |
<title>The <command>dak ls</command> utility</title>
|
| 975 |
<para>
|
| 976 |
<command>dak ls</command> is part of the dak suite of tools, listing
|
| 977 |
available package versions for all known distributions and architectures.
|
| 978 |
The <command>dak</command> tool is available on <literal>&ftp-master-host;
|
| 979 |
</literal>, and on the mirror on <literal>&ftp-master-mirror;</literal>.
|
| 980 |
It uses a single argument corresponding to a package name. An example will
|
| 981 |
explain it better:
|
| 982 |
</para>
|
| 983 |
<screen>
|
| 984 |
$ dak ls evince
|
| 985 |
evince | 0.1.5-2sarge1 | oldstable | source, alpha, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc
|
| 986 |
evince | 0.4.0-5 | etch-m68k | source, m68k
|
| 987 |
evince | 0.4.0-5 | stable | source, alpha, amd64, arm, hppa, i386, ia64, mips, mipsel, powerpc, s390, sparc
|
| 988 |
evince | 2.20.2-1 | testing | source
|
| 989 |
evince | 2.20.2-1+b1 | testing | alpha, amd64, arm, armel, hppa, i386, ia64, mips, mipsel, powerpc, s390, sparc
|
| 990 |
evince | 2.22.2-1 | unstable | source, alpha, amd64, arm, armel, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc
|
| 991 |
</screen>
|
| 992 |
<para>
|
| 993 |
In this example, you can see that the version in <literal>unstable</literal>
|
| 994 |
differs from the version in <literal>testing</literal> and that there has
|
| 995 |
been a binary-only NMU of the package for all architectures. Each version
|
| 996 |
of the package has been recompiled on all architectures.
|
| 997 |
</para>
|
| 998 |
</section>
|
| 999 |
|
| 1000 |
</section>
|
| 1001 |
|
| 1002 |
<section id="pkg-tracking-system">
|
| 1003 |
<title>The Package Tracking System</title>
|
| 1004 |
<para>
|
| 1005 |
The Package Tracking System (PTS) is an email-based tool to track the activity
|
| 1006 |
of a source package. This really means that you can get the same emails that
|
| 1007 |
the package maintainer gets, simply by subscribing to the package in the PTS.
|
| 1008 |
</para>
|
| 1009 |
<para>
|
| 1010 |
Each email sent through the PTS is classified under one of the keywords listed
|
| 1011 |
below. This will let you select the mails that you want to receive.
|
| 1012 |
</para>
|
| 1013 |
<para>
|
| 1014 |
By default you will get:
|
| 1015 |
</para>
|
| 1016 |
<variablelist>
|
| 1017 |
<varlistentry>
|
| 1018 |
<term><literal>bts</literal></term>
|
| 1019 |
<listitem>
|
| 1020 |
<para>
|
| 1021 |
All the bug reports and following discussions.
|
| 1022 |
</para>
|
| 1023 |
</listitem>
|
| 1024 |
</varlistentry>
|
| 1025 |
<varlistentry>
|
| 1026 |
<term><literal>bts-control</literal></term>
|
| 1027 |
<listitem>
|
| 1028 |
<para>
|
| 1029 |
The email notifications from <email>control@&bugs-host;</email> about bug
|
| 1030 |
report status changes.
|
| 1031 |
</para>
|
| 1032 |
</listitem>
|
| 1033 |
</varlistentry>
|
| 1034 |
<varlistentry>
|
| 1035 |
<term><literal>upload-source</literal></term>
|
| 1036 |
<listitem>
|
| 1037 |
<para>
|
| 1038 |
The email notification from <command>katie</command> when an uploaded source
|
| 1039 |
package is accepted.
|
| 1040 |
</para>
|
| 1041 |
</listitem>
|
| 1042 |
</varlistentry>
|
| 1043 |
<varlistentry>
|
| 1044 |
<term><literal>katie-other</literal></term>
|
| 1045 |
<listitem>
|
| 1046 |
<para>
|
| 1047 |
Other warning and error emails from <command>katie</command> (such as an
|
| 1048 |
override disparity for the section and/or the priority field).
|
| 1049 |
</para>
|
| 1050 |
</listitem>
|
| 1051 |
</varlistentry>
|
| 1052 |
<varlistentry>
|
| 1053 |
<term><literal>default</literal></term>
|
| 1054 |
<listitem>
|
| 1055 |
<para>
|
| 1056 |
Any non-automatic email sent to the PTS by people who wanted to contact the
|
| 1057 |
subscribers of the package. This can be done by sending mail to
|
| 1058 |
<literal><replaceable>sourcepackage</replaceable>@&pts-host;</literal>.
|
| 1059 |
In order to prevent spam, all messages sent to these addresses must contain the
|
| 1060 |
<literal>X-PTS-Approved</literal> header with a non-empty value.
|
| 1061 |
</para>
|
| 1062 |
</listitem>
|
| 1063 |
</varlistentry>
|
| 1064 |
<varlistentry>
|
| 1065 |
<term><literal>contact</literal></term>
|
| 1066 |
<listitem>
|
| 1067 |
<para>
|
| 1068 |
Mails sent to the maintainer through the *@packages.debian.org email
|
| 1069 |
aliases.
|
| 1070 |
</para>
|
| 1071 |
</listitem>
|
| 1072 |
</varlistentry>
|
| 1073 |
<varlistentry>
|
| 1074 |
<term><literal>summary</literal></term>
|
| 1075 |
<listitem>
|
| 1076 |
<para>
|
| 1077 |
Regular summary emails about the package's status, including progression
|
| 1078 |
into <literal>testing</literal>,
|
| 1079 |
<ulink url="&url-dehs;">DEHS</ulink> notifications of
|
| 1080 |
new upstream versions, and a notification if the package is removed or
|
| 1081 |
orphaned.
|
| 1082 |
</para>
|
| 1083 |
</listitem>
|
| 1084 |
</varlistentry>
|
| 1085 |
</variablelist>
|
| 1086 |
<para>
|
| 1087 |
You can also decide to receive additional information:
|
| 1088 |
</para>
|
| 1089 |
<variablelist>
|
| 1090 |
<varlistentry>
|
| 1091 |
<term><literal>upload-binary</literal></term>
|
| 1092 |
<listitem>
|
| 1093 |
<para>
|
| 1094 |
The email notification from <command>katie</command> when an uploaded binary
|
| 1095 |
package is accepted. In other words, whenever a build daemon or a porter
|
| 1096 |
uploads your package for another architecture, you can get an email to track
|
| 1097 |
how your package gets recompiled for all architectures.
|
| 1098 |
</para>
|
| 1099 |
</listitem>
|
| 1100 |
</varlistentry>
|
| 1101 |
<varlistentry>
|
| 1102 |
<term><literal>cvs</literal></term>
|
| 1103 |
<listitem>
|
| 1104 |
<para>
|
| 1105 |
VCS commit notifications, if the package has a VCS repository and the
|
| 1106 |
maintainer has set up forwarding of commit notifications to the PTS. The
|
| 1107 |
"cvs" name is historic, in most cases commit notifications will come
|
| 1108 |
from some other VCS like subversion or git.
|
| 1109 |
</para>
|
| 1110 |
</listitem>
|
| 1111 |
</varlistentry>
|
| 1112 |
<varlistentry>
|
| 1113 |
<term><literal>ddtp</literal></term>
|
| 1114 |
<listitem>
|
| 1115 |
<para>
|
| 1116 |
Translations of descriptions or debconf templates submitted to the Debian
|
| 1117 |
Description Translation Project.
|
| 1118 |
</para>
|
| 1119 |
</listitem>
|
| 1120 |
</varlistentry>
|
| 1121 |
<varlistentry>
|
| 1122 |
<term><literal>derivatives</literal></term>
|
| 1123 |
<listitem>
|
| 1124 |
<para>
|
| 1125 |
Information about changes made to the package in derivative distributions (for
|
| 1126 |
example Ubuntu).
|
| 1127 |
</para>
|
| 1128 |
</listitem>
|
| 1129 |
</varlistentry>
|
| 1130 |
</variablelist>
|
| 1131 |
<section id="pts-commands">
|
| 1132 |
<title>The PTS email interface</title>
|
| 1133 |
<para>
|
| 1134 |
You can control your subscription(s) to the PTS by sending various commands to
|
| 1135 |
<email>pts@qa.debian.org</email>.
|
| 1136 |
</para>
|
| 1137 |
<variablelist>
|
| 1138 |
<varlistentry>
|
| 1139 |
<term><literal>subscribe <sourcepackage> [<email>]</literal></term>
|
| 1140 |
<listitem>
|
| 1141 |
<para>
|
| 1142 |
Subscribes <replaceable>email</replaceable> to communications related to the
|
| 1143 |
source package <replaceable>sourcepackage</replaceable>. Sender address is
|
| 1144 |
used if the second argument is not present. If
|
| 1145 |
<replaceable>sourcepackage</replaceable> is not a valid source package, you'll
|
| 1146 |
get a warning. However if it's a valid binary package, the PTS will subscribe
|
| 1147 |
you to the corresponding source package.
|
| 1148 |
</para>
|
| 1149 |
</listitem>
|
| 1150 |
</varlistentry>
|
| 1151 |
<varlistentry>
|
| 1152 |
<term><literal>unsubscribe <sourcepackage> [<email>]</literal></term>
|
| 1153 |
<listitem>
|
| 1154 |
<para>
|
| 1155 |
Removes a previous subscription to the source package
|
| 1156 |
<replaceable>sourcepackage</replaceable> using the specified email address or
|
| 1157 |
the sender address if the second argument is left out.
|
| 1158 |
</para>
|
| 1159 |
</listitem>
|
| 1160 |
</varlistentry>
|
| 1161 |
<varlistentry>
|
| 1162 |
<term><literal>unsubscribeall [<email>]</literal></term>
|
| 1163 |
<listitem>
|
| 1164 |
<para>
|
| 1165 |
Removes all subscriptions of the specified email address or the sender address
|
| 1166 |
if the second argument is left out.
|
| 1167 |
</para>
|
| 1168 |
</listitem>
|
| 1169 |
</varlistentry>
|
| 1170 |
<varlistentry>
|
| 1171 |
<term><literal>which [<email>]</literal></term>
|
| 1172 |
<listitem>
|
| 1173 |
<para>
|
| 1174 |
Lists all subscriptions for the sender or the email address optionally
|
| 1175 |
specified.
|
| 1176 |
</para>
|
| 1177 |
</listitem>
|
| 1178 |
</varlistentry>
|
| 1179 |
<varlistentry>
|
| 1180 |
<term><literal>keyword [<email>]</literal></term>
|
| 1181 |
<listitem>
|
| 1182 |
<para>
|
| 1183 |
Tells you the keywords that you are accepting. For an explanation of keywords,
|
| 1184 |
<link linkend="pkg-tracking-system">see above</link>. Here's a quick
|
| 1185 |
summary:
|
| 1186 |
</para>
|
| 1187 |
<itemizedlist>
|
| 1188 |
<listitem>
|
| 1189 |
<para>
|
| 1190 |
<literal>bts</literal>: mails coming from the Debian Bug Tracking System
|
| 1191 |
</para>
|
| 1192 |
</listitem>
|
| 1193 |
<listitem>
|
| 1194 |
<para>
|
| 1195 |
<literal>bts-control</literal>: reply to mails sent to
|
| 1196 |
&email-bts-control;
|
| 1197 |
</para>
|
| 1198 |
</listitem>
|
| 1199 |
<listitem>
|
| 1200 |
<para>
|
| 1201 |
<literal>summary</literal>: automatic summary mails about the state of a
|
| 1202 |
package
|
| 1203 |
</para>
|
| 1204 |
</listitem>
|
| 1205 |
<listitem>
|
| 1206 |
<para>
|
| 1207 |
<literal>contact</literal>: mails sent to the maintainer through the
|
| 1208 |
*@packages.debian.org aliases
|
| 1209 |
</para>
|
| 1210 |
</listitem>
|
| 1211 |
<listitem>
|
| 1212 |
<para>
|
| 1213 |
<literal>cvs</literal>: notification of VCS commits
|
| 1214 |
</para>
|
| 1215 |
</listitem>
|
| 1216 |
<listitem>
|
| 1217 |
<para>
|
| 1218 |
<literal>ddtp</literal>: translations of descriptions and debconf templates
|
| 1219 |
</para>
|
| 1220 |
</listitem>
|
| 1221 |
<listitem>
|
| 1222 |
<para>
|
| 1223 |
<literal>derivatives</literal>: changes made on the package by derivative
|
| 1224 |
distributions
|
| 1225 |
</para>
|
| 1226 |
</listitem>
|
| 1227 |
<listitem>
|
| 1228 |
<para>
|
| 1229 |
<literal>upload-source</literal>: announce of a new source upload that has been
|
| 1230 |
accepted
|
| 1231 |
</para>
|
| 1232 |
</listitem>
|
| 1233 |
<listitem>
|
| 1234 |
<para>
|
| 1235 |
<literal>upload-binary</literal>: announce of a new binary-only upload
|
| 1236 |
(porting)
|
| 1237 |
</para>
|
| 1238 |
</listitem>
|
| 1239 |
<listitem>
|
| 1240 |
<para>
|
| 1241 |
<literal>katie-other</literal>: other mails from ftpmasters (override
|
| 1242 |
disparity, etc.)
|
| 1243 |
</para>
|
| 1244 |
</listitem>
|
| 1245 |
<listitem>
|
| 1246 |
<para>
|
| 1247 |
<literal>default</literal>: all the other mails (those which aren't automatic)
|
| 1248 |
</para>
|
| 1249 |
</listitem>
|
| 1250 |
</itemizedlist>
|
| 1251 |
</listitem>
|
| 1252 |
</varlistentry>
|
| 1253 |
<varlistentry>
|
| 1254 |
<term><literal>keyword <sourcepackage> [<email>]</literal></term>
|
| 1255 |
<listitem>
|
| 1256 |
<para>
|
| 1257 |
Same as the previous item but for the given source package, since you may
|
| 1258 |
select a different set of keywords for each source package.
|
| 1259 |
</para>
|
| 1260 |
</listitem>
|
| 1261 |
</varlistentry>
|
| 1262 |
<varlistentry>
|
| 1263 |
<term><literal>keyword [<email>] {+|-|=} <list of keywords></literal></term>
|
| 1264 |
<listitem>
|
| 1265 |
<para>
|
| 1266 |
Accept (+) or refuse (-) mails classified under the given keyword(s). Define
|
| 1267 |
the list (=) of accepted keywords. This changes the default set of keywords
|
| 1268 |
accepted by a user.
|
| 1269 |
</para>
|
| 1270 |
</listitem>
|
| 1271 |
</varlistentry>
|
| 1272 |
<varlistentry>
|
| 1273 |
<term><literal>keywordall [<email>] {+|-|=} <list of keywords></literal></term>
|
| 1274 |
<listitem>
|
| 1275 |
<para>
|
| 1276 |
Accept (+) or refuse (-) mails classified under the given keyword(s). Define
|
| 1277 |
the list (=) of accepted keywords. This changes the set of accepted keywords
|
| 1278 |
of all the currently active subscriptions of a user.
|
| 1279 |
</para>
|
| 1280 |
</listitem>
|
| 1281 |
</varlistentry>
|
| 1282 |
<varlistentry>
|
| 1283 |
<term><literal>keyword <sourcepackage> [<email>] {+|-|=} <list of keywords></literal></term>
|
| 1284 |
<listitem>
|
| 1285 |
<para>
|
| 1286 |
Same as previous item but overrides the keywords list for the indicated source
|
| 1287 |
package.
|
| 1288 |
</para>
|
| 1289 |
</listitem>
|
| 1290 |
</varlistentry>
|
| 1291 |
<varlistentry>
|
| 1292 |
<term><literal>quit | thanks | --</literal></term>
|
| 1293 |
<listitem>
|
| 1294 |
<para>
|
| 1295 |
Stops processing commands. All following lines are ignored by the bot.
|
| 1296 |
</para>
|
| 1297 |
</listitem>
|
| 1298 |
</varlistentry>
|
| 1299 |
</variablelist>
|
| 1300 |
<para>
|
| 1301 |
The <command>pts-subscribe</command> command-line utility (from the <systemitem
|
| 1302 |
role="package">devscripts</systemitem> package) can be handy to temporarily
|
| 1303 |
subscribe to some packages, for example after having made an non-maintainer
|
| 1304 |
upload.
|
| 1305 |
</para>
|
| 1306 |
</section>
|
| 1307 |
|
| 1308 |
<section id="pts-mail-filtering">
|
| 1309 |
<title>Filtering PTS mails</title>
|
| 1310 |
<para>
|
| 1311 |
Once you are subscribed to a package, you will get the mails sent to
|
| 1312 |
<literal><replaceable>sourcepackage</replaceable>@&pts-host;</literal>.
|
| 1313 |
Those mails have special headers appended to let you filter them in a special
|
| 1314 |
mailbox (e.g. with <command>procmail</command>). The added headers are
|
| 1315 |
<literal>X-Loop</literal>, <literal>X-PTS-Package</literal>,
|
| 1316 |
<literal>X-PTS-Keyword</literal> and <literal>X-Unsubscribe</literal>.
|
| 1317 |
</para>
|
| 1318 |
<para>
|
| 1319 |
Here is an example of added headers for a source upload notification on the
|
| 1320 |
<systemitem role="package">dpkg</systemitem> package:
|
| 1321 |
</para>
|
| 1322 |
<screen>
|
| 1323 |
X-Loop: dpkg@&pts-host;
|
| 1324 |
X-PTS-Package: dpkg
|
| 1325 |
X-PTS-Keyword: upload-source
|
| 1326 |
List-Unsubscribe: <mailto:pts@qa.debian.org?body=unsubscribe+dpkg>
|
| 1327 |
</screen>
|
| 1328 |
</section>
|
| 1329 |
|
| 1330 |
<section id="pts-vcs-commit">
|
| 1331 |
<title>Forwarding VCS commits in the PTS</title>
|
| 1332 |
<para>
|
| 1333 |
If you use a publicly accessible VCS repository for maintaining your Debian
|
| 1334 |
package, you may want to forward the commit notification to the PTS so that the
|
| 1335 |
subscribers (and possible co-maintainers) can closely follow the package's
|
| 1336 |
evolution.
|
| 1337 |
</para>
|
| 1338 |
<para>
|
| 1339 |
Once you set up the VCS repository to generate commit notifications, you just
|
| 1340 |
have to make sure it sends a copy of those mails to
|
| 1341 |
<literal><replaceable>sourcepackage</replaceable>_cvs@&pts-host;</literal>.
|
| 1342 |
Only the people who accept the <literal>cvs</literal> keyword will receive
|
| 1343 |
these notifications. Note that the mail need to be sent from a
|
| 1344 |
<literal>debian.org</literal> machine, otherwise you'll have to add
|
| 1345 |
the <literal>X-PTS-Approved: 1</literal> header.
|
| 1346 |
</para>
|
| 1347 |
<para>
|
| 1348 |
For Subversion repositories, the usage of svnmailer is recommended.
|
| 1349 |
See <ulink url="&url-alioth-pkg;" /> for an example on how to do it.
|
| 1350 |
</para>
|
| 1351 |
</section>
|
| 1352 |
|
| 1353 |
<section id="pts-web">
|
| 1354 |
<title>The PTS web interface</title>
|
| 1355 |
<para>
|
| 1356 |
The PTS has a web interface at <ulink
|
| 1357 |
url="http://&pts-host;/"></ulink> that puts together a lot of
|
| 1358 |
information about each source package. It features many useful links (BTS, QA
|
| 1359 |
stats, contact information, DDTP translation status, buildd logs) and gathers
|
| 1360 |
much more information from various places (30 latest changelog entries, testing
|
| 1361 |
status, ...). It's a very useful tool if you want to know what's going on with
|
| 1362 |
a specific source package. Furthermore there's a form that allows easy
|
| 1363 |
subscription to the PTS via email.
|
| 1364 |
</para>
|
| 1365 |
<para>
|
| 1366 |
You can jump directly to the web page concerning a specific source package with
|
| 1367 |
a URL like
|
| 1368 |
<literal>http://&pts-host;/<replaceable>sourcepackage</replaceable></literal>.
|
| 1369 |
</para>
|
| 1370 |
<para>
|
| 1371 |
This web interface has been designed like a portal for the development of
|
| 1372 |
packages: you can add custom content on your packages' pages. You can add
|
| 1373 |
static information (news items that are meant to stay available indefinitely)
|
| 1374 |
and news items in the latest news section.
|
| 1375 |
</para>
|
| 1376 |
<para>
|
| 1377 |
Static news items can be used to indicate:
|
| 1378 |
</para>
|
| 1379 |
<itemizedlist>
|
| 1380 |
<listitem>
|
| 1381 |
<para>
|
| 1382 |
the availability of a project hosted on
|
| 1383 |
<link linkend="alioth">Alioth</link> for co-maintaining the package
|
| 1384 |
</para>
|
| 1385 |
</listitem>
|
| 1386 |
<listitem>
|
| 1387 |
<para>
|
| 1388 |
a link to the upstream web site
|
| 1389 |
</para>
|
| 1390 |
</listitem>
|
| 1391 |
<listitem>
|
| 1392 |
<para>
|
| 1393 |
a link to the upstream bug tracker
|
| 1394 |
</para>
|
| 1395 |
</listitem>
|
| 1396 |
<listitem>
|
| 1397 |
<para>
|
| 1398 |
the existence of an IRC channel dedicated to the software
|
| 1399 |
</para>
|
| 1400 |
</listitem>
|
| 1401 |
<listitem>
|
| 1402 |
<para>
|
| 1403 |
any other available resource that could be useful in the maintenance of the
|
| 1404 |
package
|
| 1405 |
</para>
|
| 1406 |
</listitem>
|
| 1407 |
</itemizedlist>
|
| 1408 |
<para>
|
| 1409 |
Usual news items may be used to announce that:
|
| 1410 |
</para>
|
| 1411 |
<itemizedlist>
|
| 1412 |
<listitem>
|
| 1413 |
<para>
|
| 1414 |
beta packages are available for testing
|
| 1415 |
</para>
|
| 1416 |
</listitem>
|
| 1417 |
<listitem>
|
| 1418 |
<para>
|
| 1419 |
final packages are expected for next week
|
| 1420 |
</para>
|
| 1421 |
</listitem>
|
| 1422 |
<listitem>
|
| 1423 |
<para>
|
| 1424 |
the packaging is about to be redone from scratch
|
| 1425 |
</para>
|
| 1426 |
</listitem>
|
| 1427 |
<listitem>
|
| 1428 |
<para>
|
| 1429 |
backports are available
|
| 1430 |
</para>
|
| 1431 |
</listitem>
|
| 1432 |
<listitem>
|
| 1433 |
<para>
|
| 1434 |
the maintainer is on vacation (if they wish to publish this information)
|
| 1435 |
</para>
|
| 1436 |
</listitem>
|
| 1437 |
<listitem>
|
| 1438 |
<para>
|
| 1439 |
a NMU is being worked on
|
| 1440 |
</para>
|
| 1441 |
</listitem>
|
| 1442 |
<listitem>
|
| 1443 |
<para>
|
| 1444 |
something important will affect the package
|
| 1445 |
</para>
|
| 1446 |
</listitem>
|
| 1447 |
</itemizedlist>
|
| 1448 |
<para>
|
| 1449 |
Both kinds of news are generated in a similar manner: you just have to send an
|
| 1450 |
email either to <email>pts-static-news@qa.debian.org</email> or to
|
| 1451 |
<email>pts-news@qa.debian.org</email>. The mail should indicate which package
|
| 1452 |
is concerned by having the name of the source package in a
|
| 1453 |
<literal>X-PTS-Package</literal> mail header or in a <literal>Package</literal>
|
| 1454 |
pseudo-header (like the BTS reports). If a URL is available in the
|
| 1455 |
<literal>X-PTS-Url</literal> mail header or in the <literal>Url</literal>
|
| 1456 |
pseudo-header, then the result is a link to that URL instead of a complete news
|
| 1457 |
item.
|
| 1458 |
</para>
|
| 1459 |
<para>
|
| 1460 |
Here are a few examples of valid mails used to generate news items in the PTS.
|
| 1461 |
The first one adds a link to the cvsweb interface of debian-cd in the Static
|
| 1462 |
information section:
|
| 1463 |
</para>
|
| 1464 |
<screen>
|
| 1465 |
From: Raphael Hertzog <hertzog@debian.org>
|
| 1466 |
To: pts-static-news@qa.debian.org
|
| 1467 |
Subject: Browse debian-cd SVN repository
|
| 1468 |
|
| 1469 |
Package: debian-cd
|
| 1470 |
Url: http://svn.debian.org/viewsvn/debian-cd/trunk/
|
| 1471 |
</screen>
|
| 1472 |
<para>
|
| 1473 |
The second one is an announcement sent to a mailing list which is also sent to
|
| 1474 |
the PTS so that it is published on the PTS web page of the package. Note the
|
| 1475 |
use of the BCC field to avoid answers sent to the PTS by mistake.
|
| 1476 |
</para>
|
| 1477 |
<screen>
|
| 1478 |
From: Raphael Hertzog <hertzog@debian.org>
|
| 1479 |
To: debian-gtk-gnome@&lists-host;
|
| 1480 |
Bcc: pts-news@qa.debian.org
|
| 1481 |
Subject: Galeon 2.0 backported for woody
|
| 1482 |
X-PTS-Package: galeon
|
| 1483 |
|
| 1484 |
Hello gnomers!
|
| 1485 |
|
| 1486 |
I'm glad to announce that galeon has been backported for woody. You'll find
|
| 1487 |
everything here:
|
| 1488 |
...
|
| 1489 |
</screen>
|
| 1490 |
<para>
|
| 1491 |
Think twice before adding a news item to the PTS because you won't be able to
|
| 1492 |
remove it later and you won't be able to edit it either. The only thing that
|
| 1493 |
you can do is send a second news item that will deprecate the information
|
| 1494 |
contained in the previous one.
|
| 1495 |
</para>
|
| 1496 |
</section>
|
| 1497 |
|
| 1498 |
</section>
|
| 1499 |
|
| 1500 |
<section id="ddpo">
|
| 1501 |
<title>Developer's packages overview</title>
|
| 1502 |
<para>
|
| 1503 |
A QA (quality assurance) web portal is available at <ulink
|
| 1504 |
url="&url-ddpo;"></ulink> which displays a table listing all
|
| 1505 |
the packages of a single developer (including those where the party is listed
|
| 1506 |
as a co-maintainer). The table gives a good summary about the developer's
|
| 1507 |
packages: number of bugs by severity, list of available versions in each
|
| 1508 |
distribution, testing status and much more including links to any other useful
|
| 1509 |
information.
|
| 1510 |
</para>
|
| 1511 |
<para>
|
| 1512 |
It is a good idea to look up your own data regularly so that you don't forget
|
| 1513 |
any open bugs, and so that you don't forget which packages are your
|
| 1514 |
responsibility.
|
| 1515 |
</para>
|
| 1516 |
</section>
|
| 1517 |
|
| 1518 |
<section id="alioth">
|
| 1519 |
<title>Debian's GForge installation: Alioth</title>
|
| 1520 |
<para>
|
| 1521 |
Alioth is a Debian service based on a slightly modified version of the
|
| 1522 |
GForge software (which evolved from SourceForge). This software offers
|
| 1523 |
developers access to easy-to-use tools such as bug trackers, patch
|
| 1524 |
manager, project/task managers, file hosting services, mailing lists, CVS
|
| 1525 |
repositories etc. All these tools are managed via a web interface.
|
| 1526 |
</para>
|
| 1527 |
<para>
|
| 1528 |
It is intended to provide facilities to free software projects backed or led by
|
| 1529 |
Debian, facilitate contributions from external developers to projects started
|
| 1530 |
by Debian, and help projects whose goals are the promotion of Debian or its
|
| 1531 |
derivatives. It's heavily used by many Debian teams and provides
|
| 1532 |
hosting for all sorts of VCS repositories.
|
| 1533 |
</para>
|
| 1534 |
<para>
|
| 1535 |
All Debian developers automatically have an account on Alioth. They can
|
| 1536 |
activate it by using the recover password facility. External developers can
|
| 1537 |
request guest accounts on Alioth.
|
| 1538 |
</para>
|
| 1539 |
<para>
|
| 1540 |
For more information please visit the following links:
|
| 1541 |
</para>
|
| 1542 |
<itemizedlist>
|
| 1543 |
<listitem><para><ulink url="&url-alioth-wiki;" /></para></listitem>
|
| 1544 |
<listitem><para><ulink url="&url-alioth-faq;" /></para></listitem>
|
| 1545 |
<listitem><para><ulink url="&url-alioth-pkg;" /></para></listitem>
|
| 1546 |
<listitem><para><ulink url="&url-alioth;" /></para></listitem>
|
| 1547 |
</itemizedlist>
|
| 1548 |
</section>
|
| 1549 |
|
| 1550 |
<section id="developer-misc">
|
| 1551 |
<title>Goodies for Developers</title>
|
| 1552 |
<section id="lwn">
|
| 1553 |
<title>LWN Subscriptions</title>
|
| 1554 |
<para>
|
| 1555 |
Since October of 2002, HP has sponsored a subscription to LWN for all
|
| 1556 |
interested Debian developers. Details on how to get access to this benefit are
|
| 1557 |
in <ulink
|
| 1558 |
url="http://&lists-host;/debian-devel-announce/2002/10/msg00018.html"></ulink>.
|
| 1559 |
</para>
|
| 1560 |
</section>
|
| 1561 |
<section id="gandi">
|
| 1562 |
<title>Gandi.net Hosting Discount</title>
|
| 1563 |
<para>
|
| 1564 |
As of November 2008, Gandi.net offers a discount rate on their VPS
|
| 1565 |
hosting for Debian Developers. See
|
| 1566 |
<ulink url="http://&lists-host;/debian-devel-announce/2008/11/msg00004.html"></ulink>.
|
| 1567 |
</para>
|
| 1568 |
</section>
|
| 1569 |
|
| 1570 |
</section>
|
| 1571 |
|
| 1572 |
</chapter>
|
| 1573 |
|