chiark / gitweb /
add some spaces between attributes, sidestepping #430792.
[developers-reference.git] / beyond-pkging.dbk
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3     "">
4 <chapter id="beyond-pkging">
5 <title>Beyond Packaging</title>
6 <para>
7 Debian is about a lot more than just packaging software and maintaining those
8 packages.  This chapter contains information about ways, often really critical
9 ways, to contribute to Debian beyond simply creating and maintaining packages.
10 </para>
11 <para>
12 As a volunteer organization, Debian relies on the discretion of its members in
13 choosing what they want to work on and in choosing the most critical thing to
14 spend their time on.
15 </para>
16 <section id="submit-bug">
17 <title>Bug reporting</title>
18 <para>
19 We encourage you to file bugs as you find them in Debian packages.  In fact,
20 Debian developers are often the first line testers.  Finding and reporting bugs
21 in other developers' packages improves the quality of Debian.
22 </para>
23 <para>
24 Read the <ulink url="">instructions for
25 reporting bugs</ulink> in the Debian <ulink
26 url="">bug tracking system</ulink>.
27 </para>
28 <para>
29 Try to submit the bug from a normal user account at which you are likely to
30 receive mail, so that people can reach you if they need further information
31 about the bug.  Do not submit bugs as root.
32 </para>
33 <para>
34 You can use a tool like <citerefentry> <refentrytitle>reportbug</refentrytitle>
35 <manvolnum>1</manvolnum> </citerefentry> to submit bugs.  It can automate and
36 generally ease the process.
37 </para>
38 <para>
39 Make sure the bug is not already filed against a package.  Each package has a
40 bug list easily reachable at
41 <literal><replaceable>packagename</replaceable></literal>
42 Utilities like <citerefentry> <refentrytitle>querybts</refentrytitle>
43 <manvolnum>1</manvolnum> </citerefentry> can also provide you with this
44 information (and <command>reportbug</command> will usually invoke
45 <command>querybts</command> before sending, too).
46 </para>
47 <para>
48 Try to direct your bugs to the proper location.  When for example your bug is
49 about a package which overwrites files from another package, check the bug
50 lists for <emphasis>both</emphasis> of those packages in order to avoid filing
51 duplicate bug reports.
52 </para>
53 <para>
54 For extra credit, you can go through other packages, merging bugs which are
55 reported more than once, or tagging bugs `fixed' when they have already been
56 fixed.  Note that when you are neither the bug submitter nor the package
57 maintainer, you should not actually close the bug (unless you secure permission
58 from the maintainer).
59 </para>
60 <para>
61 From time to time you may want to check what has been going on with the bug
62 reports that you submitted.  Take this opportunity to close those that you
63 can't reproduce anymore.  To find out all the bugs you submitted, you just have
64 to visit
65 <literal><replaceable>&lt;your-email-addr&gt;</replaceable></literal>.
66 </para>
67 <section id="submit-many-bugs">
68 <title>Reporting lots of bugs at once (mass bug filing)</title>
69 <para>
70 Reporting a great number of bugs for the same problem on a great number of
71 different packages — i.e., more than 10 — is a deprecated practice.  Take
72 all possible steps to avoid submitting bulk bugs at all.  For instance, if
73 checking for the problem can be automated, add a new check to <systemitem
74 role="package">lintian</systemitem> so that an error or warning is emitted.
75 </para>
76 <para>
77 If you report more than 10 bugs on the same topic at once, it is recommended
78 that you send a message to <email></email>
79 describing your intention before submitting the report, and mentioning the fact
80 in the subject of your mail.  This will allow other developers to verify that
81 the bug is a real problem.  In addition, it will help prevent a situation in
82 which several maintainers start filing the same bug report simultaneously.
83 </para>
84 <para>
85 Please use the programms <command>dd-list</command> and if appropriate
86 <command>whodepends</command> (from the package devscripts) to generate a list
87 of all affected packages, and include the output in your mail to
88 <email></email>.
89 </para>
90 <para>
91 Note that when sending lots of bugs on the same subject, you should send the
92 bug report to <email></email> so that the bug report
93 is not forwarded to the bug distribution mailing list.
94 </para>
95 </section>
97 </section>
99 <section id="qa-effort">
100 <title>Quality Assurance effort</title>
101 <section id="qa-daily-work">
102 <title>Daily work</title>
103 <para>
104 Even though there is a dedicated group of people for Quality Assurance, QA
105 duties are not reserved solely for them.  You can participate in this effort by
106 keeping your packages as bug-free as possible, and as lintian-clean (see <xref
107 linkend="lintian"/> ) as possible.  If you do not find that possible, then you
108 should consider orphaning some of your packages (see <xref
109 linkend="orphaning"/> ).  Alternatively, you may ask the help of other people
110 in order to catch up with the backlog of bugs that you have (you can ask for
111 help on <email></email> or
112 <email></email>).  At the same time, you can look
113 for co-maintainers (see <xref linkend="collaborative-maint"/> ).
114 </para>
115 </section>
117 <section id="qa-bsp">
118 <title>Bug squashing parties</title>
119 <para>
120 From time to time the QA group organizes bug squashing parties to get rid of as
121 many problems as possible.  They are announced on
122 <email></email> and the announcement
123 explains which area will be the focus of the party: usually they focus on
124 release critical bugs but it may happen that they decide to help finish a major
125 upgrade (like a new perl version which requires recompilation of all the binary
126 modules).
127 </para>
128 <para>
129 The rules for non-maintainer uploads differ during the parties because the
130 announcement of the party is considered prior notice for NMU.  If you have
131 packages that may be affected by the party (because they have release critical
132 bugs for example), you should send an update to each of the corresponding bug
133 to explain their current status and what you expect from the party.  If you
134 don't want an NMU, or if you're only interested in a patch, or if you will deal
135 yourself with the bug, please explain that in the BTS.
136 </para>
137 <para>
138 People participating in the party have special rules for NMU, they can NMU
139 without prior notice if they upload their NMU to DELAYED/3-day at least.  All
140 other NMU rules apply as usually; they should send the patch of the NMU to the
141 BTS (to one of the open bugs fixed by the NMU, or to a new bug, tagged fixed).
142 They should also respect any particular wishes of the maintainer.
143 </para>
144 <para>
145 If you don't feel confident about doing an NMU, just send a patch to the BTS.
146 It's far better than a broken NMU.
147 </para>
148 </section>
150 </section>
152 <section id="contacting-maintainers">
153 <title>Contacting other maintainers</title>
154 <para>
155 During your lifetime within Debian, you will have to contact other maintainers
156 for various reasons.  You may want to discuss a new way of cooperating between
157 a set of related packages, or you may simply remind someone that a new upstream
158 version is available and that you need it.
159 </para>
160 <para>
161 Looking up the email address of the maintainer for the package can be
162 distracting.  Fortunately, there is a simple email alias,
163 <literal>&lt;package&gt;</literal>, which provides a way to
164 email the maintainer, whatever their individual email address (or addresses)
165 may be.  Replace <literal>&lt;package&gt;</literal> with the name of a source
166 or a binary package.
167 </para>
168 <para>
169 You may also be interested in contacting the persons who are subscribed to a
170 given source package via <xref linkend="pkg-tracking-system"/> .  You can do so
171 by using the <literal>&lt;package&gt;</literal> email
172 address.
173 </para>
174 </section>
176 <section id="mia-qa">
177 <title>Dealing with inactive and/or unreachable maintainers</title>
178 <para>
179 If you notice that a package is lacking maintenance, you should make sure that
180 the maintainer is active and will continue to work on their packages.  It is
181 possible that they are not active any more, but haven't registered out of the
182 system, so to speak.  On the other hand, it is also possible that they just
183 need a reminder.
184 </para>
185 <para>
186 There is a simple system (the MIA database) in which information about
187 maintainers who are deemed Missing In Action is recorded.  When a member of the
188 QA group contacts an inactive maintainer or finds more information about one,
189 this is recorded in the MIA database.  This system is available in
190 /org/ on the host, and can be queried with a
191 tool known as <command>mia-query</command>.  Use
192 </para>
193 <screen>
194 -query --help
195 </screen>
196 <para>
197 to see how to query the database.  If you find that no information has been
198 recorded about an inactive maintainer yet, or that you can add more
199 information, you should generally proceed as follows.
200 </para>
201 <para>
202 The first step is to politely contact the maintainer, and wait a reasonable
203 time for a response.  It is quite hard to define reasonable time, but it is
204 important to take into account that real life is sometimes very hectic.  One
205 way to handle this would be to send a reminder after two weeks.
206 </para>
207 <para>
208 If the maintainer doesn't reply within four weeks (a month), one can assume
209 that a response will probably not happen.  If that happens, you should
210 investigate further, and try to gather as much useful information about the
211 maintainer in question as possible.  This includes:
212 </para>
213 <itemizedlist>
214 <listitem>
215 <para>
216 The echelon information available through the <ulink
217 url="">developers' LDAP database</ulink>, which indicates
218 when the developer last posted to a Debian mailing list.  (This includes
219 uploads via debian-*-changes lists.) Also, remember to check whether the
220 maintainer is marked as on vacation in the database.
221 </para>
222 </listitem>
223 <listitem>
224 <para>
225 The number of packages this maintainer is responsible for, and the condition of
226 those packages.  In particular, are there any RC bugs that have been open for
227 ages?  Furthermore, how many bugs are there in general?  Another important
228 piece of information is whether the packages have been NMUed, and if so, by
229 whom.
230 </para>
231 </listitem>
232 <listitem>
233 <para>
234 Is there any activity of the maintainer outside of Debian?  For example, they
235 might have posted something recently to non-Debian mailing lists or news
236 groups.
237 </para>
238 </listitem>
239 </itemizedlist>
240 <para>
241 A bit of a problem are packages which were sponsored — the maintainer is not
242 an official Debian developer.  The echelon information is not available for
243 sponsored people, for example, so you need to find and contact the Debian
244 developer who has actually uploaded the package.  Given that they signed the
245 package, they're responsible for the upload anyhow, and are likely to know what
246 happened to the person they sponsored.
247 </para>
248 <para>
249 It is also allowed to post a query to
250 <email></email>, asking if anyone is aware of the
251 whereabouts of the missing maintainer.  Please Cc: the person in question.
252 </para>
253 <para>
254 Once you have gathered all of this, you can contact
255 <email></email>.  People on this alias will use the
256 information you provide in order to decide how to proceed.  For example, they
257 might orphan one or all of the packages of the maintainer.  If a package has
258 been NMUed, they might prefer to contact the NMUer before orphaning the package
259 — perhaps the person who has done the NMU is interested in the package.
260 </para>
261 <para>
262 One last word: please remember to be polite.  We are all volunteers and cannot
263 dedicate all of our time to Debian.  Also, you are not aware of the
264 circumstances of the person who is involved.  Perhaps they might be seriously
265 ill or might even have died — you do not know who may be on the receiving
266 side.  Imagine how a relative will feel if they read the e-mail of the deceased
267 and find a very impolite, angry and accusing message!
268 </para>
269 <para>
270 On the other hand, although we are volunteers, we do have a responsibility.  So
271 you can stress the importance of the greater good — if a maintainer does not
272 have the time or interest anymore, they should let go and give the package to
273 someone with more time.
274 </para>
275 <para>
276 If you are interested in working in the MIA team, please have a look at the
277 README file in /org/ on where the technical
278 details and the MIA procedures are documented and contact
279 <email></email>.
280 </para>
281 </section>
283 <section id="newmaint">
284 <title>Interacting with prospective Debian developers</title>
285 <para>
286 Debian's success depends on its ability to attract and retain new and talented
287 volunteers.  If you are an experienced developer, we recommend that you get
288 involved with the process of bringing in new developers.  This section
289 describes how to help new prospective developers.
290 </para>
291 <section id="sponsoring">
292 <title>Sponsoring packages</title>
293 <para>
294 Sponsoring a package means uploading a package for a maintainer who is not able
295 to do it on their own, a new maintainer applicant.  Sponsoring a package also
296 means accepting responsibility for it.
297 </para>
298 <para>
299 New maintainers usually have certain difficulties creating Debian packages —
300 this is quite understandable.  That is why the sponsor is there, to check the
301 package and verify that it is good enough for inclusion in Debian.  (Note that
302 if the sponsored package is new, the ftpmasters will also have to inspect it
303 before letting it in.)
304 </para>
305 <para>
306 Sponsoring merely by signing the upload or just recompiling is <emphasis
307 role="strong">definitely not recommended</emphasis>.  You need to build the
308 source package just like you would build a package of your own.  Remember that
309 it doesn't matter that you left the prospective developer's name both in the
310 changelog and the control file, the upload can still be traced to you.
311 </para>
312 <para>
313 If you are an application manager for a prospective developer, you can also be
314 their sponsor.  That way you can also verify how the applicant is handling the
315 'Tasks and Skills' part of their application.
316 </para>
317 </section>
319 <section id="s7.5.2">
320 <title>Managing sponsored packages</title>
321 <para>
322 By uploading a sponsored package to Debian, you are certifying that the package
323 meets minimum Debian standards.  That implies that you must build and test the
324 package on your own system before uploading.
325 </para>
326 <para>
327 You cannot simply upload a binary <filename>.deb</filename> from the sponsoree.
328 In theory, you should only ask for the diff file and the location of the
329 original source tarball, and then you should download the source and apply the
330 diff yourself.  In practice, you may want to use the source package built by
331 your sponsoree.  In that case, you have to check that they haven't altered the
332 upstream files in the <filename>.orig.tar.gz</filename> file that they're
333 providing.
334 </para>
335 <para>
336 Do not be afraid to write the sponsoree back and point out changes that need to
337 be made.  It often takes several rounds of back-and-forth email before the
338 package is in acceptable shape.  Being a sponsor means being a mentor.
339 </para>
340 <para>
341 Once the package meets Debian standards, build and sign it with
342 </para>
343 <screen>
344 -buildpackage -k<replaceable>KEY-ID</replaceable>
345 </screen>
346 <para>
347 before uploading it to the incoming directory.  Of course, you can also use any
348 part of your <replaceable>KEY-ID</replaceable>, as long as it's unique in your
349 secret keyring.
350 </para>
351 <para>
352 The Maintainer field of the <filename>control</filename> file and the
353 <filename>changelog</filename> should list the person who did the packaging,
354 i.e., the sponsoree.  The sponsoree will therefore get all the BTS mail about
355 the package.
356 </para>
357 <para>
358 If you prefer to leave a more evident trace of your sponsorship job, you can
359 add a line stating it in the most recent changelog entry.
360 </para>
361 <para>
362 You are encouraged to keep tabs on the package you sponsor using <xref
363 linkend="pkg-tracking-system"/> .
364 </para>
365 </section>
367 <section id="s7.5.3">
368 <title>Advocating new developers</title>
369 <para>
370 See the page about <ulink
371 url="">advocating a prospective
372 developer</ulink> at the Debian web site.
373 </para>
374 </section>
376 <section id="s7.5.4">
377 <title>Handling new maintainer applications</title>
378 <para>
379 Please see <ulink
380 url="">Checklist for Application
381 Managers</ulink> at the Debian web site.
382 </para>
383 </section>
385 </section>
387 </chapter>