1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "POT-Creation-Date: 2007-07-01 21:18+0000\n"
10 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
11 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
12 "Language-Team: LANGUAGE <LL@li.org>\n"
14 "Content-Type: text/plain; charset=UTF-8\n"
15 "Content-Transfer-Encoding: ENCODING\n"
17 # type: Content of: <chapter><title>
18 #: best-pkging-practices.dbk:7
19 msgid "Best Packaging Practices"
22 # type: Content of: <chapter><para>
23 #: best-pkging-practices.dbk:9
25 "Debian's quality is largely due to the <ulink url=\"&url-debian-policy;"
26 "\">Debian Policy</ulink>, which defines explicit baseline requirements which "
27 "all Debian packages must fulfill. Yet there is also a shared history of "
28 "experience which goes beyond the Debian Policy, an accumulation of years of "
29 "experience in packaging. Many very talented people have created great "
30 "tools, tools which help you, the Debian maintainer, create and maintain "
34 # type: Content of: <chapter><para>
35 #: best-pkging-practices.dbk:18
37 "This chapter provides some best practices for Debian developers. All "
38 "recommendations are merely that, and are not requirements or policy. These "
39 "are just some subjective hints, advice and pointers collected from Debian "
40 "developers. Feel free to pick and choose whatever works best for you."
43 # type: Content of: <chapter><section><title>
44 #: best-pkging-practices.dbk:24
45 msgid "Best practices for <filename>debian/rules</filename>"
48 # type: Content of: <chapter><section><para>
49 #: best-pkging-practices.dbk:26
51 "The following recommendations apply to the <filename>debian/rules</filename> "
52 "file. Since <filename>debian/rules</filename> controls the build process "
53 "and selects the files which go into the package (directly or indirectly), "
54 "it's usually the file maintainers spend the most time on."
57 # type: Content of: <chapter><section><section><title>
58 #: best-pkging-practices.dbk:32
59 msgid "Helper scripts"
62 # type: Content of: <chapter><section><section><para>
63 #: best-pkging-practices.dbk:34
65 "The rationale for using helper scripts in <filename>debian/rules</filename> "
66 "is that they let maintainers use and share common logic among many "
67 "packages. Take for instance the question of installing menu entries: you "
68 "need to put the file into <filename>/usr/lib/menu</filename> (or <filename>/"
69 "usr/lib/menu</filename> for executable binary menufiles, if this is needed), "
70 "and add commands to the maintainer scripts to register and unregister the "
71 "menu entries. Since this is a very common thing for packages to do, why "
72 "should each maintainer rewrite all this on their own, sometimes with bugs? "
73 "Also, supposing the menu directory changed, every package would have to be "
77 # type: Content of: <chapter><section><section><para>
78 #: best-pkging-practices.dbk:45
80 "Helper scripts take care of these issues. Assuming you comply with the "
81 "conventions expected by the helper script, the helper takes care of all the "
82 "details. Changes in policy can be made in the helper script; then packages "
83 "just need to be rebuilt with the new version of the helper and no other "
87 # type: Content of: <chapter><section><section><para>
88 #: best-pkging-practices.dbk:52
90 "<xref linkend=\"tools\"/> contains a couple of different helpers. The most "
91 "common and best (in our opinion) helper system is <systemitem role=\"package"
92 "\">debhelper</systemitem>. Previous helper systems, such as <systemitem "
93 "role=\"package\">debmake</systemitem>, were monolithic: you couldn't pick "
94 "and choose which part of the helper you found useful, but had to use the "
95 "helper to do everything. <systemitem role=\"package\">debhelper</"
96 "systemitem>, however, is a number of separate little <command>dh_*</command> "
97 "programs. For instance, <command>dh_installman</command> installs and "
98 "compresses man pages, <command>dh_installmenu</command> installs menu files, "
99 "and so on. Thus, it offers enough flexibility to be able to use the little "
100 "helper scripts, where useful, in conjunction with hand-crafted commands in "
101 "<filename>debian/rules</filename>."
104 # type: Content of: <chapter><section><section><para>
105 #: best-pkging-practices.dbk:66
107 "You can get started with <systemitem role=\"package\">debhelper</systemitem> "
108 "by reading <citerefentry> <refentrytitle>debhelper</refentrytitle> "
109 "<manvolnum>1</manvolnum> </citerefentry>, and looking at the examples that "
110 "come with the package. <command>dh_make</command>, from the <systemitem "
111 "role=\"package\">dh-make</systemitem> package (see <xref linkend=\"dh-make\"/"
112 "> ), can be used to convert a vanilla source package to a <systemitem role="
113 "\"package\">debhelper</systemitem>ized package. This shortcut, though, "
114 "should not convince you that you do not need to bother understanding the "
115 "individual <command>dh_*</command> helpers. If you are going to use a "
116 "helper, you do need to take the time to learn to use that helper, to learn "
117 "its expectations and behavior."
120 # type: Content of: <chapter><section><section><para>
121 #: best-pkging-practices.dbk:79
123 "Some people feel that vanilla <filename>debian/rules</filename> files are "
124 "better, since you don't have to learn the intricacies of any helper system. "
125 "This decision is completely up to you. Use what works for you. Many "
126 "examples of vanilla <filename>debian/rules</filename> files are available at "
127 "<ulink url=\"&url-rules-files;\"></ulink>."
130 # type: Content of: <chapter><section><section><title>
131 #: best-pkging-practices.dbk:88
132 msgid "Separating your patches into multiple files"
135 # type: Content of: <chapter><section><section><para>
136 #: best-pkging-practices.dbk:90
138 "Big, complex packages may have many bugs that you need to deal with. If you "
139 "correct a number of bugs directly in the source, and you're not careful, it "
140 "can get hard to differentiate the various patches that you applied. It can "
141 "get quite messy when you have to update the package to a new upstream "
142 "version which integrates some of the fixes (but not all). You can't take "
143 "the total set of diffs (e.g., from <filename>.diff.gz</filename>) and work "
144 "out which patch sets to back out as a unit as bugs are fixed upstream."
147 # type: Content of: <chapter><section><section><para>
148 #: best-pkging-practices.dbk:99
150 "Unfortunately, the packaging system as such currently doesn't provide for "
151 "separating the patches into several files. Nevertheless, there are ways to "
152 "separate patches: the patch files are shipped within the Debian patch file "
153 "(<filename>.diff.gz</filename>), usually within the <filename>debian/</"
154 "filename> directory. The only difference is that they aren't applied "
155 "immediately by dpkg-source, but by the <literal>build</literal> rule of "
156 "<filename>debian/rules</filename>. Conversely, they are reverted in the "
157 "<literal>clean</literal> rule."
160 # type: Content of: <chapter><section><section><para>
161 #: best-pkging-practices.dbk:109
163 "<command>dbs</command> is one of the more popular approaches to this. It "
164 "does all of the above, and provides a facility for creating new and updating "
165 "old patches. See the package <systemitem role=\"package\">dbs</systemitem> "
166 "for more information and <systemitem role=\"package\">hello-dbs</systemitem> "
170 # type: Content of: <chapter><section><section><para>
171 #: best-pkging-practices.dbk:116
173 "<command>dpatch</command> also provides these facilities, but it's intended "
174 "to be even easier to use. See the package <systemitem role=\"package"
175 "\">dpatch</systemitem> for documentation and examples (in <filename>/usr/"
176 "share/doc/dpatch</filename>)."
179 # type: Content of: <chapter><section><section><title>
180 #: best-pkging-practices.dbk:124
181 msgid "Multiple binary packages"
184 # type: Content of: <chapter><section><section><para>
185 #: best-pkging-practices.dbk:126
187 "A single source package will often build several binary packages, either to "
188 "provide several flavors of the same software (e.g., the <systemitem role="
189 "\"package\">vim</systemitem> source package) or to make several small "
190 "packages instead of a big one (e.g., so the user can install only the subset "
191 "needed, and thus save some disk space)."
194 # type: Content of: <chapter><section><section><para>
195 #: best-pkging-practices.dbk:133
197 "The second case can be easily managed in <filename>debian/rules</filename>. "
198 "You just need to move the appropriate files from the build directory into "
199 "the package's temporary trees. You can do this using <command>install</"
200 "command> or <command>dh_install</command> from <systemitem role=\"package"
201 "\">debhelper</systemitem>. Be sure to check the different permutations of "
202 "the various packages, ensuring that you have the inter-package dependencies "
203 "set right in <filename>debian/control</filename>."
206 # type: Content of: <chapter><section><section><para>
207 #: best-pkging-practices.dbk:142
209 "The first case is a bit more difficult since it involves multiple recompiles "
210 "of the same software but with different configuration options. The "
211 "<systemitem role=\"package\">vim</systemitem> source package is an example "
212 "of how to manage this using an hand-crafted <filename>debian/rules</"
216 # type: Content of: <chapter><section><title>
217 #: best-pkging-practices.dbk:154
218 msgid "Best practices for <filename>debian/control</filename>"
221 # type: Content of: <chapter><section><para>
222 #: best-pkging-practices.dbk:156
224 "The following practices are relevant to the <filename>debian/control</"
225 "filename> file. They supplement the <ulink url=\"&url-debian-policy;ch-"
226 "binary.html#s-descriptions\">Policy on package descriptions</ulink>."
229 # type: Content of: <chapter><section><para>
230 #: best-pkging-practices.dbk:162
232 "The description of the package, as defined by the corresponding field in the "
233 "<filename>control</filename> file, contains both the package synopsis and "
234 "the long description for the package. <xref linkend=\"bpp-desc-basics\"/> "
235 "describes common guidelines for both parts of the package description. "
236 "Following that, <xref linkend=\"bpp-pkg-synopsis\"/> provides guidelines "
237 "specific to the synopsis, and <xref linkend=\"bpp-pkg-desc\"/> contains "
238 "guidelines specific to the description."
241 # type: Content of: <chapter><section><section><title>
242 #: best-pkging-practices.dbk:171
243 msgid "General guidelines for package descriptions"
246 # type: Content of: <chapter><section><section><para>
247 #: best-pkging-practices.dbk:173
249 "The package description should be written for the average likely user, the "
250 "average person who will use and benefit from the package. For instance, "
251 "development packages are for developers, and can be technical in their "
252 "language. More general-purpose applications, such as editors, should be "
253 "written for a less technical user."
256 # type: Content of: <chapter><section><section><para>
257 #: best-pkging-practices.dbk:180
259 "Our review of package descriptions lead us to conclude that most package "
260 "descriptions are technical, that is, are not written to make sense for non-"
261 "technical users. Unless your package really is only for technical users, "
265 # type: Content of: <chapter><section><section><para>
266 #: best-pkging-practices.dbk:186
268 "How do you write for non-technical users? Avoid jargon. Avoid referring to "
269 "other applications or frameworks that the user might not be familiar with — "
270 "GNOME or KDE is fine, since users are probably familiar with these terms, "
271 "but GTK+ is probably not. Try not to assume any knowledge at all. If you "
272 "must use technical terms, introduce them."
275 # type: Content of: <chapter><section><section><para>
276 #: best-pkging-practices.dbk:193
278 "Be objective. Package descriptions are not the place for advocating your "
279 "package, no matter how much you love it. Remember that the reader may not "
280 "care about the same things you care about."
283 # type: Content of: <chapter><section><section><para>
284 #: best-pkging-practices.dbk:198
286 "References to the names of any other software packages, protocol names, "
287 "standards, or specifications should use their canonical forms, if one "
288 "exists. For example, use X Window System, X11, or X; not X Windows, X-"
289 "Windows, or X Window. Use GTK+, not GTK or gtk. Use GNOME, not Gnome. Use "
290 "PostScript, not Postscript or postscript."
293 # type: Content of: <chapter><section><section><para>
294 #: best-pkging-practices.dbk:205
296 "If you are having problems writing your description, you may wish to send it "
297 "along to &email-debian-l10n-english; and request feedback."
300 # type: Content of: <chapter><section><section><title>
301 #: best-pkging-practices.dbk:211
302 msgid "The package synopsis, or short description"
305 # type: Content of: <chapter><section><section><para>
306 #: best-pkging-practices.dbk:213
308 "The synopsis line (the short description) should be concise. It must not "
309 "repeat the package's name (this is policy)."
312 # type: Content of: <chapter><section><section><para>
313 #: best-pkging-practices.dbk:217
315 "It's a good idea to think of the synopsis as an appositive clause, not a "
316 "full sentence. An appositive clause is defined in WordNet as a grammatical "
317 "relation between a word and a noun phrase that follows, e.g., Rudolph the "
318 "red-nosed reindeer. The appositive clause here is red-nosed reindeer. "
319 "Since the synopsis is a clause, rather than a full sentence, we recommend "
320 "that it neither start with a capital nor end with a full stop (period). It "
321 "should also not begin with an article, either definite (the) or indefinite "
325 # type: Content of: <chapter><section><section><para>
326 #: best-pkging-practices.dbk:226
328 "It might help to imagine that the synopsis is combined with the package name "
329 "in the following way:"
332 # type: Content of: <chapter><section><section><screen>
333 #: best-pkging-practices.dbk:230
335 msgid "<replaceable>package-name</replaceable> is a <replaceable>synopsis</replaceable>."
338 # type: Content of: <chapter><section><section><para>
339 #: best-pkging-practices.dbk:233
340 msgid "Alternatively, it might make sense to think of it as"
343 # type: Content of: <chapter><section><section><screen>
344 #: best-pkging-practices.dbk:236
346 msgid "<replaceable>package-name</replaceable> is <replaceable>synopsis</replaceable>."
349 # type: Content of: <chapter><section><section><para>
350 #: best-pkging-practices.dbk:239
351 msgid "or, if the package name itself is a plural (such as developers-tools)"
354 # type: Content of: <chapter><section><section><screen>
355 #: best-pkging-practices.dbk:242
357 msgid "<replaceable>package-name</replaceable> are <replaceable>synopsis</replaceable>."
360 # type: Content of: <chapter><section><section><para>
361 #: best-pkging-practices.dbk:245
363 "This way of forming a sentence from the package name and synopsis should be "
364 "considered as a heuristic and not a strict rule. There are some cases where "
365 "it doesn't make sense to try to form a sentence."
368 # type: Content of: <chapter><section><section><title>
369 #: best-pkging-practices.dbk:252
370 msgid "The long description"
373 # type: Content of: <chapter><section><section><para>
374 #: best-pkging-practices.dbk:254
376 "The long description is the primary information available to the user about "
377 "a package before they install it. It should provide all the information "
378 "needed to let the user decide whether to install the package. Assume that "
379 "the user has already read the package synopsis."
382 # type: Content of: <chapter><section><section><para>
383 #: best-pkging-practices.dbk:260
384 msgid "The long description should consist of full and complete sentences."
387 # type: Content of: <chapter><section><section><para>
388 #: best-pkging-practices.dbk:263
390 "The first paragraph of the long description should answer the following "
391 "questions: what does the package do? what task does it help the user "
392 "accomplish? It is important to describe this in a non-technical way, unless "
393 "of course the audience for the package is necessarily technical."
396 # type: Content of: <chapter><section><section><para>
397 #: best-pkging-practices.dbk:269
399 "The following paragraphs should answer the following questions: Why do I as "
400 "a user need this package? What other features does the package have? What "
401 "outstanding features and deficiencies are there compared to other packages "
402 "(e.g., if you need X, use Y instead)? Is this package related to other "
403 "packages in some way that is not handled by the package manager (e.g., this "
404 "is the client for the foo server)?"
407 # type: Content of: <chapter><section><section><para>
408 #: best-pkging-practices.dbk:277
410 "Be careful to avoid spelling and grammar mistakes. Ensure that you spell-"
411 "check it. Both <command>ispell</command> and <command>aspell</command> have "
412 "special modes for checking <filename>debian/control</filename> files:"
415 # type: Content of: <chapter><section><section><screen>
416 #: best-pkging-practices.dbk:282
418 msgid "ispell -d american -g debian/control"
421 # type: Content of: <chapter><section><section><screen>
422 #: best-pkging-practices.dbk:285
424 msgid "aspell -d en -D -c debian/control"
427 # type: Content of: <chapter><section><section><para>
428 #: best-pkging-practices.dbk:288
430 "Users usually expect these questions to be answered in the package "
434 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
435 #: best-pkging-practices.dbk:293
437 "What does the package do? If it is an add-on to another package, then the "
438 "short description of the package we are an add-on to should be put in here."
441 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
442 #: best-pkging-practices.dbk:299
444 "Why should I want this package? This is related to the above, but not the "
445 "same (this is a mail user agent; this is cool, fast, interfaces with PGP and "
446 "LDAP and IMAP, has features X, Y, and Z)."
449 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
450 #: best-pkging-practices.dbk:306
452 "If this package should not be installed directly, but is pulled in by "
453 "another package, this should be mentioned."
456 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
457 #: best-pkging-practices.dbk:312
459 "If the package is experimental, or there are other reasons it should not be "
460 "used, if there are other packages that should be used instead, it should be "
464 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
465 #: best-pkging-practices.dbk:319
467 "How is this package different from the competition? Is it a better "
468 "implementation? more features? different features? Why should I choose this "
472 # type: Content of: <chapter><section><section><title>
473 #: best-pkging-practices.dbk:332
474 msgid "Upstream home page"
477 # type: Content of: <chapter><section><section><para>
478 #: best-pkging-practices.dbk:334
480 "We recommend that you add the URL for the package's home page to the package "
481 "description in <filename>debian/control</filename>. This information should "
482 "be added at the end of description, using the following format:"
485 # type: Content of: <chapter><section><section><screen>
486 #: best-pkging-practices.dbk:339
490 " Homepage: http://some-project.some-place.org/"
493 # type: Content of: <chapter><section><section><para>
494 #: best-pkging-practices.dbk:343
496 "Note the spaces prepending the line, which serves to break the lines "
497 "correctly. To see an example of how this displays, see <ulink url=\"&url-eg-"
498 "desc-upstream-info;\"></ulink>."
501 # type: Content of: <chapter><section><section><para>
502 #: best-pkging-practices.dbk:348
504 "If there is no home page for the software, this should naturally be left out."
507 # type: Content of: <chapter><section><section><para>
508 #: best-pkging-practices.dbk:351
510 "Note that we expect this field will eventually be replaced by a proper "
511 "<filename>debian/control</filename> field understood by <command>dpkg</"
512 "command> and <literal>&packages-host;</literal>. If you don't want to "
513 "bother migrating the home page from the description to this field, you "
514 "should probably wait until that is available. Please make sure that this "
515 "line matches the regular expression <literal>/^ Homepage: [^ ]*$/</literal>, "
516 "as this allows <filename>&packages-host;</filename> to parse it correctly."
519 # type: Content of: <chapter><section><section><title>
520 #: best-pkging-practices.dbk:362
521 msgid "Version Control System location"
524 # type: Content of: <chapter><section><section><para>
525 #: best-pkging-practices.dbk:364
527 "There are additional fields for the location of the Version Control System "
528 "in <filename>debian/control</filename>."
531 # type: Content of: <chapter><section><section><section><title>
532 #: best-pkging-practices.dbk:368
533 msgid "XS-Vcs-Browser"
536 # type: Content of: <chapter><section><section><section><para>
537 #: best-pkging-practices.dbk:370
539 "Value of this field should be a <literal>http://</literal> URL pointing to a "
540 "web-browsable copy of the Version Control System repository used to maintain "
541 "the given package, if available."
544 # type: Content of: <chapter><section><section><section><para>
545 #: best-pkging-practices.dbk:375
547 "The information is meant to be useful for the final user, willing to browse "
548 "the latest work done on the package (e.g. when looking for the patch fixing "
549 "a bug tagged as <literal>pending</literal> in the bug tracking system)."
552 # type: Content of: <chapter><section><section><section><title>
553 #: best-pkging-practices.dbk:382
557 # type: Content of: <chapter><section><section><section><para>
558 #: best-pkging-practices.dbk:384
560 "Value of this field should be a string identifying unequivocally the "
561 "location of the Version Control System repository used to maintain the given "
562 "package, if available. <literal>*</literal> identify the Version Control "
563 "System; currently the following systems are supported by the package "
564 "tracking system: <literal>arch</literal>, <literal>bzr</literal> (Bazaar), "
565 "<literal>cvs</literal>, <literal>darcs</literal>, <literal>git</literal>, "
566 "<literal>hg</literal> (Mercurial), <literal>mtn</literal> (Monotone), "
567 "<literal>svn</literal> (Subversion). It is allowed to specify different VCS "
568 "fields for the same package: they will all be shown in the PTS web interface."
571 # type: Content of: <chapter><section><section><section><para>
572 #: best-pkging-practices.dbk:395
574 "The information is meant to be useful for a user knowledgeable in the given "
575 "Version Control System and willing to build the current version of a package "
576 "from the VCS sources. Other uses of this information might include "
577 "automatic building of the latest VCS version of the given package. To this "
578 "end the location pointed to by the field should better be version agnostic "
579 "and point to the main branch (for VCSs supporting such a concept). Also, "
580 "the location pointed to should be accessible to the final user; fulfilling "
581 "this requirement might imply pointing to an anonymous access of the "
582 "repository instead of pointing to an SSH-accessible version of the same."
585 # type: Content of: <chapter><section><section><section><para>
586 #: best-pkging-practices.dbk:406
588 "In the following example, an instance of the field for a Subversion "
589 "repository of the <systemitem role=\"package\">vim</systemitem> package is "
590 "shown. Note how the URL is in the <literal>svn://</literal> scheme (instead "
591 "of <literal>svn+ssh://</literal>) and how it points to the <filename>trunk/</"
592 "filename> branch. The use of the <literal>XS-Vcs-Browser</literal> field "
593 "described above is also shown."
596 # type: Content of: <chapter><section><section><section><screen>
597 #: best-pkging-practices.dbk:414
601 " Section: editors\n"
602 " Priority: optional\n"
604 " XS-Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim\n"
605 " XS-Vcs-Browser: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim"
608 # type: Content of: <chapter><section><title>
609 #: best-pkging-practices.dbk:428
610 msgid "Best practices for <filename>debian/changelog</filename>"
613 # type: Content of: <chapter><section><para>
614 #: best-pkging-practices.dbk:430
616 "The following practices supplement the <ulink url=\"&url-debian-policy;ch-"
617 "docs.html#s-changelogs\">Policy on changelog files</ulink>."
620 # type: Content of: <chapter><section><section><title>
621 #: best-pkging-practices.dbk:435
622 msgid "Writing useful changelog entries"
625 # type: Content of: <chapter><section><section><para>
626 #: best-pkging-practices.dbk:437
628 "The changelog entry for a package revision documents changes in that "
629 "revision, and only them. Concentrate on describing significant and user-"
630 "visible changes that were made since the last version."
633 # type: Content of: <chapter><section><section><para>
634 #: best-pkging-practices.dbk:442
636 "Focus on <emphasis>what</emphasis> was changed — who, how and when are "
637 "usually less important. Having said that, remember to politely attribute "
638 "people who have provided notable help in making the package (e.g., those who "
639 "have sent in patches)."
642 # type: Content of: <chapter><section><section><para>
643 #: best-pkging-practices.dbk:448
645 "There's no need to elaborate the trivial and obvious changes. You can also "
646 "aggregate several changes in one entry. On the other hand, don't be overly "
647 "terse if you have undertaken a major change. Be especially clear if there "
648 "are changes that affect the behaviour of the program. For further "
649 "explanations, use the <filename>README.Debian</filename> file."
652 # type: Content of: <chapter><section><section><para>
653 #: best-pkging-practices.dbk:455
655 "Use common English so that the majority of readers can comprehend it. Avoid "
656 "abbreviations, tech-speak and jargon when explaining changes that close "
657 "bugs, especially for bugs filed by users that did not strike you as "
658 "particularly technically savvy. Be polite, don't swear."
661 # type: Content of: <chapter><section><section><para>
662 #: best-pkging-practices.dbk:461
664 "It is sometimes desirable to prefix changelog entries with the names of the "
665 "files that were changed. However, there's no need to explicitly list each "
666 "and every last one of the changed files, especially if the change was small "
667 "or repetitive. You may use wildcards."
670 # type: Content of: <chapter><section><section><para>
671 #: best-pkging-practices.dbk:467
673 "When referring to bugs, don't assume anything. Say what the problem was, "
674 "how it was fixed, and append the closes: #nnnnn string. See <xref linkend="
675 "\"upload-bugfix\"/> for more information."
678 # type: Content of: <chapter><section><section><title>
679 #: best-pkging-practices.dbk:474
680 msgid "Common misconceptions about changelog entries"
683 # type: Content of: <chapter><section><section><para>
684 #: best-pkging-practices.dbk:476
686 "The changelog entries should <emphasis role=\"strong\">not</emphasis> "
687 "document generic packaging issues (Hey, if you're looking for foo.conf, it's "
688 "in /etc/blah/.), since administrators and users are supposed to be at least "
689 "remotely acquainted with how such things are generally arranged on Debian "
690 "systems. Do, however, mention if you change the location of a configuration "
694 # type: Content of: <chapter><section><section><para>
695 #: best-pkging-practices.dbk:484
697 "The only bugs closed with a changelog entry should be those that are "
698 "actually fixed in the same package revision. Closing unrelated bugs in the "
699 "changelog is bad practice. See <xref linkend=\"upload-bugfix\"/> ."
702 # type: Content of: <chapter><section><section><para>
703 #: best-pkging-practices.dbk:489
705 "The changelog entries should <emphasis role=\"strong\">not</emphasis> be "
706 "used for random discussion with bug reporters (I don't see segfaults when "
707 "starting foo with option bar; send in more info), general statements on "
708 "life, the universe and everything (sorry this upload took me so long, but I "
709 "caught the flu), or pleas for help (the bug list on this package is huge, "
710 "please lend me a hand). Such things usually won't be noticed by their "
711 "target audience, but may annoy people who wish to read information about "
712 "actual changes in the package. See <xref linkend=\"bug-answering\"/> for "
713 "more information on how to use the bug tracking system."
716 # type: Content of: <chapter><section><section><para>
717 #: best-pkging-practices.dbk:500
719 "It is an old tradition to acknowledge bugs fixed in non-maintainer uploads "
720 "in the first changelog entry of the proper maintainer upload. As we have "
721 "version tracking now, it is enough to keep the NMUed changelog entries and "
722 "just mention this fact in your own changelog entry."
725 # type: Content of: <chapter><section><section><title>
726 #: best-pkging-practices.dbk:508
727 msgid "Common errors in changelog entries"
730 # type: Content of: <chapter><section><section><para>
731 #: best-pkging-practices.dbk:510
733 "The following examples demonstrate some common errors or examples of bad "
734 "style in changelog entries."
737 # type: Content of: <chapter><section><section><screen>
738 #: best-pkging-practices.dbk:514
740 msgid "* Fixed all outstanding bugs."
743 # type: Content of: <chapter><section><section><para>
744 #: best-pkging-practices.dbk:517
745 msgid "This doesn't tell readers anything too useful, obviously."
748 # type: Content of: <chapter><section><section><screen>
749 #: best-pkging-practices.dbk:520
751 msgid "* Applied patch from Jane Random."
754 # type: Content of: <chapter><section><section><para>
755 #: best-pkging-practices.dbk:523
756 msgid "What was the patch about?"
759 # type: Content of: <chapter><section><section><screen>
760 #: best-pkging-practices.dbk:526
762 msgid "* Late night install target overhaul."
765 # type: Content of: <chapter><section><section><para>
766 #: best-pkging-practices.dbk:529
768 "Overhaul which accomplished what? Is the mention of late night supposed to "
769 "remind us that we shouldn't trust that code?"
772 # type: Content of: <chapter><section><section><screen>
773 #: best-pkging-practices.dbk:533
775 msgid "* Fix vsync FU w/ ancient CRTs."
778 # type: Content of: <chapter><section><section><para>
779 #: best-pkging-practices.dbk:536
781 "Too many acronyms, and it's not overly clear what the, uh, fsckup (oops, a "
782 "curse word!) was actually about, or how it was fixed."
785 # type: Content of: <chapter><section><section><screen>
786 #: best-pkging-practices.dbk:540
788 msgid "* This is not a bug, closes: #nnnnnn."
791 # type: Content of: <chapter><section><section><para>
792 #: best-pkging-practices.dbk:543
794 "First of all, there's absolutely no need to upload the package to convey "
795 "this information; instead, use the bug tracking system. Secondly, there's "
796 "no explanation as to why the report is not a bug."
799 # type: Content of: <chapter><section><section><screen>
800 #: best-pkging-practices.dbk:548
802 msgid "* Has been fixed for ages, but I forgot to close; closes: #54321."
805 # type: Content of: <chapter><section><section><para>
806 #: best-pkging-practices.dbk:551
808 "If for some reason you didn't mention the bug number in a previous changelog "
809 "entry, there's no problem, just close the bug normally in the BTS. There's "
810 "no need to touch the changelog file, presuming the description of the fix is "
811 "already in (this applies to the fixes by the upstream authors/maintainers as "
812 "well, you don't have to track bugs that they fixed ages ago in your "
816 # type: Content of: <chapter><section><section><screen>
817 #: best-pkging-practices.dbk:558
819 msgid "* Closes: #12345, #12346, #15432"
822 # type: Content of: <chapter><section><section><para>
823 #: best-pkging-practices.dbk:561
825 "Where's the description? If you can't think of a descriptive message, start "
826 "by inserting the title of each different bug."
829 # type: Content of: <chapter><section><section><title>
830 #: best-pkging-practices.dbk:567
831 msgid "Supplementing changelogs with NEWS.Debian files"
834 # type: Content of: <chapter><section><section><para>
835 #: best-pkging-practices.dbk:569
837 "Important news about changes in a package can also be put in NEWS.Debian "
838 "files. The news will be displayed by tools like apt-listchanges, before all "
839 "the rest of the changelogs. This is the preferred means to let the user "
840 "know about significant changes in a package. It is better than using "
841 "debconf notes since it is less annoying and the user can go back and refer "
842 "to the NEWS.Debian file after the install. And it's better than listing "
843 "major changes in README.Debian, since the user can easily miss such notes."
846 # type: Content of: <chapter><section><section><para>
847 #: best-pkging-practices.dbk:578
849 "The file format is the same as a debian changelog file, but leave off the "
850 "asterisks and describe each news item with a full paragraph when necessary "
851 "rather than the more concise summaries that would go in a changelog. It's a "
852 "good idea to run your file through dpkg-parsechangelog to check its "
853 "formatting as it will not be automatically checked during build as the "
854 "changelog is. Here is an example of a real NEWS.Debian file:"
857 # type: Content of: <chapter><section><section><screen>
858 #: best-pkging-practices.dbk:586
861 "cron (3.0pl1-74) unstable; urgency=low\n"
863 " The checksecurity script is no longer included with the cron package:\n"
864 " it now has its own package, checksecurity. If you liked the\n"
865 " functionality provided with that script, please install the new\n"
868 " -- Steve Greenland <stevegr@debian.org> Sat, 6 Sep 2003 17:15:03 -0500"
871 # type: Content of: <chapter><section><section><para>
872 #: best-pkging-practices.dbk:596
874 "The NEWS.Debian file is installed as /usr/share/doc/<package>/NEWS."
875 "Debian.gz. It is compressed, and always has that name even in Debian native "
876 "packages. If you use debhelper, dh_installchangelogs will install debian/"
877 "NEWS files for you."
880 # type: Content of: <chapter><section><section><para>
881 #: best-pkging-practices.dbk:602
883 "Unlike changelog files, you need not update NEWS.Debian files with every "
884 "release. Only update them if you have something particularly newsworthy "
885 "that user should know about. If you have no news at all, there's no need to "
886 "ship a NEWS.Debian file in your package. No news is good news!"
889 # type: Content of: <chapter><section><title>
890 #: best-pkging-practices.dbk:623
891 msgid "Best practices for maintainer scripts"
894 # type: Content of: <chapter><section><para>
895 #: best-pkging-practices.dbk:625
897 "Maintainer scripts include the files <filename>debian/postinst</filename>, "
898 "<filename>debian/preinst</filename>, <filename>debian/prerm</filename> and "
899 "<filename>debian/postrm</filename>. These scripts take care of any package "
900 "installation or deinstallation setup which isn't handled merely by the "
901 "creation or removal of files and directories. The following instructions "
902 "supplement the <ulink url=\"&url-debian-policy;\">Debian Policy</ulink>."
905 # type: Content of: <chapter><section><para>
906 #: best-pkging-practices.dbk:633
908 "Maintainer scripts must be idempotent. That means that you need to make "
909 "sure nothing bad will happen if the script is called twice where it would "
910 "usually be called once."
913 # type: Content of: <chapter><section><para>
914 #: best-pkging-practices.dbk:638
916 "Standard input and output may be redirected (e.g. into pipes) for logging "
917 "purposes, so don't rely on them being a tty."
920 # type: Content of: <chapter><section><para>
921 #: best-pkging-practices.dbk:642
923 "All prompting or interactive configuration should be kept to a minimum. "
924 "When it is necessary, you should use the <systemitem role=\"package"
925 "\">debconf</systemitem> package for the interface. Remember that prompting "
926 "in any case can only be in the <literal>configure</literal> stage of the "
927 "<filename>postinst</filename> script."
930 # type: Content of: <chapter><section><para>
931 #: best-pkging-practices.dbk:649
933 "Keep the maintainer scripts as simple as possible. We suggest you use pure "
934 "POSIX shell scripts. Remember, if you do need any bash features, the "
935 "maintainer script must have a bash shebang line. POSIX shell or Bash are "
936 "preferred to Perl, since they enable <systemitem role=\"package\">debhelper</"
937 "systemitem> to easily add bits to the scripts."
940 # type: Content of: <chapter><section><para>
941 #: best-pkging-practices.dbk:656
943 "If you change your maintainer scripts, be sure to test package removal, "
944 "double installation, and purging. Be sure that a purged package is "
945 "completely gone, that is, it must remove any files created, directly or "
946 "indirectly, in any maintainer script."
949 # type: Content of: <chapter><section><para>
950 #: best-pkging-practices.dbk:662
952 "If you need to check for the existence of a command, you should use "
956 # type: Content of: <chapter><section><programlisting>
957 #: best-pkging-practices.dbk:665
959 msgid "if [ -x /usr/sbin/install-docs ]; then ..."
962 # type: Content of: <chapter><section><para>
963 #: best-pkging-practices.dbk:667
965 "If you don't wish to hard-code the path of a command in your maintainer "
966 "script, the following POSIX-compliant shell function may help:"
969 # type: Content of: <chapter><section><para>
970 #: best-pkging-practices.dbk:672
972 "You can use this function to search <literal>$PATH</literal> for a command "
973 "name, passed as an argument. It returns true (zero) if the command was "
974 "found, and false if not. This is really the most portable way, since "
975 "<literal>command -v</literal>, <command>type</command>, and <command>which</"
976 "command> are not POSIX."
979 # type: Content of: <chapter><section><para>
980 #: best-pkging-practices.dbk:679
982 "While <command>which</command> is an acceptable alternative, since it is "
983 "from the required <systemitem role=\"package\">debianutils</systemitem> "
984 "package, it's not on the root partition. That is, it's in <filename>/usr/"
985 "bin</filename> rather than <filename>/bin</filename>, so one can't use it in "
986 "scripts which are run before the <filename>/usr</filename> partition is "
987 "mounted. Most scripts won't have this problem, though."
990 # type: Content of: <chapter><section><title>
991 #: best-pkging-practices.dbk:689
993 "Configuration management with <systemitem role=\"package\">debconf</"
997 # type: Content of: <chapter><section><para>
998 #: best-pkging-practices.dbk:691
1000 "<systemitem role=\"package\">Debconf</systemitem> is a configuration "
1001 "management system which can be used by all the various packaging scripts "
1002 "(<filename>postinst</filename> mainly) to request feedback from the user "
1003 "concerning how to configure the package. Direct user interactions must now "
1004 "be avoided in favor of <systemitem role=\"package\">debconf</systemitem> "
1005 "interaction. This will enable non-interactive installations in the future."
1008 # type: Content of: <chapter><section><para>
1009 #: best-pkging-practices.dbk:699
1011 "Debconf is a great tool but it is often poorly used. Many common mistakes "
1012 "are listed in the <citerefentry> <refentrytitle>debconf-devel</"
1013 "refentrytitle> <manvolnum>7</manvolnum> </citerefentry> man page. It is "
1014 "something that you must read if you decide to use debconf. Also, we "
1015 "document some best practices here."
1018 # type: Content of: <chapter><section><para>
1019 #: best-pkging-practices.dbk:706
1021 "These guidelines include some writing style and typography recommendations, "
1022 "general considerations about debconf usage as well as more specific "
1023 "recommendations for some parts of the distribution (the installation system "
1027 # type: Content of: <chapter><section><section><title>
1028 #: best-pkging-practices.dbk:712
1029 msgid "Do not abuse debconf"
1032 # type: Content of: <chapter><section><section><para>
1033 #: best-pkging-practices.dbk:714
1035 "Since debconf appeared in Debian, it has been widely abused and several "
1036 "criticisms received by the Debian distribution come from debconf abuse with "
1037 "the need of answering a wide bunch of questions before getting any little "
1041 # type: Content of: <chapter><section><section><para>
1042 #: best-pkging-practices.dbk:720
1044 "Keep usage notes to what they belong: the NEWS.Debian, or README.Debian "
1045 "file. Only use notes for important notes which may directly affect the "
1046 "package usability. Remember that notes will always block the install until "
1047 "confirmed or bother the user by email."
1050 # type: Content of: <chapter><section><section><para>
1051 #: best-pkging-practices.dbk:726
1053 "Carefully choose the questions priorities in maintainer scripts. See "
1054 "<citerefentry> <refentrytitle>debconf-devel</refentrytitle> <manvolnum>7</"
1055 "manvolnum> </citerefentry> for details about priorities. Most questions "
1056 "should use medium and low priorities."
1059 # type: Content of: <chapter><section><section><title>
1060 #: best-pkging-practices.dbk:734
1061 msgid "General recommendations for authors and translators"
1064 # type: Content of: <chapter><section><section><section><title>
1065 #: best-pkging-practices.dbk:736
1066 msgid "Write correct English"
1069 # type: Content of: <chapter><section><section><section><para>
1070 #: best-pkging-practices.dbk:738
1072 "Most Debian package maintainers are not native English speakers. So, "
1073 "writing properly phrased templates may not be easy for them."
1076 # type: Content of: <chapter><section><section><section><para>
1077 #: best-pkging-practices.dbk:742
1079 "Please use (and abuse) &email-debian-l10n-english; mailing list. Have your "
1080 "templates proofread."
1083 # type: Content of: <chapter><section><section><section><para>
1084 #: best-pkging-practices.dbk:746
1086 "Badly written templates give a poor image of your package, of your work...or "
1087 "even of Debian itself."
1090 # type: Content of: <chapter><section><section><section><para>
1091 #: best-pkging-practices.dbk:750
1093 "Avoid technical jargon as much as possible. If some terms sound common to "
1094 "you, they may be impossible to understand for others. If you cannot avoid "
1095 "them, try to explain them (use the extended description). When doing so, "
1096 "try to balance between verbosity and simplicity."
1099 # type: Content of: <chapter><section><section><section><title>
1100 #: best-pkging-practices.dbk:758
1101 msgid "Be kind to translators"
1104 # type: Content of: <chapter><section><section><section><para>
1105 #: best-pkging-practices.dbk:760
1107 "Debconf templates may be translated. Debconf, along with its sister package "
1108 "<command>po-debconf</command> offers a simple framework for getting "
1109 "templates translated by translation teams or even individuals."
1112 # type: Content of: <chapter><section><section><section><para>
1113 #: best-pkging-practices.dbk:765
1115 "Please use gettext-based templates. Install <systemitem role=\"package\">po-"
1116 "debconf</systemitem> on your development system and read its documentation "
1117 "(man po-debconf is a good start)."
1120 # type: Content of: <chapter><section><section><section><para>
1121 #: best-pkging-practices.dbk:770
1123 "Avoid changing templates too often. Changing templates text induces more "
1124 "work to translators which will get their translation fuzzied. If you plan "
1125 "changes to your original templates, please contact translators. Most active "
1126 "translators are very responsive and getting their work included along with "
1127 "your modified templates will save you additional uploads. If you use "
1128 "gettext-based templates, the translator's name and e-mail addresses are "
1129 "mentioned in the po files headers."
1132 # type: Content of: <chapter><section><section><section><para>
1133 #: best-pkging-practices.dbk:779
1135 "The use of the <command>podebconf-report-po</command> from the po-debconf "
1136 "package is highly recommended to warn translators which have incomplete "
1137 "translations and request them for updates."
1140 # type: Content of: <chapter><section><section><section><para>
1141 #: best-pkging-practices.dbk:784
1143 "If in doubt, you may also contact the translation team for a given language "
1144 "(debian-l10n-xxxxx@&lists-host;), or the &email-debian-i18n; mailing list."
1147 # type: Content of: <chapter><section><section><section><para>
1148 #: best-pkging-practices.dbk:789
1150 "Calls for translations posted to &email-debian-i18n; with the "
1151 "<filename>debian/po/templates.pot</filename> file attached or referenced in "
1152 "a URL are encouraged. Be sure to mentions in these calls for new "
1153 "translations which languages you have existing translations for, in order to "
1154 "avoid duplicate work."
1157 # type: Content of: <chapter><section><section><section><title>
1158 #: best-pkging-practices.dbk:798
1159 msgid "Unfuzzy complete translations when correcting typos and spelling"
1162 # type: Content of: <chapter><section><section><section><para>
1163 #: best-pkging-practices.dbk:800
1165 "When the text of a debconf template is corrected and you are <emphasis role="
1166 "\"strong\">sure</emphasis> that the change does <emphasis role=\"strong"
1167 "\">not</emphasis> affect translations, please be kind to translators and "
1168 "unfuzzy their translations."
1171 # type: Content of: <chapter><section><section><section><para>
1172 #: best-pkging-practices.dbk:806
1174 "If you don't do so, the whole template will not be translated as long as a "
1175 "translator will send you an update."
1178 # type: Content of: <chapter><section><section><section><para>
1179 #: best-pkging-practices.dbk:810
1181 "To <emphasis role=\"strong\">unfuzzy</emphasis> translations, you can "
1182 "proceed the following way:"
1185 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1186 #: best-pkging-practices.dbk:816
1188 "Put all incomplete PO files out of the way. You can check the completeness "
1189 "by using (needs the <systemitem role=\"package\">gettext</systemitem> "
1190 "package installed):"
1193 # type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1194 #: best-pkging-practices.dbk:820
1197 "for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null\n"
1198 "--statistics $i; done"
1201 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1202 #: best-pkging-practices.dbk:825
1204 "move all files which report either fuzzy strings to a temporary place. "
1205 "Files which report no fuzzy strings (only translated and untranslated) will "
1209 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1210 #: best-pkging-practices.dbk:832
1212 "now <emphasis role=\"strong\">and now only</emphasis>, modify the template "
1213 "for the typos and check again that translation are not impacted (typos, "
1214 "spelling errors, sometimes typographical corrections are usually OK)"
1217 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1218 #: best-pkging-practices.dbk:839
1220 "run <command>debconf-updatepo</command>. This will fuzzy all strings you "
1221 "modified in translations. You can see this by running the above again"
1224 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1225 #: best-pkging-practices.dbk:845
1226 msgid "use the following command:"
1229 # type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1230 #: best-pkging-practices.dbk:847
1232 msgid "for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done"
1235 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1236 #: best-pkging-practices.dbk:851
1238 "move back to debian/po the files which showed fuzzy strings in the first step"
1241 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1242 #: best-pkging-practices.dbk:856
1243 msgid "run <command>debconf-updatepo</command> again"
1246 # type: Content of: <chapter><section><section><section><title>
1247 #: best-pkging-practices.dbk:863
1248 msgid "Do not make assumptions about interfaces"
1251 # type: Content of: <chapter><section><section><section><para>
1252 #: best-pkging-practices.dbk:865
1254 "Templates text should not make reference to widgets belonging to some "
1255 "debconf interfaces. Sentences like If you answer Yes... have no meaning "
1256 "for users of graphical interfaces which use checkboxes for boolean questions."
1259 # type: Content of: <chapter><section><section><section><para>
1260 #: best-pkging-practices.dbk:870
1262 "String templates should also avoid mentioning the default values in their "
1263 "description. First, because this is redundant with the values seen by the "
1264 "users. Also, because these default values may be different from the "
1265 "maintainer choices (for instance, when the debconf database was preseeded)."
1268 # type: Content of: <chapter><section><section><section><para>
1269 #: best-pkging-practices.dbk:876
1271 "More generally speaking, try to avoid referring to user actions. Just give "
1275 # type: Content of: <chapter><section><section><section><title>
1276 #: best-pkging-practices.dbk:882
1277 msgid "Do not use first person"
1280 # type: Content of: <chapter><section><section><section><para>
1281 #: best-pkging-practices.dbk:884
1283 "You should avoid the use of first person (I will do this... or We "
1284 "recommend...). The computer is not a person and the Debconf templates do "
1285 "not speak for the Debian developers. You should use neutral construction. "
1286 "Those of you who already wrote scientific publications, just write your "
1287 "templates like you would write a scientific paper. However, try using "
1288 "action voice if still possible, like Enable this if ... instead of This can "
1289 "be enabled if ...."
1292 # type: Content of: <chapter><section><section><section><title>
1293 #: best-pkging-practices.dbk:894
1294 msgid "Be gender neutral"
1297 # type: Content of: <chapter><section><section><section><para>
1298 #: best-pkging-practices.dbk:896
1300 "The world is made of men and women. Please use gender-neutral constructions "
1304 # type: Content of: <chapter><section><section><title>
1305 #: best-pkging-practices.dbk:904
1306 msgid "Templates fields definition"
1309 # type: Content of: <chapter><section><section><para>
1310 #: best-pkging-practices.dbk:906
1312 "This part gives some information which is mostly taken from the "
1313 "<citerefentry> <refentrytitle>debconf-devel</refentrytitle> <manvolnum>7</"
1314 "manvolnum> </citerefentry> manual page."
1317 # type: Content of: <chapter><section><section><section><title>
1318 #: best-pkging-practices.dbk:911
1322 # type: Content of: <chapter><section><section><section><section><title>
1323 #: best-pkging-practices.dbk:913
1327 # type: Content of: <chapter><section><section><section><section><para>
1328 #: best-pkging-practices.dbk:915
1330 "Results in a free-form input field that the user can type any string into."
1333 # type: Content of: <chapter><section><section><section><section><title>
1334 #: best-pkging-practices.dbk:920
1338 # type: Content of: <chapter><section><section><section><section><para>
1339 #: best-pkging-practices.dbk:922
1341 "Prompts the user for a password. Use this with caution; be aware that the "
1342 "password the user enters will be written to debconf's database. You should "
1343 "probably clean that value out of the database as soon as is possible."
1346 # type: Content of: <chapter><section><section><section><section><title>
1347 #: best-pkging-practices.dbk:929
1351 # type: Content of: <chapter><section><section><section><section><para>
1352 #: best-pkging-practices.dbk:931
1354 "A true/false choice. Remember: true/false, <emphasis role=\"strong\">not "
1355 "yes/no</emphasis>..."
1358 # type: Content of: <chapter><section><section><section><section><title>
1359 #: best-pkging-practices.dbk:937
1363 # type: Content of: <chapter><section><section><section><section><para>
1364 #: best-pkging-practices.dbk:939
1366 "A choice between one of a number of values. The choices must be specified "
1367 "in a field named 'Choices'. Separate the possible values with commas and "
1368 "spaces, like this: Choices: yes, no, maybe"
1371 # type: Content of: <chapter><section><section><section><section><title>
1372 #: best-pkging-practices.dbk:946
1373 msgid "multiselect:"
1376 # type: Content of: <chapter><section><section><section><section><para>
1377 #: best-pkging-practices.dbk:948
1379 "Like the select data type, except the user can choose any number of items "
1380 "from the choices list (or chose none of them)."
1383 # type: Content of: <chapter><section><section><section><section><title>
1384 #: best-pkging-practices.dbk:954
1388 # type: Content of: <chapter><section><section><section><section><para>
1389 #: best-pkging-practices.dbk:956
1391 "Rather than being a question per se, this datatype indicates a note that can "
1392 "be displayed to the user. It should be used only for important notes that "
1393 "the user really should see, since debconf will go to great pains to make "
1394 "sure the user sees it; halting the install for them to press a key, and even "
1395 "mailing the note to them in some cases."
1398 # type: Content of: <chapter><section><section><section><section><title>
1399 #: best-pkging-practices.dbk:965
1403 # type: Content of: <chapter><section><section><section><section><para>
1404 #: best-pkging-practices.dbk:967
1405 msgid "This type is now considered obsolete: don't use it."
1408 # type: Content of: <chapter><section><section><section><section><title>
1409 #: best-pkging-practices.dbk:972
1413 # type: Content of: <chapter><section><section><section><section><para>
1414 #: best-pkging-practices.dbk:974
1416 "This type is designed to handle error messages. It is mostly similar to the "
1417 "note type. Frontends may present it differently (for instance, the dialog "
1418 "frontend of cdebconf draws a red screen instead of the usual blue one)."
1421 # type: Content of: <chapter><section><section><section><section><para>
1422 #: best-pkging-practices.dbk:979
1424 "It is recommended to use this type for any message that needs user attention "
1425 "for a correction of any kind."
1428 # type: Content of: <chapter><section><section><section><title>
1429 #: best-pkging-practices.dbk:987
1430 msgid "Description: short and extended description"
1433 # type: Content of: <chapter><section><section><section><para>
1434 #: best-pkging-practices.dbk:989
1436 "Template descriptions have two parts: short and extended. The short "
1437 "description is in the Description: line of the template."
1440 # type: Content of: <chapter><section><section><section><para>
1441 #: best-pkging-practices.dbk:993
1443 "The short description should be kept short (50 characters or so) so that it "
1444 "may be accomodated by most debconf interfaces. Keeping it short also helps "
1445 "translators, as usually translations tend to end up being longer than the "
1449 # type: Content of: <chapter><section><section><section><para>
1450 #: best-pkging-practices.dbk:999
1452 "The short description should be able to stand on its own. Some interfaces "
1453 "do not show the long description by default, or only if the user explicitely "
1454 "asks for it or even do not show it at all. Avoid things like What do you "
1458 # type: Content of: <chapter><section><section><section><para>
1459 #: best-pkging-practices.dbk:1005
1461 "The short description does not necessarily have to be a full sentence. This "
1462 "is part of the keep it short and efficient recommendation."
1465 # type: Content of: <chapter><section><section><section><para>
1466 #: best-pkging-practices.dbk:1009
1468 "The extended description should not repeat the short description word for "
1469 "word. If you can't think up a long description, then first, think some "
1470 "more. Post to debian-devel. Ask for help. Take a writing class! That "
1471 "extended description is important. If after all that you still can't come "
1472 "up with anything, leave it blank."
1475 # type: Content of: <chapter><section><section><section><para>
1476 #: best-pkging-practices.dbk:1016
1478 "The extended description should use complete sentences. Paragraphs should "
1479 "be kept short for improved readability. Do not mix two ideas in the same "
1480 "paragraph but rather use another paragraph."
1483 # type: Content of: <chapter><section><section><section><para>
1484 #: best-pkging-practices.dbk:1021
1486 "Don't be too verbose. User tend to ignore too long screens. 20 lines are "
1487 "by experience a border you shouldn't cross, because that means that in the "
1488 "classical dialog interface, people will need to scroll, and lot of people "
1489 "just don't do that."
1492 # type: Content of: <chapter><section><section><section><para>
1493 #: best-pkging-practices.dbk:1027
1495 "The extended description should <emphasis role=\"strong\">never</emphasis> "
1496 "include a question."
1499 # type: Content of: <chapter><section><section><section><para>
1500 #: best-pkging-practices.dbk:1031
1502 "For specific rules depending on templates type (string, boolean, etc.), "
1503 "please read below."
1506 # type: Content of: <chapter><section><section><section><title>
1507 #: best-pkging-practices.dbk:1037
1511 # type: Content of: <chapter><section><section><section><para>
1512 #: best-pkging-practices.dbk:1039
1514 "This field should be used for Select and Multiselect types. It contains the "
1515 "possible choices which will be presented to users. These choices should be "
1516 "separated by commas."
1519 # type: Content of: <chapter><section><section><section><title>
1520 #: best-pkging-practices.dbk:1046
1524 # type: Content of: <chapter><section><section><section><para>
1525 #: best-pkging-practices.dbk:1048
1527 "This field is optional. It contains the default answer for string, select "
1528 "and multiselect templates. For multiselect templates, it may contain a "
1529 "comma-separated list of choices."
1532 # type: Content of: <chapter><section><section><title>
1533 #: best-pkging-practices.dbk:1057
1534 msgid "Templates fields specific style guide"
1537 # type: Content of: <chapter><section><section><section><title>
1538 #: best-pkging-practices.dbk:1059
1542 # type: Content of: <chapter><section><section><section><para>
1543 #: best-pkging-practices.dbk:1061
1545 "No specific indication except: use the appropriate type by referring to the "
1549 # type: Content of: <chapter><section><section><section><title>
1550 #: best-pkging-practices.dbk:1067
1551 msgid "Description field"
1554 # type: Content of: <chapter><section><section><section><para>
1555 #: best-pkging-practices.dbk:1069
1557 "Below are specific instructions for properly writing the Description (short "
1558 "and extended) depending on the template type."
1561 # type: Content of: <chapter><section><section><section><section><title>
1562 #: best-pkging-practices.dbk:1073
1563 msgid "String/password templates"
1566 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1567 #: best-pkging-practices.dbk:1077
1569 "The short description is a prompt and <emphasis role=\"strong\">not</"
1570 "emphasis> a title. Avoid question style prompts (IP Address?) in favour of "
1571 "opened prompts (IP address:). The use of colons is recommended."
1574 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1575 #: best-pkging-practices.dbk:1084
1577 "The extended description is a complement to the short description. In the "
1578 "extended part, explain what is being asked, rather than ask the same "
1579 "question again using longer words. Use complete sentences. Terse writing "
1580 "style is strongly discouraged."
1583 # type: Content of: <chapter><section><section><section><section><title>
1584 #: best-pkging-practices.dbk:1094
1585 msgid "Boolean templates"
1588 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1589 #: best-pkging-practices.dbk:1098
1591 "The short description should be phrased in the form of a question which "
1592 "should be kept short and should generally end with a question mark. Terse "
1593 "writing style is permitted and even encouraged if the question is rather "
1594 "long (remember that translations are often longer than original versions)"
1597 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1598 #: best-pkging-practices.dbk:1106
1600 "Again, please avoid referring to specific interface widgets. A common "
1601 "mistake for such templates is if you answer Yes-type constructions."
1604 # type: Content of: <chapter><section><section><section><section><title>
1605 #: best-pkging-practices.dbk:1114
1606 msgid "Select/Multiselect"
1609 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1610 #: best-pkging-practices.dbk:1118
1612 "The short description is a prompt and <emphasis role=\"strong\">not</"
1613 "emphasis> a title. Do <emphasis role=\"strong\">not</emphasis> use useless "
1614 "Please choose... constructions. Users are clever enough to figure out they "
1615 "have to choose something...:)"
1618 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1619 #: best-pkging-practices.dbk:1126
1621 "The extended description will complete the short description. It may refer "
1622 "to the available choices. It may also mention that the user may choose more "
1623 "than one of the available choices, if the template is a multiselect one "
1624 "(although the interface often makes this clear)."
1627 # type: Content of: <chapter><section><section><section><section><title>
1628 #: best-pkging-practices.dbk:1136
1632 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1633 #: best-pkging-practices.dbk:1140
1634 msgid "The short description should be considered to be a *title*."
1637 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1638 #: best-pkging-practices.dbk:1145
1640 "The extended description is what will be displayed as a more detailed "
1641 "explanation of the note. Phrases, no terse writing style."
1644 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1645 #: best-pkging-practices.dbk:1151
1647 "<emphasis role=\"strong\">Do not abuse debconf.</emphasis> Notes are the "
1648 "most common way to abuse debconf. As written in debconf-devel manual page: "
1649 "it's best to use them only for warning about very serious problems. The "
1650 "NEWS.Debian or README.Debian files are the appropriate location for a lot of "
1651 "notes. If, by reading this, you consider converting your Note type "
1652 "templates to entries in NEWS/Debian or README.Debian, plus consider keeping "
1653 "existing translations for the future."
1656 # type: Content of: <chapter><section><section><section><title>
1657 #: best-pkging-practices.dbk:1166
1658 msgid "Choices field"
1661 # type: Content of: <chapter><section><section><section><para>
1662 #: best-pkging-practices.dbk:1168
1664 "If the Choices are likely to change often, please consider using the "
1665 "__Choices trick. This will split each individual choice into a single "
1666 "string, which will considerably help translators for doing their work."
1669 # type: Content of: <chapter><section><section><section><title>
1670 #: best-pkging-practices.dbk:1175 best-pkging-practices.dbk:1213
1671 msgid "Default field"
1674 # type: Content of: <chapter><section><section><section><para>
1675 #: best-pkging-practices.dbk:1177
1677 "If the default value, for a select template, is likely to vary depending on "
1678 "the user language (for instance, if the choice is a language choice), please "
1679 "use the _DefaultChoice trick."
1682 # type: Content of: <chapter><section><section><section><para>
1683 #: best-pkging-practices.dbk:1182
1685 "This special field allow translators to put the most appropriate choice "
1686 "according to their own language. It will become the default choice when "
1687 "their language is used while your own mentioned Default Choice will be used "
1688 "chan using English."
1691 # type: Content of: <chapter><section><section><section><para>
1692 #: best-pkging-practices.dbk:1188
1693 msgid "Example, taken from the geneweb package templates:"
1696 # type: Content of: <chapter><section><section><section><screen>
1697 #: best-pkging-practices.dbk:1191
1700 "Template: geneweb/lang\n"
1702 "__Choices: Afrikaans (af), Bulgarian (bg), Catalan (ca), Chinese (zh), Czech (cs), Danish (da), Dutch (nl), English (en), Esperanto (eo), Estonian (et), Finnish (fi), French (fr), German (de), Hebrew (he), Icelandic (is), Italian (it), Latvian (lv), Norwegian (no), Polish (pl), Portuguese (pt), Romanian (ro), Russian (ru), Spanish (es), Swedish (sv)\n"
1703 "# This is the default choice. Translators may put their own language here\n"
1704 "# instead of the default.\n"
1705 "# WARNING : you MUST use the ENGLISH FORM of your language\n"
1706 "# For instance, the french translator will need to put French (fr) here.\n"
1707 "_DefaultChoice: English (en)[ translators, please see comment in PO files]\n"
1708 "_Description: Geneweb default language:"
1711 # type: Content of: <chapter><section><section><section><para>
1712 #: best-pkging-practices.dbk:1202
1714 "Note the use of brackets which allow internal comments in debconf fields. "
1715 "Also note the use of comments which will show up in files the translators "
1719 # type: Content of: <chapter><section><section><section><para>
1720 #: best-pkging-practices.dbk:1207
1722 "The comments are needed as the DefaultChoice trick is a bit confusing: the "
1723 "translators may put their own choice"
1726 # type: Content of: <chapter><section><section><section><para>
1727 #: best-pkging-practices.dbk:1215
1729 "Do NOT use empty default field. If you don't want to use default values, do "
1730 "not use Default at all."
1733 # type: Content of: <chapter><section><section><section><para>
1734 #: best-pkging-practices.dbk:1219
1736 "If you use po-debconf (and you <emphasis role=\"strong\">should</emphasis>, "
1737 "see 2.2), consider making this field translatable, if you think it may be "
1741 # type: Content of: <chapter><section><section><section><para>
1742 #: best-pkging-practices.dbk:1224
1744 "If the default value may vary depending on language/country (for instance "
1745 "the default value for a language choice), consider using the special "
1746 "_DefaultChoice type documented in <citerefentry> <refentrytitle>po-debconf</"
1747 "refentrytitle> <manvolnum>7</manvolnum> </citerefentry>)."
1750 # type: Content of: <chapter><section><title>
1751 #: best-pkging-practices.dbk:1236
1752 msgid "Internationalization"
1755 # type: Content of: <chapter><section><section><title>
1756 #: best-pkging-practices.dbk:1238
1757 msgid "Handling debconf translations"
1760 # type: Content of: <chapter><section><section><para>
1761 #: best-pkging-practices.dbk:1240
1763 "Like porters, translators have a difficult task. They work on many packages "
1764 "and must collaborate with many different maintainers. Moreover, most of the "
1765 "time, they are not native English speakers, so you may need to be "
1766 "particularly patient with them."
1769 # type: Content of: <chapter><section><section><para>
1770 #: best-pkging-practices.dbk:1246
1772 "The goal of <systemitem role=\"package\">debconf</systemitem> was to make "
1773 "packages configuration easier for maintainers and for users. Originally, "
1774 "translation of debconf templates was handled with <command>debconf-"
1775 "mergetemplate</command>. However, that technique is now deprecated; the "
1776 "best way to accomplish <systemitem role=\"package\">debconf</systemitem> "
1777 "internationalization is by using the <systemitem role=\"package\">po-"
1778 "debconf</systemitem> package. This method is easier both for maintainer and "
1779 "translators; transition scripts are provided."
1782 # type: Content of: <chapter><section><section><para>
1783 #: best-pkging-practices.dbk:1256
1785 "Using <systemitem role=\"package\">po-debconf</systemitem>, the translation "
1786 "is stored in <filename>po</filename> files (drawing from <command>gettext</"
1787 "command> translation techniques). Special template files contain the "
1788 "original messages and mark which fields are translatable. When you change "
1789 "the value of a translatable field, by calling <command>debconf-updatepo</"
1790 "command>, the translation is marked as needing attention from the "
1791 "translators. Then, at build time, the <command>dh_installdebconf</command> "
1792 "program takes care of all the needed magic to add the template along with "
1793 "the up-to-date translations into the binary packages. Refer to the "
1794 "<citerefentry> <refentrytitle>po-debconf</refentrytitle> <manvolnum>7</"
1795 "manvolnum> </citerefentry> manual page for details."
1798 # type: Content of: <chapter><section><section><title>
1799 #: best-pkging-practices.dbk:1272
1800 msgid "Internationalized documentation"
1803 # type: Content of: <chapter><section><section><para>
1804 #: best-pkging-practices.dbk:1274
1806 "Internationalizing documentation is crucial for users, but a lot of labor. "
1807 "There's no way to eliminate all that work, but you can make things easier "
1811 # type: Content of: <chapter><section><section><para>
1812 #: best-pkging-practices.dbk:1279
1814 "If you maintain documentation of any size, its easier for translators if "
1815 "they have access to a source control system. That lets translators see the "
1816 "differences between two versions of the documentation, so, for instance, "
1817 "they can see what needs to be retranslated. It is recommended that the "
1818 "translated documentation maintain a note about what source control revision "
1819 "the translation is based on. An interesting system is provided by <ulink "
1820 "url=\"&url-i18n-doc-check;\">doc-check</ulink> in the <systemitem role="
1821 "\"package\">boot-floppies</systemitem> package, which shows an overview of "
1822 "the translation status for any given language, using structured comments for "
1823 "the current revision of the file to be translated and, for a translated "
1824 "file, the revision of the original file the translation is based on. You "
1825 "might wish to adapt and provide that in your CVS area."
1828 # type: Content of: <chapter><section><section><para>
1829 #: best-pkging-practices.dbk:1293
1831 "If you maintain XML or SGML documentation, we suggest that you isolate any "
1832 "language-independent information and define those as entities in a separate "
1833 "file which is included by all the different translations. This makes it "
1834 "much easier, for instance, to keep URLs up to date across multiple files."
1837 # type: Content of: <chapter><section><title>
1838 #: best-pkging-practices.dbk:1303
1839 msgid "Common packaging situations"
1842 # type: Content of: <chapter><section><section><title>
1843 #: best-pkging-practices.dbk:1314
1844 msgid "Packages using <command>autoconf</command>/<command>automake</command>"
1847 # type: Content of: <chapter><section><section><para>
1848 #: best-pkging-practices.dbk:1316
1850 "Keeping <command>autoconf</command>'s <filename>config.sub</filename> and "
1851 "<filename>config.guess</filename> files up to date is critical for porters, "
1852 "especially on more volatile architectures. Some very good packaging "
1853 "practices for any package using <command>autoconf</command> and/or "
1854 "<command>automake</command> have been synthesized in &file-bpp-autotools; "
1855 "from the <systemitem role=\"package\">autotools-dev</systemitem> package. "
1856 "You're strongly encouraged to read this file and to follow the given "
1860 # type: Content of: <chapter><section><section><title>
1861 #: best-pkging-practices.dbk:1328
1865 # type: Content of: <chapter><section><section><para>
1866 #: best-pkging-practices.dbk:1330
1868 "Libraries are always difficult to package for various reasons. The policy "
1869 "imposes many constraints to ease their maintenance and to make sure upgrades "
1870 "are as simple as possible when a new upstream version comes out. Breakage "
1871 "in a library can result in dozens of dependent packages breaking."
1874 # type: Content of: <chapter><section><section><para>
1875 #: best-pkging-practices.dbk:1336
1877 "Good practices for library packaging have been grouped in <ulink url=\"&url-"
1878 "libpkg-guide;\">the library packaging guide</ulink>."
1881 # type: Content of: <chapter><section><section><title>
1882 #: best-pkging-practices.dbk:1343
1883 msgid "Documentation"
1886 # type: Content of: <chapter><section><section><para>
1887 #: best-pkging-practices.dbk:1345
1889 "Be sure to follow the <ulink url=\"&url-debian-policy;ch-docs.html\">Policy "
1890 "on documentation</ulink>."
1893 # type: Content of: <chapter><section><section><para>
1894 #: best-pkging-practices.dbk:1350
1896 "If your package contains documentation built from XML or SGML, we recommend "
1897 "you not ship the XML or SGML source in the binary package(s). If users want "
1898 "the source of the documentation, they should retrieve the source package."
1901 # type: Content of: <chapter><section><section><para>
1902 #: best-pkging-practices.dbk:1355
1904 "Policy specifies that documentation should be shipped in HTML format. We "
1905 "also recommend shipping documentation in PDF and plain text format if "
1906 "convenient and if output of reasonable quality is possible. However, it is "
1907 "generally not appropriate to ship plain text versions of documentation whose "
1908 "source format is HTML."
1911 # type: Content of: <chapter><section><section><para>
1912 #: best-pkging-practices.dbk:1362
1914 "Major shipped manuals should register themselves with <systemitem role="
1915 "\"package\">doc-base</systemitem> on installation. See the <systemitem role="
1916 "\"package\">doc-base</systemitem> package documentation for more information."
1919 # type: Content of: <chapter><section><section><title>
1920 #: best-pkging-practices.dbk:1370
1921 msgid "Specific types of packages"
1924 # type: Content of: <chapter><section><section><para>
1925 #: best-pkging-practices.dbk:1372
1927 "Several specific types of packages have special sub-policies and "
1928 "corresponding packaging rules and practices:"
1931 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1932 #: best-pkging-practices.dbk:1378
1934 "Perl related packages have a <ulink url=\"&url-perl-policy;\">Perl policy</"
1935 "ulink>, some examples of packages following that policy are <systemitem role="
1936 "\"package\">libdbd-pg-perl</systemitem> (binary perl module) or <systemitem "
1937 "role=\"package\">libmldbm-perl</systemitem> (arch independent perl module)."
1940 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1941 #: best-pkging-practices.dbk:1387
1943 "Python related packages have their python policy; see &file-python-policy; "
1944 "in the <systemitem role=\"package\">python</systemitem> package."
1947 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1948 #: best-pkging-practices.dbk:1394
1950 "Emacs related packages have the <ulink url=\"&url-emacs-policy;\">emacs "
1954 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1955 #: best-pkging-practices.dbk:1401
1957 "Java related packages have their <ulink url=\"&url-java-policy;\">java "
1961 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1962 #: best-pkging-practices.dbk:1408
1964 "Ocaml related packages have their own policy, found in &file-ocaml-policy; "
1965 "from the <systemitem role=\"package\">ocaml</systemitem> package. A good "
1966 "example is the <systemitem role=\"package\">camlzip</systemitem> source "
1970 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1971 #: best-pkging-practices.dbk:1416
1973 "Packages providing XML or SGML DTDs should conform to the recommendations "
1974 "found in the <systemitem role=\"package\">sgml-base-doc</systemitem> package."
1977 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1978 #: best-pkging-practices.dbk:1422
1980 "Lisp packages should register themselves with <systemitem role=\"package"
1981 "\">common-lisp-controller</systemitem>, about which see &file-lisp-"
1985 # type: Content of: <chapter><section><section><title>
1986 #: best-pkging-practices.dbk:1452
1987 msgid "Architecture-independent data"
1990 # type: Content of: <chapter><section><section><para>
1991 #: best-pkging-practices.dbk:1454
1993 "It is not uncommon to have a large amount of architecture-independent data "
1994 "packaged with a program. For example, audio files, a collection of icons, "
1995 "wallpaper patterns, or other graphic files. If the size of this data is "
1996 "negligible compared to the size of the rest of the package, it's probably "
1997 "best to keep it all in a single package."
2000 # type: Content of: <chapter><section><section><para>
2001 #: best-pkging-practices.dbk:1461
2003 "However, if the size of the data is considerable, consider splitting it out "
2004 "into a separate, architecture-independent package (_all.deb). By doing "
2005 "this, you avoid needless duplication of the same data into eleven or more ."
2006 "debs, one per each architecture. While this adds some extra overhead into "
2007 "the <filename>Packages</filename> files, it saves a lot of disk space on "
2008 "Debian mirrors. Separating out architecture-independent data also reduces "
2009 "processing time of <command>lintian</command> or <command>linda</command> "
2010 "(see <xref linkend=\"tools-lint\"/> ) when run over the entire Debian "
2014 # type: Content of: <chapter><section><section><title>
2015 #: best-pkging-practices.dbk:1473
2016 msgid "Needing a certain locale during build"
2019 # type: Content of: <chapter><section><section><para>
2020 #: best-pkging-practices.dbk:1475
2022 "If you need a certain locale during build, you can create a temporary file "
2026 # type: Content of: <chapter><section><section><para>
2027 #: best-pkging-practices.dbk:1479
2029 "If you set <varname>LOCPATH</varname> to the equivalent of <filename>/usr/"
2030 "lib/locale</filename>, and <varname>LC_ALL</varname> to the name of the "
2031 "locale you generate, you should get what you want without being root. "
2032 "Something like this:"
2035 # type: Content of: <chapter><section><section><screen>
2036 #: best-pkging-practices.dbk:1484
2039 "LOCALE_PATH=debian/tmpdir/usr/lib/locale\n"
2040 "LOCALE_NAME=en_IN\n"
2041 "LOCALE_CHARSET=UTF-8\n"
2043 "mkdir -p $LOCALE_PATH\n"
2044 "localedef -i $LOCALE_NAME.$LOCALE_CHARSET -f $LOCALE_CHARSET $LOCALE_PATH/$LOCALE_NAME.$LOCALE_CHARSET\n"
2046 "# Using the locale\n"
2047 "LOCPATH=$LOCALE_PATH LC_ALL=$LOCALE_NAME.$LOCALE_CHARSET date"
2050 # type: Content of: <chapter><section><section><title>
2051 #: best-pkging-practices.dbk:1497
2052 msgid "Make transition packages deborphan compliant"
2055 # type: Content of: <chapter><section><section><para>
2056 #: best-pkging-practices.dbk:1499
2058 "Deborphan is a program for helping users to detect which packages can safely "
2059 "be removed from the system, i.e. the ones that have no packages depending "
2060 "on them. The default operation is to search only within the libs and "
2061 "oldlibs sections, to hunt down unused libraries. But when passed the right "
2062 "argument, it tries to catch other useless packages."
2065 # type: Content of: <chapter><section><section><para>
2066 #: best-pkging-practices.dbk:1506
2068 "For example, with --guess-dummy, deborphan tries to search all transitional "
2069 "packages which were needed for upgrade but which can now safely be removed. "
2070 "For that, it looks for the string dummy or transitional in their short "
2074 # type: Content of: <chapter><section><section><para>
2075 #: best-pkging-practices.dbk:1512
2077 "So, when you are creating such a package, please make sure to add this text "
2078 "to your short description. If you are looking for examples, just run: "
2079 "<command>apt-cache search .|grep dummy</command> or <command>apt-cache "
2080 "search .|grep transitional</command>."
2083 # type: Content of: <chapter><section><section><title>
2084 #: best-pkging-practices.dbk:1520
2085 msgid "Best practices for <filename>orig.tar.gz</filename> files"
2088 # type: Content of: <chapter><section><section><para>
2089 #: best-pkging-practices.dbk:1522
2091 "There are two kinds of original source tarballs: Pristine source and "
2092 "repackaged upstream source."
2095 # type: Content of: <chapter><section><section><section><title>
2096 #: best-pkging-practices.dbk:1526
2097 msgid "Pristine source"
2100 # type: Content of: <chapter><section><section><section><para><footnote>
2101 #: best-pkging-practices.dbk:1528
2103 "The defining characteristic of a pristine source tarball is that the .orig."
2104 "tar.gz file is byte-for-byte identical to a tarball officially distributed "
2105 "by the upstream author. <footnote>"
2108 # type: Content of: <chapter><section><section><section><para><footnote><para>
2109 #: best-pkging-practices.dbk:1530
2111 "We cannot prevent upstream authors from changing the tarball they distribute "
2112 "without also incrementing the version number, so there can be no guarantee "
2113 "that a pristine tarball is identical to what upstream <emphasis>currently</"
2114 "emphasis> distributing at any point in time. All that can be expected is "
2115 "that it is identical to something that upstream once <emphasis>did</"
2116 "emphasis> distribute. If a difference arises later (say, if upstream "
2117 "notices that he wasn't using maximal comression in his original distribution "
2118 "and then re-<literal>gzip</literal>s it), that's just too bad. Since there "
2119 "is no good way to upload a new .orig.tar.gz for the same version, there is "
2120 "not even any point in treating this situation as a bug."
2123 # type: Content of: <chapter><section><section><section><para>
2124 #: best-pkging-practices.dbk:1540
2126 "</footnote> This makes it possible to use checksums to easily verify that "
2127 "all changes between Debian's version and upstream's are contained in the "
2128 "Debian diff. Also, if the original source is huge, upstream authors and "
2129 "others who already have the upstream tarball can save download time if they "
2130 "want to inspect your packaging in detail."
2133 # type: Content of: <chapter><section><section><section><para>
2134 #: best-pkging-practices.dbk:1548
2136 "There is no universally accepted guidelines that upstream authors follow "
2137 "regarding to the directory structure inside their tarball, but <command>dpkg-"
2138 "source</command> is nevertheless able to deal with most upstream tarballs as "
2139 "pristine source. Its strategy is equivalent to the following:"
2142 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2143 #: best-pkging-practices.dbk:1556
2144 msgid "It unpacks the tarball in an empty temporary directory by doing"
2147 # type: Content of: <chapter><section><section><section><orderedlist><listitem><screen>
2148 #: best-pkging-practices.dbk:1559
2150 msgid "zcat path/to/<packagename>_<upstream-version>.orig.tar.gz | tar xf -"
2153 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2154 #: best-pkging-practices.dbk:1564
2156 "If, after this, the temporary directory contains nothing but one directory "
2157 "and no other files, <command>dpkg-source</command> renames that directory to "
2158 "<literal><packagename>-<upstream-version>(.orig)</literal>. The "
2159 "name of the top-level directory in the tarball does not matter, and is "
2163 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2164 #: best-pkging-practices.dbk:1573
2166 "Otherwise, the upstream tarball must have been packaged without a common top-"
2167 "level directory (shame on the upstream author!). In this case, "
2168 "<command>dpkg-source</command> renames the temporary directory "
2169 "<emphasis>itself</emphasis> to <literal><packagename>-<upstream-"
2170 "version>(.orig)</literal>."
2173 # type: Content of: <chapter><section><section><section><title>
2174 #: best-pkging-practices.dbk:1584
2175 msgid "Repackaged upstream source"
2178 # type: Content of: <chapter><section><section><section><para>
2179 #: best-pkging-practices.dbk:1586
2181 "You <emphasis role=\"strong\">should</emphasis> upload packages with a "
2182 "pristine source tarball if possible, but there are various reasons why it "
2183 "might not be possible. This is the case if upstream does not distribute the "
2184 "source as gzipped tar at all, or if upstream's tarball contains non-DFSG-"
2185 "free material that you must remove before uploading."
2188 # type: Content of: <chapter><section><section><section><para>
2189 #: best-pkging-practices.dbk:1593
2191 "In these cases the developer must construct a suitable .orig.tar.gz file "
2192 "himself. We refer to such a tarball as a repackaged upstream source. Note "
2193 "that a repackaged upstream source is different from a Debian-native "
2194 "package. A repackaged source still comes with Debian-specific changes in a "
2195 "separate <literal>.diff.gz</literal> and still has a version number composed "
2196 "of <literal><upstream-version></literal> and <literal><debian-"
2197 "revision></literal>."
2200 # type: Content of: <chapter><section><section><section><para>
2201 #: best-pkging-practices.dbk:1602
2203 "There may be cases where it is desirable to repackage the source even though "
2204 "upstream distributes a <literal>.tar.gz</literal> that could in principle be "
2205 "used in its pristine form. The most obvious is if <emphasis>significant</"
2206 "emphasis> space savings can be achieved by recompressing the tar archive or "
2207 "by removing genuinely useless cruft from the upstream archive. Use your own "
2208 "discretion here, but be prepared to defend your decision if you repackage "
2209 "source that could have been pristine."
2212 # type: Content of: <chapter><section><section><section><para>
2213 #: best-pkging-practices.dbk:1611
2214 msgid "A repackaged .orig.tar.gz"
2217 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2218 #: best-pkging-practices.dbk:1616
2220 "<emphasis role=\"strong\">must</emphasis> contain detailed information how "
2221 "the repackaged source was obtained, and how this can be reproduced in the "
2222 "<filename>debian/copyright</filename>. It is also a good idea to provide a "
2223 "<literal>get-orig-source</literal> target in your <filename>debian/rules</"
2224 "filename> file that repeats the process, as described in the Policy Manual, "
2225 "<ulink url=\"&url-debian-policy;ch-source.html#s-debianrules\">Main building "
2226 "script: debian/rules</ulink>."
2229 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para><footnote>
2230 #: best-pkging-practices.dbk:1628
2232 "<emphasis role=\"strong\">should not</emphasis> contain any file that does "
2233 "not come from the upstream author(s), or whose contents has been changed by "
2237 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para><footnote><para>
2238 #. or similarly named
2239 #: best-pkging-practices.dbk:1630
2241 "As a special exception, if the omission of non-free files would lead to the "
2242 "source failing to build without assistance from the Debian diff, it might be "
2243 "appropriate to instead edit the files, omitting only the non-free parts of "
2244 "them, and/or explain the situation in a README.Debian-source file in the "
2245 "root of the source tree. But in that case please also urge the upstream "
2246 "author to make the non-free components easier seperable from the rest of the "
2250 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2251 #: best-pkging-practices.dbk:1642
2253 "<emphasis role=\"strong\">should</emphasis>, except where impossible for "
2254 "legal reasons, preserve the entire building and portablility infrastructure "
2255 "provided by the upstream author. For example, it is not a sufficient reason "
2256 "for omitting a file that it is used only when building on MS-DOS. "
2257 "Similarly, a Makefile provided by upstream should not be omitted even if the "
2258 "first thing your <filename>debian/rules</filename> does is to overwrite it "
2259 "by running a configure script."
2262 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2263 #: best-pkging-practices.dbk:1651
2265 "(<emphasis>Rationale:</emphasis> It is common for Debian users who need to "
2266 "build software for non-Debian platforms to fetch the source from a Debian "
2267 "mirror rather than trying to locate a canonical upstream distribution point)."
2270 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2271 #: best-pkging-practices.dbk:1658
2273 "<emphasis role=\"strong\">should</emphasis> use <literal><packagename>-"
2274 "<upstream-version>.orig</literal> as the name of the top-level "
2275 "directory in its tarball. This makes it possible to distinguish pristine "
2276 "tarballs from repackaged ones."
2279 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2280 #: best-pkging-practices.dbk:1666
2282 "<emphasis role=\"strong\">should</emphasis> be gzipped with maximal "
2286 # type: Content of: <chapter><section><section><section><para>
2287 #: best-pkging-practices.dbk:1671
2289 "The canonical way to meet the latter two points is to let <literal>dpkg-"
2290 "source -b</literal> construct the repackaged tarball from an unpacked "
2294 # type: Content of: <chapter><section><section><section><title>
2295 #: best-pkging-practices.dbk:1677
2296 msgid "Changing binary files in <literal>diff.gz</literal>"
2299 # type: Content of: <chapter><section><section><section><para><footnote>
2300 #: best-pkging-practices.dbk:1679
2302 "Sometimes it is necessary to change binary files contained in the original "
2303 "tarball, or to add binary files that are not in it. If this is done by "
2304 "simply copying the files into the debianized source tree, <command>dpkg-"
2305 "source</command> will not be able to handle this. On the other hand, "
2306 "according to the guidelines given above, you cannot include such a changed "
2307 "binary file in a repackaged <filename>orig.tar.gz</filename>. Instead, "
2308 "include the file in the <filename>debian</filename> directory in "
2309 "<command>uuencode</command>d (or similar) form <footnote>"
2312 # type: Content of: <chapter><section><section><section><para><footnote><para>
2313 #: best-pkging-practices.dbk:1686
2315 "The file should have a name that makes it clear which binary file it "
2316 "encodes. Usually, some postfix indicating the encoding should be appended "
2317 "to the original filename. Note that you don't need to depend on <systemitem "
2318 "role=\"package\">sharutils</systemitem> to get the <command>uudecode</"
2319 "command> program if you use <command>perl</command>'s <literal>pack</"
2320 "literal> function. The code could look like"
2323 # type: Content of: <chapter><section><section><section><para>
2324 #: best-pkging-practices.dbk:1694
2326 "&example-uu; </footnote>. The file would then be decoded and copied to its "
2327 "place during the build process. Thus the change will be visible quite easy."
2330 # type: Content of: <chapter><section><section><section><para>
2331 #: best-pkging-practices.dbk:1700
2333 "Some packages use <command>dbs</command> to manage patches to their upstream "
2334 "source, and always create a new <literal>orig.tar.gz</literal> file that "
2335 "contains the real <literal>orig.tar.gz</literal> in its toplevel directory. "
2336 "This is questionable with respect to the preference for pristine source. On "
2337 "the other hand, it is easy to modify or add binary files in this case: Just "
2338 "put them into the newly created <literal>orig.tar.gz</literal> file, besides "
2339 "the real one, and copy them to the right place during the build process."
2342 # type: Content of: <chapter><section><section><title>
2343 #: best-pkging-practices.dbk:1713
2344 msgid "Best practices for debug packages"
2347 # type: Content of: <chapter><section><section><para>
2348 #: best-pkging-practices.dbk:1715
2350 "A debug package is a package with a name ending in -dbg, that contains "
2351 "additional information that gdb can use. Since Debian binaries are stripped "
2352 "by default, debugging information, including function names and line "
2353 "numbers, is otherwise not available when running gdb on Debian binaries. "
2354 "Debug packages allow users who need this additional debugging information to "
2355 "install it, without bloating a regular system with the information."
2358 # type: Content of: <chapter><section><section><para>
2359 #: best-pkging-practices.dbk:1723
2361 "It is up to a package's maintainer whether to create a debug package or "
2362 "not. Maintainers are encouraged to create debug packages for library "
2363 "packages, since this can aid in debugging many programs linked to a "
2364 "library. In general, debug packages do not need to be added for all "
2365 "programs; doing so would bloat the archive. But if a maintainer finds that "
2366 "users often need a debugging version of a program, it can be worthwhile to "
2367 "make a debug package for it. Programs that are core infrastructure, such as "
2368 "apache and the X server are also good candidates for debug packages."
2371 # type: Content of: <chapter><section><section><para>
2372 #: best-pkging-practices.dbk:1733
2374 "Some debug packages may contain an entire special debugging build of a "
2375 "library or other binary, but most of them can save space and build time by "
2376 "instead containing separated debugging symbols that gdb can find and load on "
2377 "the fly when debugging a program or library. The convention in Debian is to "
2378 "keep these symbols in <filename>/usr/lib/debug/path</filename>, where "
2379 "<emphasis>path</emphasis> is the path to the executable or library. For "
2380 "example, debugging symbols for <filename>/usr/bin/foo</filename> go in "
2381 "<filename>/usr/lib/debug/usr/bin/foo</filename>, and debugging symbols for "
2382 "<filename>/usr/lib/libfoo.so.1</filename> go in <filename>/usr/lib/debug/usr/"
2383 "lib/libfoo.so.1</filename>."
2386 # type: Content of: <chapter><section><section><para>
2387 #: best-pkging-practices.dbk:1745
2389 "The debugging symbols can be extracted from an object file using objcopy --"
2390 "only-keep-debug. Then the object file can be stripped, and objcopy --add-"
2391 "gnu-debuglink used to specify the path to the debugging symbol file. "
2392 "<citerefentry> <refentrytitle>objcopy</refentrytitle> <manvolnum>1</"
2393 "manvolnum> </citerefentry> explains in detail how this works."
2396 # type: Content of: <chapter><section><section><para>
2397 #: best-pkging-practices.dbk:1752
2399 "The dh_strip command in debhelper supports creating debug packages, and can "
2400 "take care of using objcopy to separate out the debugging symbols for you. "
2401 "If your package uses debhelper, all you need to do is call dh_strip --dbg-"
2402 "package=libfoo-dbg, and add an entry to debian/control for the debug package."
2405 # type: Content of: <chapter><section><section><para>
2406 #: best-pkging-practices.dbk:1759
2408 "Note that the Debian package should depend on the package that it provides "
2409 "debugging symbols for, and this dependency should be versioned. For example:"
2412 # type: Content of: <chapter><section><section><screen>
2413 #: best-pkging-practices.dbk:1763
2415 msgid "Depends: libfoo-dbg (= ${binary:Version})"