chiark / gitweb /
- Update Japanese translations
[developers-reference.git] / po4a / ja / best-pkging-practices.po
1 # Debian Developer's Reference (Japanese)
2 # Hideki Yamane (Debian-JP) <henrich@debian.or.jp>, 2008.
3 #
4 msgid ""
5 msgstr ""
6 "Project-Id-Version: developers-reference 3.3.9\n"
7 "POT-Creation-Date: 2008-03-05 18:02+0900\n"
8 "PO-Revision-Date: 2008-03-05 18:30+0900\n"
9 "Last-Translator: Hideki Yamane (Debian-JP) <henrich@debian.or.jp>\n"
10 "Language-Team: Debian JP Project <debian-doc@debian.or.jp>\n"
11 "MIME-Version: 1.0\n"
12 "Content-Type: text/plain; charset=UTF-8\n"
13 "Content-Transfer-Encoding: 8bit\n"
14
15 # type: Content of: <chapter><title>
16 #: best-pkging-practices.dbk:7
17 msgid "Best Packaging Practices"
18 msgstr "パッケージ化のベストプラクティス"
19
20 # type: Content of: <chapter><para>
21 #: best-pkging-practices.dbk:9
22 #, fuzzy
23 msgid ""
24 "Debian's quality is largely due to the <ulink url=\"&url-debian-policy;"
25 "\">Debian Policy</ulink>, which defines explicit baseline requirements which "
26 "all Debian packages must fulfill.  Yet there is also a shared history of "
27 "experience which goes beyond the Debian Policy, an accumulation of years of "
28 "experience in packaging.  Many very talented people have created great "
29 "tools, tools which help you, the Debian maintainer, create and maintain "
30 "excellent packages."
31 msgstr ""
32 "Debian の品質は、全ての Debian パッケージが満たす必要がある基本的要求を明示的"
33 "に規定している <ulink url=\"&url-debian-policy;\">Debian Policy</ulink> に大"
34 "きく依存しています。"
35
36 # type: Content of: <chapter><para>
37 #: best-pkging-practices.dbk:18
38 msgid ""
39 "This chapter provides some best practices for Debian developers.  All "
40 "recommendations are merely that, and are not requirements or policy.  These "
41 "are just some subjective hints, advice and pointers collected from Debian "
42 "developers.  Feel free to pick and choose whatever works best for you."
43 msgstr ""
44
45 # type: Content of: <chapter><section><title>
46 #: best-pkging-practices.dbk:24
47 msgid "Best practices for <filename>debian/rules</filename>"
48 msgstr "<filename>debian/rules</filename> についてのベストプラクティス"
49
50 # type: Content of: <chapter><section><para>
51 #: best-pkging-practices.dbk:26
52 msgid ""
53 "The following recommendations apply to the <filename>debian/rules</filename> "
54 "file.  Since <filename>debian/rules</filename> controls the build process "
55 "and selects the files which go into the package (directly or indirectly), "
56 "it's usually the file maintainers spend the most time on."
57 msgstr ""
58
59 # type: Content of: <chapter><section><section><title>
60 #: best-pkging-practices.dbk:32
61 msgid "Helper scripts"
62 msgstr "補助スクリプト"
63
64 # type: Content of: <chapter><section><section><para>
65 #: best-pkging-practices.dbk:34
66 msgid ""
67 "The rationale for using helper scripts in <filename>debian/rules</filename> "
68 "is that they let maintainers use and share common logic among many "
69 "packages.  Take for instance the question of installing menu entries: you "
70 "need to put the file into <filename>/usr/lib/menu</filename> (or <filename>/"
71 "usr/lib/menu</filename> for executable binary menufiles, if this is needed), "
72 "and add commands to the maintainer scripts to register and unregister the "
73 "menu entries.  Since this is a very common thing for packages to do, why "
74 "should each maintainer rewrite all this on their own, sometimes with bugs? "
75 "Also, supposing the menu directory changed, every package would have to be "
76 "changed."
77 msgstr ""
78
79 # type: Content of: <chapter><section><section><para>
80 #: best-pkging-practices.dbk:45
81 msgid ""
82 "Helper scripts take care of these issues.  Assuming you comply with the "
83 "conventions expected by the helper script, the helper takes care of all the "
84 "details.  Changes in policy can be made in the helper script; then packages "
85 "just need to be rebuilt with the new version of the helper and no other "
86 "changes."
87 msgstr ""
88
89 # type: Content of: <chapter><section><section><para>
90 #: best-pkging-practices.dbk:52
91 msgid ""
92 "<xref linkend=\"tools\"/> contains a couple of different helpers.  The most "
93 "common and best (in our opinion) helper system is <systemitem role=\"package"
94 "\">debhelper</systemitem>.  Previous helper systems, such as <systemitem "
95 "role=\"package\">debmake</systemitem>, were monolithic: you couldn't pick "
96 "and choose which part of the helper you found useful, but had to use the "
97 "helper to do everything.  <systemitem role=\"package\">debhelper</"
98 "systemitem>, however, is a number of separate little <command>dh_*</command> "
99 "programs.  For instance, <command>dh_installman</command> installs and "
100 "compresses man pages, <command>dh_installmenu</command> installs menu files, "
101 "and so on.  Thus, it offers enough flexibility to be able to use the little "
102 "helper scripts, where useful, in conjunction with hand-crafted commands in "
103 "<filename>debian/rules</filename>."
104 msgstr ""
105
106 # type: Content of: <chapter><section><section><para>
107 #: best-pkging-practices.dbk:66
108 msgid ""
109 "You can get started with <systemitem role=\"package\">debhelper</systemitem> "
110 "by reading <citerefentry> <refentrytitle>debhelper</refentrytitle> "
111 "<manvolnum>1</manvolnum> </citerefentry>, and looking at the examples that "
112 "come with the package.  <command>dh_make</command>, from the <systemitem "
113 "role=\"package\">dh-make</systemitem> package (see <xref linkend=\"dh-make\"/"
114 "> ), can be used to convert a vanilla source package to a <systemitem role="
115 "\"package\">debhelper</systemitem>ized package.  This shortcut, though, "
116 "should not convince you that you do not need to bother understanding the "
117 "individual <command>dh_*</command> helpers.  If you are going to use a "
118 "helper, you do need to take the time to learn to use that helper, to learn "
119 "its expectations and behavior."
120 msgstr ""
121
122 # type: Content of: <chapter><section><section><para>
123 #: best-pkging-practices.dbk:79
124 msgid ""
125 "Some people feel that vanilla <filename>debian/rules</filename> files are "
126 "better, since you don't have to learn the intricacies of any helper system.  "
127 "This decision is completely up to you.  Use what works for you.  Many "
128 "examples of vanilla <filename>debian/rules</filename> files are available at "
129 "<ulink url=\"&url-rules-files;\"></ulink>."
130 msgstr ""
131
132 # type: Content of: <chapter><section><section><title>
133 #: best-pkging-practices.dbk:88
134 msgid "Separating your patches into multiple files"
135 msgstr ""
136
137 # type: Content of: <chapter><section><section><para>
138 #: best-pkging-practices.dbk:90
139 msgid ""
140 "Big, complex packages may have many bugs that you need to deal with.  If you "
141 "correct a number of bugs directly in the source, and you're not careful, it "
142 "can get hard to differentiate the various patches that you applied.  It can "
143 "get quite messy when you have to update the package to a new upstream "
144 "version which integrates some of the fixes (but not all).  You can't take "
145 "the total set of diffs (e.g., from <filename>.diff.gz</filename>) and work "
146 "out which patch sets to back out as a unit as bugs are fixed upstream."
147 msgstr ""
148
149 # type: Content of: <chapter><section><section><para>
150 #: best-pkging-practices.dbk:99
151 msgid ""
152 "Unfortunately, the packaging system as such currently doesn't provide for "
153 "separating the patches into several files.  Nevertheless, there are ways to "
154 "separate patches: the patch files are shipped within the Debian patch file "
155 "(<filename>.diff.gz</filename>), usually within the <filename>debian/</"
156 "filename> directory.  The only difference is that they aren't applied "
157 "immediately by dpkg-source, but by the <literal>build</literal> rule of "
158 "<filename>debian/rules</filename>.  Conversely, they are reverted in the "
159 "<literal>clean</literal> rule."
160 msgstr ""
161
162 # type: Content of: <chapter><section><section><para>
163 #: best-pkging-practices.dbk:109
164 msgid ""
165 "<command>dbs</command> is one of the more popular approaches to this.  It "
166 "does all of the above, and provides a facility for creating new and updating "
167 "old patches.  See the package <systemitem role=\"package\">dbs</systemitem> "
168 "for more information and <systemitem role=\"package\">hello-dbs</systemitem> "
169 "for an example."
170 msgstr ""
171
172 # type: Content of: <chapter><section><section><para>
173 #: best-pkging-practices.dbk:116
174 msgid ""
175 "<command>dpatch</command> also provides these facilities, but it's intended "
176 "to be even easier to use.  See the package <systemitem role=\"package"
177 "\">dpatch</systemitem> for documentation and examples (in <filename>/usr/"
178 "share/doc/dpatch</filename>)."
179 msgstr ""
180
181 # type: Content of: <chapter><section><section><title>
182 #: best-pkging-practices.dbk:124
183 msgid "Multiple binary packages"
184 msgstr ""
185
186 # type: Content of: <chapter><section><section><para>
187 #: best-pkging-practices.dbk:126
188 msgid ""
189 "A single source package will often build several binary packages, either to "
190 "provide several flavors of the same software (e.g., the <systemitem role="
191 "\"package\">vim</systemitem> source package) or to make several small "
192 "packages instead of a big one (e.g., so the user can install only the subset "
193 "needed, and thus save some disk space)."
194 msgstr ""
195
196 # type: Content of: <chapter><section><section><para>
197 #: best-pkging-practices.dbk:133
198 msgid ""
199 "The second case can be easily managed in <filename>debian/rules</filename>.  "
200 "You just need to move the appropriate files from the build directory into "
201 "the package's temporary trees.  You can do this using <command>install</"
202 "command> or <command>dh_install</command> from <systemitem role=\"package"
203 "\">debhelper</systemitem>.  Be sure to check the different permutations of "
204 "the various packages, ensuring that you have the inter-package dependencies "
205 "set right in <filename>debian/control</filename>."
206 msgstr ""
207
208 # type: Content of: <chapter><section><section><para>
209 #: best-pkging-practices.dbk:142
210 msgid ""
211 "The first case is a bit more difficult since it involves multiple recompiles "
212 "of the same software but with different configuration options.  The "
213 "<systemitem role=\"package\">vim</systemitem> source package is an example "
214 "of how to manage this using an hand-crafted <filename>debian/rules</"
215 "filename> file."
216 msgstr ""
217
218 # type: Content of: <chapter><section><title>
219 #: best-pkging-practices.dbk:154
220 msgid "Best practices for <filename>debian/control</filename>"
221 msgstr ""
222
223 # type: Content of: <chapter><section><para>
224 #: best-pkging-practices.dbk:156
225 msgid ""
226 "The following practices are relevant to the <filename>debian/control</"
227 "filename> file.  They supplement the <ulink url=\"&url-debian-policy;ch-"
228 "binary.html#s-descriptions\">Policy on package descriptions</ulink>."
229 msgstr ""
230
231 # type: Content of: <chapter><section><para>
232 #: best-pkging-practices.dbk:162
233 msgid ""
234 "The description of the package, as defined by the corresponding field in the "
235 "<filename>control</filename> file, contains both the package synopsis and "
236 "the long description for the package.  <xref linkend=\"bpp-desc-basics\"/> "
237 "describes common guidelines for both parts of the package description.  "
238 "Following that, <xref linkend=\"bpp-pkg-synopsis\"/> provides guidelines "
239 "specific to the synopsis, and <xref linkend=\"bpp-pkg-desc\"/> contains "
240 "guidelines specific to the description."
241 msgstr ""
242
243 # type: Content of: <chapter><section><section><title>
244 #: best-pkging-practices.dbk:171
245 msgid "General guidelines for package descriptions"
246 msgstr ""
247
248 # type: Content of: <chapter><section><section><para>
249 #: best-pkging-practices.dbk:173
250 msgid ""
251 "The package description should be written for the average likely user, the "
252 "average person who will use and benefit from the package.  For instance, "
253 "development packages are for developers, and can be technical in their "
254 "language.  More general-purpose applications, such as editors, should be "
255 "written for a less technical user."
256 msgstr ""
257
258 # type: Content of: <chapter><section><section><para>
259 #: best-pkging-practices.dbk:180
260 msgid ""
261 "Our review of package descriptions lead us to conclude that most package "
262 "descriptions are technical, that is, are not written to make sense for non-"
263 "technical users.  Unless your package really is only for technical users, "
264 "this is a problem."
265 msgstr ""
266
267 # type: Content of: <chapter><section><section><para>
268 #: best-pkging-practices.dbk:186
269 msgid ""
270 "How do you write for non-technical users? Avoid jargon.  Avoid referring to "
271 "other applications or frameworks that the user might not be familiar with — "
272 "GNOME or KDE is fine, since users are probably familiar with these terms, "
273 "but GTK+ is probably not.  Try not to assume any knowledge at all.  If you "
274 "must use technical terms, introduce them."
275 msgstr ""
276
277 # type: Content of: <chapter><section><section><para>
278 #: best-pkging-practices.dbk:193
279 msgid ""
280 "Be objective.  Package descriptions are not the place for advocating your "
281 "package, no matter how much you love it.  Remember that the reader may not "
282 "care about the same things you care about."
283 msgstr ""
284
285 # type: Content of: <chapter><section><section><para>
286 #: best-pkging-practices.dbk:198
287 msgid ""
288 "References to the names of any other software packages, protocol names, "
289 "standards, or specifications should use their canonical forms, if one "
290 "exists.  For example, use X Window System, X11, or X; not X Windows, X-"
291 "Windows, or X Window.  Use GTK+, not GTK or gtk.  Use GNOME, not Gnome.  Use "
292 "PostScript, not Postscript or postscript."
293 msgstr ""
294
295 # type: Content of: <chapter><section><section><para>
296 #: best-pkging-practices.dbk:205
297 msgid ""
298 "If you are having problems writing your description, you may wish to send it "
299 "along to &email-debian-l10n-english; and request feedback."
300 msgstr ""
301
302 # type: Content of: <chapter><section><section><title>
303 #: best-pkging-practices.dbk:211
304 msgid "The package synopsis, or short description"
305 msgstr ""
306
307 # type: Content of: <chapter><section><section><para>
308 #: best-pkging-practices.dbk:213
309 msgid ""
310 "The synopsis line (the short description) should be concise.  It must not "
311 "repeat the package's name (this is policy)."
312 msgstr ""
313
314 # type: Content of: <chapter><section><section><para>
315 #: best-pkging-practices.dbk:217
316 msgid ""
317 "It's a good idea to think of the synopsis as an appositive clause, not a "
318 "full sentence.  An appositive clause is defined in WordNet as a grammatical "
319 "relation between a word and a noun phrase that follows, e.g., Rudolph the "
320 "red-nosed reindeer.  The appositive clause here is red-nosed reindeer.  "
321 "Since the synopsis is a clause, rather than a full sentence, we recommend "
322 "that it neither start with a capital nor end with a full stop (period).  It "
323 "should also not begin with an article, either definite (the) or indefinite "
324 "(a or an)."
325 msgstr ""
326
327 # type: Content of: <chapter><section><section><para>
328 #: best-pkging-practices.dbk:226
329 msgid ""
330 "It might help to imagine that the synopsis is combined with the package name "
331 "in the following way:"
332 msgstr ""
333
334 # type: Content of: <chapter><section><section><screen>
335 #: best-pkging-practices.dbk:229
336 #, no-wrap
337 msgid ""
338 "\n"
339 "<replaceable>package-name</replaceable> is a <replaceable>synopsis</replaceable>.\n"
340 msgstr ""
341
342 # type: Content of: <chapter><section><section><para>
343 #: best-pkging-practices.dbk:233
344 msgid "Alternatively, it might make sense to think of it as"
345 msgstr ""
346
347 # type: Content of: <chapter><section><section><screen>
348 #: best-pkging-practices.dbk:235
349 #, no-wrap
350 msgid ""
351 "\n"
352 "<replaceable>package-name</replaceable> is <replaceable>synopsis</replaceable>.\n"
353 msgstr ""
354
355 # type: Content of: <chapter><section><section><para>
356 #: best-pkging-practices.dbk:239
357 msgid "or, if the package name itself is a plural (such as developers-tools)"
358 msgstr ""
359
360 # type: Content of: <chapter><section><section><screen>
361 #: best-pkging-practices.dbk:241
362 #, no-wrap
363 msgid ""
364 "\n"
365 "<replaceable>package-name</replaceable> are <replaceable>synopsis</replaceable>.\n"
366 msgstr ""
367
368 # type: Content of: <chapter><section><section><para>
369 #: best-pkging-practices.dbk:245
370 msgid ""
371 "This way of forming a sentence from the package name and synopsis should be "
372 "considered as a heuristic and not a strict rule.  There are some cases where "
373 "it doesn't make sense to try to form a sentence."
374 msgstr ""
375
376 # type: Content of: <chapter><section><section><title>
377 #: best-pkging-practices.dbk:252
378 msgid "The long description"
379 msgstr ""
380
381 # type: Content of: <chapter><section><section><para>
382 #: best-pkging-practices.dbk:254
383 msgid ""
384 "The long description is the primary information available to the user about "
385 "a package before they install it.  It should provide all the information "
386 "needed to let the user decide whether to install the package.  Assume that "
387 "the user has already read the package synopsis."
388 msgstr ""
389
390 # type: Content of: <chapter><section><section><para>
391 #: best-pkging-practices.dbk:260
392 msgid "The long description should consist of full and complete sentences."
393 msgstr ""
394
395 # type: Content of: <chapter><section><section><para>
396 #: best-pkging-practices.dbk:263
397 msgid ""
398 "The first paragraph of the long description should answer the following "
399 "questions: what does the package do? what task does it help the user "
400 "accomplish? It is important to describe this in a non-technical way, unless "
401 "of course the audience for the package is necessarily technical."
402 msgstr ""
403
404 # type: Content of: <chapter><section><section><para>
405 #: best-pkging-practices.dbk:269
406 msgid ""
407 "The following paragraphs should answer the following questions: Why do I as "
408 "a user need this package? What other features does the package have? What "
409 "outstanding features and deficiencies are there compared to other packages "
410 "(e.g., if you need X, use Y instead)? Is this package related to other "
411 "packages in some way that is not handled by the package manager (e.g., this "
412 "is the client for the foo server)?"
413 msgstr ""
414
415 # type: Content of: <chapter><section><section><para>
416 #: best-pkging-practices.dbk:277
417 msgid ""
418 "Be careful to avoid spelling and grammar mistakes.  Ensure that you spell-"
419 "check it.  Both <command>ispell</command> and <command>aspell</command> have "
420 "special modes for checking <filename>debian/control</filename> files:"
421 msgstr ""
422
423 # type: Content of: <chapter><section><section><screen>
424 #: best-pkging-practices.dbk:281
425 #, no-wrap
426 msgid ""
427 "\n"
428 "ispell -d american -g debian/control\n"
429 msgstr ""
430
431 # type: Content of: <chapter><section><section><screen>
432 #: best-pkging-practices.dbk:284
433 #, no-wrap
434 msgid ""
435 "\n"
436 "aspell -d en -D -c debian/control\n"
437 msgstr ""
438
439 # type: Content of: <chapter><section><section><para>
440 #: best-pkging-practices.dbk:288
441 msgid ""
442 "Users usually expect these questions to be answered in the package "
443 "description:"
444 msgstr ""
445
446 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
447 #: best-pkging-practices.dbk:293
448 msgid ""
449 "What does the package do? If it is an add-on to another package, then the "
450 "short description of the package we are an add-on to should be put in here."
451 msgstr ""
452
453 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
454 #: best-pkging-practices.dbk:299
455 msgid ""
456 "Why should I want this package? This is related to the above, but not the "
457 "same (this is a mail user agent; this is cool, fast, interfaces with PGP and "
458 "LDAP and IMAP, has features X, Y, and Z)."
459 msgstr ""
460
461 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
462 #: best-pkging-practices.dbk:306
463 msgid ""
464 "If this package should not be installed directly, but is pulled in by "
465 "another package, this should be mentioned."
466 msgstr ""
467
468 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
469 #: best-pkging-practices.dbk:312
470 msgid ""
471 "If the package is experimental, or there are other reasons it should not be "
472 "used, if there are other packages that should be used instead, it should be "
473 "here as well."
474 msgstr ""
475
476 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
477 #: best-pkging-practices.dbk:319
478 msgid ""
479 "How is this package different from the competition? Is it a better "
480 "implementation? more features? different features? Why should I choose this "
481 "package."
482 msgstr ""
483
484 # type: Content of: <chapter><section><section><title>
485 #: best-pkging-practices.dbk:332
486 msgid "Upstream home page"
487 msgstr ""
488
489 # type: Content of: <chapter><section><section><para>
490 #: best-pkging-practices.dbk:334
491 msgid ""
492 "We recommend that you add the URL for the package's home page in the "
493 "<literal>Homepage</literal> field of the <literal>Source</literal> section "
494 "in <filename>debian/control</filename>.  Adding this information in the "
495 "package description itself is considered deprecated."
496 msgstr ""
497
498 # type: Content of: <chapter><section><section><title>
499 #: best-pkging-practices.dbk:342
500 msgid "Version Control System location"
501 msgstr ""
502
503 # type: Content of: <chapter><section><section><para>
504 #: best-pkging-practices.dbk:344
505 msgid ""
506 "There are additional fields for the location of the Version Control System "
507 "in <filename>debian/control</filename>."
508 msgstr ""
509
510 # type: Content of: <chapter><section><section><section><title>
511 #: best-pkging-practices.dbk:348
512 msgid "Vcs-Browser"
513 msgstr ""
514
515 # type: Content of: <chapter><section><section><section><para>
516 #: best-pkging-practices.dbk:350
517 msgid ""
518 "Value of this field should be a <literal>http://</literal> URL pointing to a "
519 "web-browsable copy of the Version Control System repository used to maintain "
520 "the given package, if available."
521 msgstr ""
522
523 # type: Content of: <chapter><section><section><section><para>
524 #: best-pkging-practices.dbk:355
525 msgid ""
526 "The information is meant to be useful for the final user, willing to browse "
527 "the latest work done on the package (e.g.  when looking for the patch fixing "
528 "a bug tagged as <literal>pending</literal> in the bug tracking system)."
529 msgstr ""
530
531 # type: Content of: <chapter><section><section><section><title>
532 #: best-pkging-practices.dbk:362
533 msgid "Vcs-*"
534 msgstr ""
535
536 # type: Content of: <chapter><section><section><section><para>
537 #: best-pkging-practices.dbk:364
538 msgid ""
539 "Value of this field should be a string identifying unequivocally the "
540 "location of the Version Control System repository used to maintain the given "
541 "package, if available.  <literal>*</literal> identify the Version Control "
542 "System; currently the following systems are supported by the package "
543 "tracking system: <literal>arch</literal>, <literal>bzr</literal> (Bazaar), "
544 "<literal>cvs</literal>, <literal>darcs</literal>, <literal>git</literal>, "
545 "<literal>hg</literal> (Mercurial), <literal>mtn</literal> (Monotone), "
546 "<literal>svn</literal> (Subversion).  It is allowed to specify different VCS "
547 "fields for the same package: they will all be shown in the PTS web interface."
548 msgstr ""
549
550 # type: Content of: <chapter><section><section><section><para>
551 #: best-pkging-practices.dbk:375
552 msgid ""
553 "The information is meant to be useful for a user knowledgeable in the given "
554 "Version Control System and willing to build the current version of a package "
555 "from the VCS sources.  Other uses of this information might include "
556 "automatic building of the latest VCS version of the given package.  To this "
557 "end the location pointed to by the field should better be version agnostic "
558 "and point to the main branch (for VCSs supporting such a concept).  Also, "
559 "the location pointed to should be accessible to the final user; fulfilling "
560 "this requirement might imply pointing to an anonymous access of the "
561 "repository instead of pointing to an SSH-accessible version of the same."
562 msgstr ""
563
564 # type: Content of: <chapter><section><section><section><para>
565 #: best-pkging-practices.dbk:386
566 msgid ""
567 "In the following example, an instance of the field for a Subversion "
568 "repository of the <systemitem role=\"package\">vim</systemitem> package is "
569 "shown.  Note how the URL is in the <literal>svn://</literal> scheme (instead "
570 "of <literal>svn+ssh://</literal>) and how it points to the <filename>trunk/</"
571 "filename> branch.  The use of the <literal>Vcs-Browser</literal> and "
572 "<literal>Homepage</literal> fields described above is also shown."
573 msgstr ""
574
575 # type: Content of: <chapter><section><section><section><screen>
576 #: best-pkging-practices.dbk:394
577 #, no-wrap
578 msgid ""
579 "\n"
580 "  Source: vim\n"
581 "  Section: editors\n"
582 "  Priority: optional\n"
583 "  &lt;snip&gt;\n"
584 "  Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim\n"
585 "  Vcs-Browser: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim\n"
586 "  Homepage: http://www.vim.org\n"
587 msgstr ""
588
589 # type: Content of: <chapter><section><title>
590 #: best-pkging-practices.dbk:410
591 msgid "Best practices for <filename>debian/changelog</filename>"
592 msgstr ""
593
594 # type: Content of: <chapter><section><para>
595 #: best-pkging-practices.dbk:412
596 msgid ""
597 "The following practices supplement the <ulink url=\"&url-debian-policy;ch-"
598 "docs.html#s-changelogs\">Policy on changelog files</ulink>."
599 msgstr ""
600
601 # type: Content of: <chapter><section><section><title>
602 #: best-pkging-practices.dbk:417
603 msgid "Writing useful changelog entries"
604 msgstr ""
605
606 # type: Content of: <chapter><section><section><para>
607 #: best-pkging-practices.dbk:419
608 msgid ""
609 "The changelog entry for a package revision documents changes in that "
610 "revision, and only them.  Concentrate on describing significant and user-"
611 "visible changes that were made since the last version."
612 msgstr ""
613
614 # type: Content of: <chapter><section><section><para>
615 #: best-pkging-practices.dbk:424
616 msgid ""
617 "Focus on <emphasis>what</emphasis> was changed — who, how and when are "
618 "usually less important.  Having said that, remember to politely attribute "
619 "people who have provided notable help in making the package (e.g., those who "
620 "have sent in patches)."
621 msgstr ""
622
623 # type: Content of: <chapter><section><section><para>
624 #: best-pkging-practices.dbk:430
625 msgid ""
626 "There's no need to elaborate the trivial and obvious changes.  You can also "
627 "aggregate several changes in one entry.  On the other hand, don't be overly "
628 "terse if you have undertaken a major change.  Be especially clear if there "
629 "are changes that affect the behaviour of the program.  For further "
630 "explanations, use the <filename>README.Debian</filename> file."
631 msgstr ""
632
633 # type: Content of: <chapter><section><section><para>
634 #: best-pkging-practices.dbk:437
635 msgid ""
636 "Use common English so that the majority of readers can comprehend it.  Avoid "
637 "abbreviations, tech-speak and jargon when explaining changes that close "
638 "bugs, especially for bugs filed by users that did not strike you as "
639 "particularly technically savvy.  Be polite, don't swear."
640 msgstr ""
641
642 # type: Content of: <chapter><section><section><para>
643 #: best-pkging-practices.dbk:443
644 msgid ""
645 "It is sometimes desirable to prefix changelog entries with the names of the "
646 "files that were changed.  However, there's no need to explicitly list each "
647 "and every last one of the changed files, especially if the change was small "
648 "or repetitive.  You may use wildcards."
649 msgstr ""
650
651 # type: Content of: <chapter><section><section><para>
652 #: best-pkging-practices.dbk:449
653 msgid ""
654 "When referring to bugs, don't assume anything.  Say what the problem was, "
655 "how it was fixed, and append the closes: #nnnnn string.  See <xref linkend="
656 "\"upload-bugfix\"/> for more information."
657 msgstr ""
658
659 # type: Content of: <chapter><section><section><title>
660 #: best-pkging-practices.dbk:456
661 msgid "Common misconceptions about changelog entries"
662 msgstr ""
663
664 # type: Content of: <chapter><section><section><para>
665 #: best-pkging-practices.dbk:458
666 msgid ""
667 "The changelog entries should <emphasis role=\"strong\">not</emphasis> "
668 "document generic packaging issues (Hey, if you're looking for foo.conf, it's "
669 "in /etc/blah/.), since administrators and users are supposed to be at least "
670 "remotely acquainted with how such things are generally arranged on Debian "
671 "systems.  Do, however, mention if you change the location of a configuration "
672 "file."
673 msgstr ""
674
675 # type: Content of: <chapter><section><section><para>
676 #: best-pkging-practices.dbk:466
677 msgid ""
678 "The only bugs closed with a changelog entry should be those that are "
679 "actually fixed in the same package revision.  Closing unrelated bugs in the "
680 "changelog is bad practice.  See <xref linkend=\"upload-bugfix\"/> ."
681 msgstr ""
682
683 # type: Content of: <chapter><section><section><para>
684 #: best-pkging-practices.dbk:471
685 msgid ""
686 "The changelog entries should <emphasis role=\"strong\">not</emphasis> be "
687 "used for random discussion with bug reporters (I don't see segfaults when "
688 "starting foo with option bar; send in more info), general statements on "
689 "life, the universe and everything (sorry this upload took me so long, but I "
690 "caught the flu), or pleas for help (the bug list on this package is huge, "
691 "please lend me a hand).  Such things usually won't be noticed by their "
692 "target audience, but may annoy people who wish to read information about "
693 "actual changes in the package.  See <xref linkend=\"bug-answering\"/> for "
694 "more information on how to use the bug tracking system."
695 msgstr ""
696
697 # type: Content of: <chapter><section><section><para>
698 #: best-pkging-practices.dbk:482
699 msgid ""
700 "It is an old tradition to acknowledge bugs fixed in non-maintainer uploads "
701 "in the first changelog entry of the proper maintainer upload.  As we have "
702 "version tracking now, it is enough to keep the NMUed changelog entries and "
703 "just mention this fact in your own changelog entry."
704 msgstr ""
705
706 # type: Content of: <chapter><section><section><title>
707 #: best-pkging-practices.dbk:490
708 msgid "Common errors in changelog entries"
709 msgstr ""
710
711 # type: Content of: <chapter><section><section><para>
712 #: best-pkging-practices.dbk:492
713 msgid ""
714 "The following examples demonstrate some common errors or examples of bad "
715 "style in changelog entries."
716 msgstr ""
717
718 # type: Content of: <chapter><section><section><screen>
719 #: best-pkging-practices.dbk:495
720 #, no-wrap
721 msgid ""
722 "\n"
723 "  * Fixed all outstanding bugs.\n"
724 msgstr ""
725
726 # type: Content of: <chapter><section><section><para>
727 #: best-pkging-practices.dbk:499
728 msgid "This doesn't tell readers anything too useful, obviously."
729 msgstr ""
730
731 # type: Content of: <chapter><section><section><screen>
732 #: best-pkging-practices.dbk:501
733 #, no-wrap
734 msgid ""
735 "\n"
736 "  * Applied patch from Jane Random.\n"
737 msgstr ""
738
739 # type: Content of: <chapter><section><section><para>
740 #: best-pkging-practices.dbk:505
741 msgid "What was the patch about?"
742 msgstr ""
743
744 # type: Content of: <chapter><section><section><screen>
745 #: best-pkging-practices.dbk:507
746 #, no-wrap
747 msgid ""
748 "\n"
749 "  * Late night install target overhaul.\n"
750 msgstr ""
751
752 # type: Content of: <chapter><section><section><para>
753 #: best-pkging-practices.dbk:511
754 msgid ""
755 "Overhaul which accomplished what? Is the mention of late night supposed to "
756 "remind us that we shouldn't trust that code?"
757 msgstr ""
758
759 # type: Content of: <chapter><section><section><screen>
760 #: best-pkging-practices.dbk:514
761 #, no-wrap
762 msgid ""
763 "\n"
764 "  * Fix vsync FU w/ ancient CRTs.\n"
765 msgstr ""
766
767 # type: Content of: <chapter><section><section><para>
768 #: best-pkging-practices.dbk:518
769 msgid ""
770 "Too many acronyms, and it's not overly clear what the, uh, fsckup (oops, a "
771 "curse word!) was actually about, or how it was fixed."
772 msgstr ""
773
774 # type: Content of: <chapter><section><section><screen>
775 #: best-pkging-practices.dbk:521
776 #, no-wrap
777 msgid ""
778 "\n"
779 "  * This is not a bug, closes: #nnnnnn.\n"
780 msgstr ""
781
782 # type: Content of: <chapter><section><section><para>
783 #: best-pkging-practices.dbk:525
784 msgid ""
785 "First of all, there's absolutely no need to upload the package to convey "
786 "this information; instead, use the bug tracking system.  Secondly, there's "
787 "no explanation as to why the report is not a bug."
788 msgstr ""
789
790 # type: Content of: <chapter><section><section><screen>
791 #: best-pkging-practices.dbk:529
792 #, no-wrap
793 msgid ""
794 "\n"
795 "  * Has been fixed for ages, but I forgot to close; closes: #54321.\n"
796 msgstr ""
797
798 # type: Content of: <chapter><section><section><para>
799 #: best-pkging-practices.dbk:533
800 msgid ""
801 "If for some reason you didn't mention the bug number in a previous changelog "
802 "entry, there's no problem, just close the bug normally in the BTS.  There's "
803 "no need to touch the changelog file, presuming the description of the fix is "
804 "already in (this applies to the fixes by the upstream authors/maintainers as "
805 "well, you don't have to track bugs that they fixed ages ago in your "
806 "changelog)."
807 msgstr ""
808
809 # type: Content of: <chapter><section><section><screen>
810 #: best-pkging-practices.dbk:539
811 #, no-wrap
812 msgid ""
813 "\n"
814 "  * Closes: #12345, #12346, #15432\n"
815 msgstr ""
816
817 # type: Content of: <chapter><section><section><para>
818 #: best-pkging-practices.dbk:543
819 msgid ""
820 "Where's the description? If you can't think of a descriptive message, start "
821 "by inserting the title of each different bug."
822 msgstr ""
823
824 # type: Content of: <chapter><section><section><title>
825 #: best-pkging-practices.dbk:549
826 msgid "Supplementing changelogs with NEWS.Debian files"
827 msgstr ""
828
829 # type: Content of: <chapter><section><section><para>
830 #: best-pkging-practices.dbk:551
831 msgid ""
832 "Important news about changes in a package can also be put in NEWS.Debian "
833 "files.  The news will be displayed by tools like apt-listchanges, before all "
834 "the rest of the changelogs.  This is the preferred means to let the user "
835 "know about significant changes in a package.  It is better than using "
836 "debconf notes since it is less annoying and the user can go back and refer "
837 "to the NEWS.Debian file after the install.  And it's better than listing "
838 "major changes in README.Debian, since the user can easily miss such notes."
839 msgstr ""
840
841 # type: Content of: <chapter><section><section><para>
842 #: best-pkging-practices.dbk:560
843 msgid ""
844 "The file format is the same as a debian changelog file, but leave off the "
845 "asterisks and describe each news item with a full paragraph when necessary "
846 "rather than the more concise summaries that would go in a changelog.  It's a "
847 "good idea to run your file through dpkg-parsechangelog to check its "
848 "formatting as it will not be automatically checked during build as the "
849 "changelog is.  Here is an example of a real NEWS.Debian file:"
850 msgstr ""
851
852 # type: Content of: <chapter><section><section><screen>
853 #: best-pkging-practices.dbk:567
854 #, no-wrap
855 msgid ""
856 "\n"
857 "cron (3.0pl1-74) unstable; urgency=low\n"
858 "\n"
859 "    The checksecurity script is no longer included with the cron package:\n"
860 "    it now has its own package, checksecurity. If you liked the\n"
861 "    functionality provided with that script, please install the new\n"
862 "    package.\n"
863 "\n"
864 " -- Steve Greenland &lt;stevegr@debian.org&gt;  Sat,  6 Sep 2003 17:15:03 -0500\n"
865 msgstr ""
866
867 # type: Content of: <chapter><section><section><para>
868 #: best-pkging-practices.dbk:578
869 msgid ""
870 "The NEWS.Debian file is installed as /usr/share/doc/&lt;package&gt;/NEWS."
871 "Debian.gz.  It is compressed, and always has that name even in Debian native "
872 "packages.  If you use debhelper, dh_installchangelogs will install debian/"
873 "NEWS files for you."
874 msgstr ""
875
876 # type: Content of: <chapter><section><section><para>
877 #: best-pkging-practices.dbk:584
878 msgid ""
879 "Unlike changelog files, you need not update NEWS.Debian files with every "
880 "release.  Only update them if you have something particularly newsworthy "
881 "that user should know about.  If you have no news at all, there's no need to "
882 "ship a NEWS.Debian file in your package.  No news is good news!"
883 msgstr ""
884
885 # type: Content of: <chapter><section><title>
886 #: best-pkging-practices.dbk:605
887 msgid "Best practices for maintainer scripts"
888 msgstr ""
889
890 # type: Content of: <chapter><section><para>
891 #: best-pkging-practices.dbk:607
892 msgid ""
893 "Maintainer scripts include the files <filename>debian/postinst</filename>, "
894 "<filename>debian/preinst</filename>, <filename>debian/prerm</filename> and "
895 "<filename>debian/postrm</filename>.  These scripts take care of any package "
896 "installation or deinstallation setup which isn't handled merely by the "
897 "creation or removal of files and directories.  The following instructions "
898 "supplement the <ulink url=\"&url-debian-policy;\">Debian Policy</ulink>."
899 msgstr ""
900
901 # type: Content of: <chapter><section><para>
902 #: best-pkging-practices.dbk:615
903 msgid ""
904 "Maintainer scripts must be idempotent.  That means that you need to make "
905 "sure nothing bad will happen if the script is called twice where it would "
906 "usually be called once."
907 msgstr ""
908
909 # type: Content of: <chapter><section><para>
910 #: best-pkging-practices.dbk:620
911 msgid ""
912 "Standard input and output may be redirected (e.g.  into pipes) for logging "
913 "purposes, so don't rely on them being a tty."
914 msgstr ""
915
916 # type: Content of: <chapter><section><para>
917 #: best-pkging-practices.dbk:624
918 msgid ""
919 "All prompting or interactive configuration should be kept to a minimum.  "
920 "When it is necessary, you should use the <systemitem role=\"package"
921 "\">debconf</systemitem> package for the interface.  Remember that prompting "
922 "in any case can only be in the <literal>configure</literal> stage of the "
923 "<filename>postinst</filename> script."
924 msgstr ""
925
926 # type: Content of: <chapter><section><para>
927 #: best-pkging-practices.dbk:631
928 msgid ""
929 "Keep the maintainer scripts as simple as possible.  We suggest you use pure "
930 "POSIX shell scripts.  Remember, if you do need any bash features, the "
931 "maintainer script must have a bash shebang line.  POSIX shell or Bash are "
932 "preferred to Perl, since they enable <systemitem role=\"package\">debhelper</"
933 "systemitem> to easily add bits to the scripts."
934 msgstr ""
935
936 # type: Content of: <chapter><section><para>
937 #: best-pkging-practices.dbk:638
938 msgid ""
939 "If you change your maintainer scripts, be sure to test package removal, "
940 "double installation, and purging.  Be sure that a purged package is "
941 "completely gone, that is, it must remove any files created, directly or "
942 "indirectly, in any maintainer script."
943 msgstr ""
944
945 # type: Content of: <chapter><section><para>
946 #: best-pkging-practices.dbk:644
947 msgid ""
948 "If you need to check for the existence of a command, you should use "
949 "something like"
950 msgstr ""
951
952 # type: Content of: <chapter><section><programlisting>
953 #: best-pkging-practices.dbk:647
954 #, no-wrap
955 msgid "if [ -x /usr/sbin/install-docs ]; then ..."
956 msgstr ""
957
958 # type: Content of: <chapter><section><para>
959 #: best-pkging-practices.dbk:649
960 msgid ""
961 "If you don't wish to hard-code the path of a command in your maintainer "
962 "script, the following POSIX-compliant shell function may help:"
963 msgstr ""
964
965 # type: Content of: <chapter><section><para>
966 #: best-pkging-practices.dbk:654
967 msgid ""
968 "You can use this function to search <literal>$PATH</literal> for a command "
969 "name, passed as an argument.  It returns true (zero) if the command was "
970 "found, and false if not.  This is really the most portable way, since "
971 "<literal>command -v</literal>, <command>type</command>, and <command>which</"
972 "command> are not POSIX."
973 msgstr ""
974
975 # type: Content of: <chapter><section><para>
976 #: best-pkging-practices.dbk:661
977 msgid ""
978 "While <command>which</command> is an acceptable alternative, since it is "
979 "from the required <systemitem role=\"package\">debianutils</systemitem> "
980 "package, it's not on the root partition.  That is, it's in <filename>/usr/"
981 "bin</filename> rather than <filename>/bin</filename>, so one can't use it in "
982 "scripts which are run before the <filename>/usr</filename> partition is "
983 "mounted.  Most scripts won't have this problem, though."
984 msgstr ""
985
986 # type: Content of: <chapter><section><title>
987 #: best-pkging-practices.dbk:671
988 msgid ""
989 "Configuration management with <systemitem role=\"package\">debconf</"
990 "systemitem>"
991 msgstr ""
992
993 # type: Content of: <chapter><section><para>
994 #: best-pkging-practices.dbk:673
995 msgid ""
996 "<systemitem role=\"package\">Debconf</systemitem> is a configuration "
997 "management system which can be used by all the various packaging scripts "
998 "(<filename>postinst</filename> mainly) to request feedback from the user "
999 "concerning how to configure the package.  Direct user interactions must now "
1000 "be avoided in favor of <systemitem role=\"package\">debconf</systemitem> "
1001 "interaction.  This will enable non-interactive installations in the future."
1002 msgstr ""
1003
1004 # type: Content of: <chapter><section><para>
1005 #: best-pkging-practices.dbk:681
1006 msgid ""
1007 "Debconf is a great tool but it is often poorly used.  Many common mistakes "
1008 "are listed in the <citerefentry> <refentrytitle>debconf-devel</"
1009 "refentrytitle> <manvolnum>7</manvolnum> </citerefentry> man page.  It is "
1010 "something that you must read if you decide to use debconf.  Also, we "
1011 "document some best practices here."
1012 msgstr ""
1013
1014 # type: Content of: <chapter><section><para>
1015 #: best-pkging-practices.dbk:688
1016 msgid ""
1017 "These guidelines include some writing style and typography recommendations, "
1018 "general considerations about debconf usage as well as more specific "
1019 "recommendations for some parts of the distribution (the installation system "
1020 "for instance)."
1021 msgstr ""
1022
1023 # type: Content of: <chapter><section><section><title>
1024 #: best-pkging-practices.dbk:694
1025 msgid "Do not abuse debconf"
1026 msgstr ""
1027
1028 # type: Content of: <chapter><section><section><para>
1029 #: best-pkging-practices.dbk:696
1030 msgid ""
1031 "Since debconf appeared in Debian, it has been widely abused and several "
1032 "criticisms received by the Debian distribution come from debconf abuse with "
1033 "the need of answering a wide bunch of questions before getting any little "
1034 "thing installed."
1035 msgstr ""
1036
1037 # type: Content of: <chapter><section><section><para>
1038 #: best-pkging-practices.dbk:702
1039 msgid ""
1040 "Keep usage notes to what they belong: the NEWS.Debian, or README.Debian "
1041 "file.  Only use notes for important notes which may directly affect the "
1042 "package usability.  Remember that notes will always block the install until "
1043 "confirmed or bother the user by email."
1044 msgstr ""
1045
1046 # type: Content of: <chapter><section><section><para>
1047 #: best-pkging-practices.dbk:708
1048 msgid ""
1049 "Carefully choose the questions priorities in maintainer scripts.  See "
1050 "<citerefentry> <refentrytitle>debconf-devel</refentrytitle> <manvolnum>7</"
1051 "manvolnum> </citerefentry> for details about priorities.  Most questions "
1052 "should use medium and low priorities."
1053 msgstr ""
1054
1055 # type: Content of: <chapter><section><section><title>
1056 #: best-pkging-practices.dbk:716
1057 msgid "General recommendations for authors and translators"
1058 msgstr ""
1059
1060 # type: Content of: <chapter><section><section><section><title>
1061 #: best-pkging-practices.dbk:718
1062 msgid "Write correct English"
1063 msgstr ""
1064
1065 # type: Content of: <chapter><section><section><section><para>
1066 #: best-pkging-practices.dbk:720
1067 msgid ""
1068 "Most Debian package maintainers are not native English speakers.  So, "
1069 "writing properly phrased templates may not be easy for them."
1070 msgstr ""
1071
1072 # type: Content of: <chapter><section><section><section><para>
1073 #: best-pkging-practices.dbk:724
1074 msgid ""
1075 "Please use (and abuse) &email-debian-l10n-english; mailing list.  Have your "
1076 "templates proofread."
1077 msgstr ""
1078
1079 # type: Content of: <chapter><section><section><section><para>
1080 #: best-pkging-practices.dbk:728
1081 msgid ""
1082 "Badly written templates give a poor image of your package, of your work...or "
1083 "even of Debian itself."
1084 msgstr ""
1085
1086 # type: Content of: <chapter><section><section><section><para>
1087 #: best-pkging-practices.dbk:732
1088 msgid ""
1089 "Avoid technical jargon as much as possible.  If some terms sound common to "
1090 "you, they may be impossible to understand for others.  If you cannot avoid "
1091 "them, try to explain them (use the extended description).  When doing so, "
1092 "try to balance between verbosity and simplicity."
1093 msgstr ""
1094
1095 # type: Content of: <chapter><section><section><section><title>
1096 #: best-pkging-practices.dbk:740
1097 msgid "Be kind to translators"
1098 msgstr ""
1099
1100 # type: Content of: <chapter><section><section><section><para>
1101 #: best-pkging-practices.dbk:742
1102 msgid ""
1103 "Debconf templates may be translated.  Debconf, along with its sister package "
1104 "<command>po-debconf</command> offers a simple framework for getting "
1105 "templates translated by translation teams or even individuals."
1106 msgstr ""
1107
1108 # type: Content of: <chapter><section><section><section><para>
1109 #: best-pkging-practices.dbk:747
1110 msgid ""
1111 "Please use gettext-based templates.  Install <systemitem role=\"package\">po-"
1112 "debconf</systemitem> on your development system and read its documentation "
1113 "(man po-debconf is a good start)."
1114 msgstr ""
1115
1116 # type: Content of: <chapter><section><section><section><para>
1117 #: best-pkging-practices.dbk:752
1118 msgid ""
1119 "Avoid changing templates too often.  Changing templates text induces more "
1120 "work to translators which will get their translation fuzzied.  If you plan "
1121 "changes to your original templates, please contact translators.  Most active "
1122 "translators are very responsive and getting their work included along with "
1123 "your modified templates will save you additional uploads.  If you use "
1124 "gettext-based templates, the translator's name and e-mail addresses are "
1125 "mentioned in the po files headers."
1126 msgstr ""
1127
1128 # type: Content of: <chapter><section><section><section><para>
1129 #: best-pkging-practices.dbk:761
1130 msgid ""
1131 "The use of the <command>podebconf-report-po</command> from the po-debconf "
1132 "package is highly recommended to warn translators which have incomplete "
1133 "translations and request them for updates."
1134 msgstr ""
1135
1136 # type: Content of: <chapter><section><section><section><para>
1137 #: best-pkging-practices.dbk:766
1138 msgid ""
1139 "If in doubt, you may also contact the translation team for a given language "
1140 "(debian-l10n-xxxxx@&lists-host;), or the &email-debian-i18n; mailing list."
1141 msgstr ""
1142
1143 # type: Content of: <chapter><section><section><section><para>
1144 #: best-pkging-practices.dbk:771
1145 msgid ""
1146 "Calls for translations posted to &email-debian-i18n; with the "
1147 "<filename>debian/po/templates.pot</filename> file attached or referenced in "
1148 "a URL are encouraged.  Be sure to mentions in these calls for new "
1149 "translations which languages you have existing translations for, in order to "
1150 "avoid duplicate work."
1151 msgstr ""
1152
1153 # type: Content of: <chapter><section><section><section><title>
1154 #: best-pkging-practices.dbk:780
1155 msgid "Unfuzzy complete translations when correcting typos and spelling"
1156 msgstr ""
1157
1158 # type: Content of: <chapter><section><section><section><para>
1159 #: best-pkging-practices.dbk:782
1160 msgid ""
1161 "When the text of a debconf template is corrected and you are <emphasis role="
1162 "\"strong\">sure</emphasis> that the change does <emphasis role=\"strong"
1163 "\">not</emphasis> affect translations, please be kind to translators and "
1164 "unfuzzy their translations."
1165 msgstr ""
1166
1167 # type: Content of: <chapter><section><section><section><para>
1168 #: best-pkging-practices.dbk:788
1169 msgid ""
1170 "If you don't do so, the whole template will not be translated as long as a "
1171 "translator will send you an update."
1172 msgstr ""
1173
1174 # type: Content of: <chapter><section><section><section><para>
1175 #: best-pkging-practices.dbk:792
1176 msgid ""
1177 "To <emphasis role=\"strong\">unfuzzy</emphasis> translations, you can "
1178 "proceed the following way:"
1179 msgstr ""
1180
1181 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1182 #: best-pkging-practices.dbk:798
1183 msgid ""
1184 "Put all incomplete PO files out of the way.  You can check the completeness "
1185 "by using (needs the <systemitem role=\"package\">gettext</systemitem> "
1186 "package installed):"
1187 msgstr ""
1188
1189 # type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1190 #: best-pkging-practices.dbk:802
1191 #, no-wrap
1192 msgid ""
1193 "for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null\n"
1194 "--statistics $i; done"
1195 msgstr ""
1196
1197 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1198 #: best-pkging-practices.dbk:807
1199 msgid ""
1200 "move all files which report either fuzzy strings to a temporary place.  "
1201 "Files which report no fuzzy strings (only translated and untranslated) will "
1202 "be kept in place."
1203 msgstr ""
1204
1205 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1206 #: best-pkging-practices.dbk:814
1207 msgid ""
1208 "now <emphasis role=\"strong\">and now only</emphasis>, modify the template "
1209 "for the typos and check again that translation are not impacted (typos, "
1210 "spelling errors, sometimes typographical corrections are usually OK)"
1211 msgstr ""
1212
1213 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1214 #: best-pkging-practices.dbk:821
1215 msgid ""
1216 "run <command>debconf-updatepo</command>.  This will fuzzy all strings you "
1217 "modified in translations.  You can see this by running the above again"
1218 msgstr ""
1219
1220 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1221 #: best-pkging-practices.dbk:827
1222 msgid "use the following command:"
1223 msgstr ""
1224
1225 # type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1226 #: best-pkging-practices.dbk:829
1227 #, no-wrap
1228 msgid "for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done"
1229 msgstr ""
1230
1231 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1232 #: best-pkging-practices.dbk:833
1233 msgid ""
1234 "move back to debian/po the files which showed fuzzy strings in the first step"
1235 msgstr ""
1236
1237 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1238 #: best-pkging-practices.dbk:838
1239 msgid "run <command>debconf-updatepo</command> again"
1240 msgstr ""
1241
1242 # type: Content of: <chapter><section><section><section><title>
1243 #: best-pkging-practices.dbk:845
1244 msgid "Do not make assumptions about interfaces"
1245 msgstr ""
1246
1247 # type: Content of: <chapter><section><section><section><para>
1248 #: best-pkging-practices.dbk:847
1249 msgid ""
1250 "Templates text should not make reference to widgets belonging to some "
1251 "debconf interfaces.  Sentences like If you answer Yes...  have no meaning "
1252 "for users of graphical interfaces which use checkboxes for boolean questions."
1253 msgstr ""
1254
1255 # type: Content of: <chapter><section><section><section><para>
1256 #: best-pkging-practices.dbk:852
1257 msgid ""
1258 "String templates should also avoid mentioning the default values in their "
1259 "description.  First, because this is redundant with the values seen by the "
1260 "users.  Also, because these default values may be different from the "
1261 "maintainer choices (for instance, when the debconf database was preseeded)."
1262 msgstr ""
1263
1264 # type: Content of: <chapter><section><section><section><para>
1265 #: best-pkging-practices.dbk:858
1266 msgid ""
1267 "More generally speaking, try to avoid referring to user actions.  Just give "
1268 "facts."
1269 msgstr ""
1270
1271 # type: Content of: <chapter><section><section><section><title>
1272 #: best-pkging-practices.dbk:864
1273 msgid "Do not use first person"
1274 msgstr ""
1275
1276 # type: Content of: <chapter><section><section><section><para>
1277 #: best-pkging-practices.dbk:866
1278 msgid ""
1279 "You should avoid the use of first person (I will do this...  or We "
1280 "recommend...).  The computer is not a person and the Debconf templates do "
1281 "not speak for the Debian developers.  You should use neutral construction.  "
1282 "Those of you who already wrote scientific publications, just write your "
1283 "templates like you would write a scientific paper.  However, try using "
1284 "action voice if still possible, like Enable this if ...  instead of This can "
1285 "be enabled if ...."
1286 msgstr ""
1287
1288 # type: Content of: <chapter><section><section><section><title>
1289 #: best-pkging-practices.dbk:876
1290 msgid "Be gender neutral"
1291 msgstr ""
1292
1293 # type: Content of: <chapter><section><section><section><para>
1294 #: best-pkging-practices.dbk:878
1295 msgid ""
1296 "The world is made of men and women.  Please use gender-neutral constructions "
1297 "in your writing."
1298 msgstr ""
1299
1300 # type: Content of: <chapter><section><section><title>
1301 #: best-pkging-practices.dbk:886
1302 msgid "Templates fields definition"
1303 msgstr ""
1304
1305 # type: Content of: <chapter><section><section><para>
1306 #: best-pkging-practices.dbk:888
1307 msgid ""
1308 "This part gives some information which is mostly taken from the "
1309 "<citerefentry> <refentrytitle>debconf-devel</refentrytitle> <manvolnum>7</"
1310 "manvolnum> </citerefentry> manual page."
1311 msgstr ""
1312
1313 # type: Content of: <chapter><section><section><section><title>
1314 #: best-pkging-practices.dbk:893
1315 msgid "Type"
1316 msgstr ""
1317
1318 # type: Content of: <chapter><section><section><section><section><title>
1319 #: best-pkging-practices.dbk:895
1320 msgid "string:"
1321 msgstr ""
1322
1323 # type: Content of: <chapter><section><section><section><section><para>
1324 #: best-pkging-practices.dbk:897
1325 msgid ""
1326 "Results in a free-form input field that the user can type any string into."
1327 msgstr ""
1328
1329 # type: Content of: <chapter><section><section><section><section><title>
1330 #: best-pkging-practices.dbk:902
1331 msgid "password:"
1332 msgstr ""
1333
1334 # type: Content of: <chapter><section><section><section><section><para>
1335 #: best-pkging-practices.dbk:904
1336 msgid ""
1337 "Prompts the user for a password.  Use this with caution; be aware that the "
1338 "password the user enters will be written to debconf's database.  You should "
1339 "probably clean that value out of the database as soon as is possible."
1340 msgstr ""
1341
1342 # type: Content of: <chapter><section><section><section><section><title>
1343 #: best-pkging-practices.dbk:911
1344 msgid "boolean:"
1345 msgstr ""
1346
1347 # type: Content of: <chapter><section><section><section><section><para>
1348 #: best-pkging-practices.dbk:913
1349 msgid ""
1350 "A true/false choice.  Remember: true/false, <emphasis role=\"strong\">not "
1351 "yes/no</emphasis>..."
1352 msgstr ""
1353
1354 # type: Content of: <chapter><section><section><section><section><title>
1355 #: best-pkging-practices.dbk:919
1356 msgid "select:"
1357 msgstr ""
1358
1359 # type: Content of: <chapter><section><section><section><section><para>
1360 #: best-pkging-practices.dbk:921
1361 msgid ""
1362 "A choice between one of a number of values.  The choices must be specified "
1363 "in a field named 'Choices'.  Separate the possible values with commas and "
1364 "spaces, like this: Choices: yes, no, maybe"
1365 msgstr ""
1366
1367 # type: Content of: <chapter><section><section><section><section><title>
1368 #: best-pkging-practices.dbk:928
1369 msgid "multiselect:"
1370 msgstr ""
1371
1372 # type: Content of: <chapter><section><section><section><section><para>
1373 #: best-pkging-practices.dbk:930
1374 msgid ""
1375 "Like the select data type, except the user can choose any number of items "
1376 "from the choices list (or chose none of them)."
1377 msgstr ""
1378
1379 # type: Content of: <chapter><section><section><section><section><title>
1380 #: best-pkging-practices.dbk:936
1381 msgid "note:"
1382 msgstr ""
1383
1384 # type: Content of: <chapter><section><section><section><section><para>
1385 #: best-pkging-practices.dbk:938
1386 msgid ""
1387 "Rather than being a question per se, this datatype indicates a note that can "
1388 "be displayed to the user.  It should be used only for important notes that "
1389 "the user really should see, since debconf will go to great pains to make "
1390 "sure the user sees it; halting the install for them to press a key, and even "
1391 "mailing the note to them in some cases."
1392 msgstr ""
1393
1394 # type: Content of: <chapter><section><section><section><section><title>
1395 #: best-pkging-practices.dbk:947
1396 msgid "text:"
1397 msgstr ""
1398
1399 # type: Content of: <chapter><section><section><section><section><para>
1400 #: best-pkging-practices.dbk:949
1401 msgid "This type is now considered obsolete: don't use it."
1402 msgstr ""
1403
1404 # type: Content of: <chapter><section><section><section><section><title>
1405 #: best-pkging-practices.dbk:954
1406 msgid "error:"
1407 msgstr ""
1408
1409 # type: Content of: <chapter><section><section><section><section><para>
1410 #: best-pkging-practices.dbk:956
1411 msgid ""
1412 "This type is designed to handle error messages.  It is mostly similar to the "
1413 "note type.  Frontends may present it differently (for instance, the dialog "
1414 "frontend of cdebconf draws a red screen instead of the usual blue one)."
1415 msgstr ""
1416
1417 # type: Content of: <chapter><section><section><section><section><para>
1418 #: best-pkging-practices.dbk:961
1419 msgid ""
1420 "It is recommended to use this type for any message that needs user attention "
1421 "for a correction of any kind."
1422 msgstr ""
1423
1424 # type: Content of: <chapter><section><section><section><title>
1425 #: best-pkging-practices.dbk:969
1426 msgid "Description: short and extended description"
1427 msgstr ""
1428
1429 # type: Content of: <chapter><section><section><section><para>
1430 #: best-pkging-practices.dbk:971
1431 msgid ""
1432 "Template descriptions have two parts: short and extended.  The short "
1433 "description is in the Description: line of the template."
1434 msgstr ""
1435
1436 # type: Content of: <chapter><section><section><section><para>
1437 #: best-pkging-practices.dbk:975
1438 msgid ""
1439 "The short description should be kept short (50 characters or so) so that it "
1440 "may be accomodated by most debconf interfaces.  Keeping it short also helps "
1441 "translators, as usually translations tend to end up being longer than the "
1442 "original."
1443 msgstr ""
1444
1445 # type: Content of: <chapter><section><section><section><para>
1446 #: best-pkging-practices.dbk:981
1447 msgid ""
1448 "The short description should be able to stand on its own.  Some interfaces "
1449 "do not show the long description by default, or only if the user explicitely "
1450 "asks for it or even do not show it at all.  Avoid things like What do you "
1451 "want to do?"
1452 msgstr ""
1453
1454 # type: Content of: <chapter><section><section><section><para>
1455 #: best-pkging-practices.dbk:987
1456 msgid ""
1457 "The short description does not necessarily have to be a full sentence.  This "
1458 "is part of the keep it short and efficient recommendation."
1459 msgstr ""
1460
1461 # type: Content of: <chapter><section><section><section><para>
1462 #: best-pkging-practices.dbk:991
1463 msgid ""
1464 "The extended description should not repeat the short description word for "
1465 "word.  If you can't think up a long description, then first, think some "
1466 "more.  Post to debian-devel.  Ask for help.  Take a writing class! That "
1467 "extended description is important.  If after all that you still can't come "
1468 "up with anything, leave it blank."
1469 msgstr ""
1470
1471 # type: Content of: <chapter><section><section><section><para>
1472 #: best-pkging-practices.dbk:998
1473 msgid ""
1474 "The extended description should use complete sentences.  Paragraphs should "
1475 "be kept short for improved readability.  Do not mix two ideas in the same "
1476 "paragraph but rather use another paragraph."
1477 msgstr ""
1478
1479 # type: Content of: <chapter><section><section><section><para>
1480 #: best-pkging-practices.dbk:1003
1481 msgid ""
1482 "Don't be too verbose.  User tend to ignore too long screens.  20 lines are "
1483 "by experience a border you shouldn't cross, because that means that in the "
1484 "classical dialog interface, people will need to scroll, and lot of people "
1485 "just don't do that."
1486 msgstr ""
1487
1488 # type: Content of: <chapter><section><section><section><para>
1489 #: best-pkging-practices.dbk:1009
1490 msgid ""
1491 "The extended description should <emphasis role=\"strong\">never</emphasis> "
1492 "include a question."
1493 msgstr ""
1494
1495 # type: Content of: <chapter><section><section><section><para>
1496 #: best-pkging-practices.dbk:1013
1497 msgid ""
1498 "For specific rules depending on templates type (string, boolean, etc.), "
1499 "please read below."
1500 msgstr ""
1501
1502 # type: Content of: <chapter><section><section><section><title>
1503 #: best-pkging-practices.dbk:1019
1504 msgid "Choices"
1505 msgstr ""
1506
1507 # type: Content of: <chapter><section><section><section><para>
1508 #: best-pkging-practices.dbk:1021
1509 msgid ""
1510 "This field should be used for Select and Multiselect types.  It contains the "
1511 "possible choices which will be presented to users.  These choices should be "
1512 "separated by commas."
1513 msgstr ""
1514
1515 # type: Content of: <chapter><section><section><section><title>
1516 #: best-pkging-practices.dbk:1028
1517 msgid "Default"
1518 msgstr ""
1519
1520 # type: Content of: <chapter><section><section><section><para>
1521 #: best-pkging-practices.dbk:1030
1522 msgid ""
1523 "This field is optional.  It contains the default answer for string, select "
1524 "and multiselect templates.  For multiselect templates, it may contain a "
1525 "comma-separated list of choices."
1526 msgstr ""
1527
1528 # type: Content of: <chapter><section><section><title>
1529 #: best-pkging-practices.dbk:1039
1530 msgid "Templates fields specific style guide"
1531 msgstr ""
1532
1533 # type: Content of: <chapter><section><section><section><title>
1534 #: best-pkging-practices.dbk:1041
1535 msgid "Type field"
1536 msgstr ""
1537
1538 # type: Content of: <chapter><section><section><section><para>
1539 #: best-pkging-practices.dbk:1043
1540 msgid ""
1541 "No specific indication except: use the appropriate type by referring to the "
1542 "previous section."
1543 msgstr ""
1544
1545 # type: Content of: <chapter><section><section><section><title>
1546 #: best-pkging-practices.dbk:1049
1547 msgid "Description field"
1548 msgstr ""
1549
1550 # type: Content of: <chapter><section><section><section><para>
1551 #: best-pkging-practices.dbk:1051
1552 msgid ""
1553 "Below are specific instructions for properly writing the Description (short "
1554 "and extended) depending on the template type."
1555 msgstr ""
1556
1557 # type: Content of: <chapter><section><section><section><section><title>
1558 #: best-pkging-practices.dbk:1055
1559 msgid "String/password templates"
1560 msgstr ""
1561
1562 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1563 #: best-pkging-practices.dbk:1059
1564 msgid ""
1565 "The short description is a prompt and <emphasis role=\"strong\">not</"
1566 "emphasis> a title.  Avoid question style prompts (IP Address?) in favour of "
1567 "opened prompts (IP address:).  The use of colons is recommended."
1568 msgstr ""
1569
1570 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1571 #: best-pkging-practices.dbk:1066
1572 msgid ""
1573 "The extended description is a complement to the short description.  In the "
1574 "extended part, explain what is being asked, rather than ask the same "
1575 "question again using longer words.  Use complete sentences.  Terse writing "
1576 "style is strongly discouraged."
1577 msgstr ""
1578
1579 # type: Content of: <chapter><section><section><section><section><title>
1580 #: best-pkging-practices.dbk:1076
1581 msgid "Boolean templates"
1582 msgstr ""
1583
1584 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1585 #: best-pkging-practices.dbk:1080
1586 msgid ""
1587 "The short description should be phrased in the form of a question which "
1588 "should be kept short and should generally end with a question mark.  Terse "
1589 "writing style is permitted and even encouraged if the question is rather "
1590 "long (remember that translations are often longer than original versions)"
1591 msgstr ""
1592
1593 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1594 #: best-pkging-practices.dbk:1088
1595 msgid ""
1596 "Again, please avoid referring to specific interface widgets.  A common "
1597 "mistake for such templates is if you answer Yes-type constructions."
1598 msgstr ""
1599
1600 # type: Content of: <chapter><section><section><section><section><title>
1601 #: best-pkging-practices.dbk:1096
1602 msgid "Select/Multiselect"
1603 msgstr ""
1604
1605 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1606 #: best-pkging-practices.dbk:1100
1607 msgid ""
1608 "The short description is a prompt and <emphasis role=\"strong\">not</"
1609 "emphasis> a title.  Do <emphasis role=\"strong\">not</emphasis> use useless "
1610 "Please choose...  constructions.  Users are clever enough to figure out they "
1611 "have to choose something...:)"
1612 msgstr ""
1613
1614 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1615 #: best-pkging-practices.dbk:1108
1616 msgid ""
1617 "The extended description will complete the short description.  It may refer "
1618 "to the available choices.  It may also mention that the user may choose more "
1619 "than one of the available choices, if the template is a multiselect one "
1620 "(although the interface often makes this clear)."
1621 msgstr ""
1622
1623 # type: Content of: <chapter><section><section><section><section><title>
1624 #: best-pkging-practices.dbk:1118
1625 msgid "Notes"
1626 msgstr ""
1627
1628 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1629 #: best-pkging-practices.dbk:1122
1630 msgid "The short description should be considered to be a *title*."
1631 msgstr ""
1632
1633 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1634 #: best-pkging-practices.dbk:1127
1635 msgid ""
1636 "The extended description is what will be displayed as a more detailed "
1637 "explanation of the note.  Phrases, no terse writing style."
1638 msgstr ""
1639
1640 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
1641 #: best-pkging-practices.dbk:1133
1642 msgid ""
1643 "<emphasis role=\"strong\">Do not abuse debconf.</emphasis> Notes are the "
1644 "most common way to abuse debconf.  As written in debconf-devel manual page: "
1645 "it's best to use them only for warning about very serious problems.  The "
1646 "NEWS.Debian or README.Debian files are the appropriate location for a lot of "
1647 "notes.  If, by reading this, you consider converting your Note type "
1648 "templates to entries in NEWS/Debian or README.Debian, plus consider keeping "
1649 "existing translations for the future."
1650 msgstr ""
1651
1652 # type: Content of: <chapter><section><section><section><title>
1653 #: best-pkging-practices.dbk:1148
1654 msgid "Choices field"
1655 msgstr ""
1656
1657 # type: Content of: <chapter><section><section><section><para>
1658 #: best-pkging-practices.dbk:1150
1659 msgid ""
1660 "If the Choices are likely to change often, please consider using the "
1661 "__Choices trick.  This will split each individual choice into a single "
1662 "string, which will considerably help translators for doing their work."
1663 msgstr ""
1664
1665 # type: Content of: <chapter><section><section><section><title>
1666 #: best-pkging-practices.dbk:1157 best-pkging-practices.dbk:1195
1667 msgid "Default field"
1668 msgstr ""
1669
1670 # type: Content of: <chapter><section><section><section><para>
1671 #: best-pkging-practices.dbk:1159
1672 msgid ""
1673 "If the default value, for a select template, is likely to vary depending on "
1674 "the user language (for instance, if the choice is a language choice), please "
1675 "use the _DefaultChoice trick."
1676 msgstr ""
1677
1678 # type: Content of: <chapter><section><section><section><para>
1679 #: best-pkging-practices.dbk:1164
1680 msgid ""
1681 "This special field allow translators to put the most appropriate choice "
1682 "according to their own language.  It will become the default choice when "
1683 "their language is used while your own mentioned Default Choice will be used "
1684 "chan using English."
1685 msgstr ""
1686
1687 # type: Content of: <chapter><section><section><section><para>
1688 #: best-pkging-practices.dbk:1170
1689 msgid "Example, taken from the geneweb package templates:"
1690 msgstr ""
1691
1692 # type: Content of: <chapter><section><section><section><screen>
1693 #: best-pkging-practices.dbk:1172
1694 #, no-wrap
1695 msgid ""
1696 "\n"
1697 "Template: geneweb/lang\n"
1698 "Type: select\n"
1699 "__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"
1700 "# This is the default choice. Translators may put their own language here\n"
1701 "# instead of the default.\n"
1702 "# WARNING : you MUST use the ENGLISH FORM of your language\n"
1703 "# For instance, the french translator will need to put French (fr) here.\n"
1704 "_DefaultChoice: English (en)[ translators, please see comment in PO files]\n"
1705 "_Description: Geneweb default language:\n"
1706 msgstr ""
1707
1708 # type: Content of: <chapter><section><section><section><para>
1709 #: best-pkging-practices.dbk:1184
1710 msgid ""
1711 "Note the use of brackets which allow internal comments in debconf fields.  "
1712 "Also note the use of comments which will show up in files the translators "
1713 "will work with."
1714 msgstr ""
1715
1716 # type: Content of: <chapter><section><section><section><para>
1717 #: best-pkging-practices.dbk:1189
1718 msgid ""
1719 "The comments are needed as the DefaultChoice trick is a bit confusing: the "
1720 "translators may put their own choice"
1721 msgstr ""
1722
1723 # type: Content of: <chapter><section><section><section><para>
1724 #: best-pkging-practices.dbk:1197
1725 msgid ""
1726 "Do NOT use empty default field.  If you don't want to use default values, do "
1727 "not use Default at all."
1728 msgstr ""
1729
1730 # type: Content of: <chapter><section><section><section><para>
1731 #: best-pkging-practices.dbk:1201
1732 msgid ""
1733 "If you use po-debconf (and you <emphasis role=\"strong\">should</emphasis>, "
1734 "see 2.2), consider making this field translatable, if you think it may be "
1735 "translated."
1736 msgstr ""
1737
1738 # type: Content of: <chapter><section><section><section><para>
1739 #: best-pkging-practices.dbk:1206
1740 msgid ""
1741 "If the default value may vary depending on language/country (for instance "
1742 "the default value for a language choice), consider using the special "
1743 "_DefaultChoice type documented in <citerefentry> <refentrytitle>po-debconf</"
1744 "refentrytitle> <manvolnum>7</manvolnum> </citerefentry>)."
1745 msgstr ""
1746
1747 # type: Content of: <chapter><section><title>
1748 #: best-pkging-practices.dbk:1218
1749 msgid "Internationalization"
1750 msgstr ""
1751
1752 # type: Content of: <chapter><section><section><title>
1753 #: best-pkging-practices.dbk:1220
1754 msgid "Handling debconf translations"
1755 msgstr ""
1756
1757 # type: Content of: <chapter><section><section><para>
1758 #: best-pkging-practices.dbk:1222
1759 msgid ""
1760 "Like porters, translators have a difficult task.  They work on many packages "
1761 "and must collaborate with many different maintainers.  Moreover, most of the "
1762 "time, they are not native English speakers, so you may need to be "
1763 "particularly patient with them."
1764 msgstr ""
1765
1766 # type: Content of: <chapter><section><section><para>
1767 #: best-pkging-practices.dbk:1228
1768 msgid ""
1769 "The goal of <systemitem role=\"package\">debconf</systemitem> was to make "
1770 "packages configuration easier for maintainers and for users.  Originally, "
1771 "translation of debconf templates was handled with <command>debconf-"
1772 "mergetemplate</command>.  However, that technique is now deprecated; the "
1773 "best way to accomplish <systemitem role=\"package\">debconf</systemitem> "
1774 "internationalization is by using the <systemitem role=\"package\">po-"
1775 "debconf</systemitem> package.  This method is easier both for maintainer and "
1776 "translators; transition scripts are provided."
1777 msgstr ""
1778
1779 # type: Content of: <chapter><section><section><para>
1780 #: best-pkging-practices.dbk:1238
1781 msgid ""
1782 "Using <systemitem role=\"package\">po-debconf</systemitem>, the translation "
1783 "is stored in <filename>po</filename> files (drawing from <command>gettext</"
1784 "command> translation techniques).  Special template files contain the "
1785 "original messages and mark which fields are translatable.  When you change "
1786 "the value of a translatable field, by calling <command>debconf-updatepo</"
1787 "command>, the translation is marked as needing attention from the "
1788 "translators.  Then, at build time, the <command>dh_installdebconf</command> "
1789 "program takes care of all the needed magic to add the template along with "
1790 "the up-to-date translations into the binary packages.  Refer to the "
1791 "<citerefentry> <refentrytitle>po-debconf</refentrytitle> <manvolnum>7</"
1792 "manvolnum> </citerefentry> manual page for details."
1793 msgstr ""
1794
1795 # type: Content of: <chapter><section><section><title>
1796 #: best-pkging-practices.dbk:1254
1797 msgid "Internationalized documentation"
1798 msgstr ""
1799
1800 # type: Content of: <chapter><section><section><para>
1801 #: best-pkging-practices.dbk:1256
1802 msgid ""
1803 "Internationalizing documentation is crucial for users, but a lot of labor.  "
1804 "There's no way to eliminate all that work, but you can make things easier "
1805 "for translators."
1806 msgstr ""
1807
1808 # type: Content of: <chapter><section><section><para>
1809 #: best-pkging-practices.dbk:1261
1810 msgid ""
1811 "If you maintain documentation of any size, its easier for translators if "
1812 "they have access to a source control system.  That lets translators see the "
1813 "differences between two versions of the documentation, so, for instance, "
1814 "they can see what needs to be retranslated.  It is recommended that the "
1815 "translated documentation maintain a note about what source control revision "
1816 "the translation is based on.  An interesting system is provided by <ulink "
1817 "url=\"&url-i18n-doc-check;\">doc-check</ulink> in the <systemitem role="
1818 "\"package\">boot-floppies</systemitem> package, which shows an overview of "
1819 "the translation status for any given language, using structured comments for "
1820 "the current revision of the file to be translated and, for a translated "
1821 "file, the revision of the original file the translation is based on.  You "
1822 "might wish to adapt and provide that in your CVS area."
1823 msgstr ""
1824
1825 # type: Content of: <chapter><section><section><para>
1826 #: best-pkging-practices.dbk:1275
1827 msgid ""
1828 "If you maintain XML or SGML documentation, we suggest that you isolate any "
1829 "language-independent information and define those as entities in a separate "
1830 "file which is included by all the different translations.  This makes it "
1831 "much easier, for instance, to keep URLs up to date across multiple files."
1832 msgstr ""
1833
1834 # type: Content of: <chapter><section><title>
1835 #: best-pkging-practices.dbk:1285
1836 msgid "Common packaging situations"
1837 msgstr ""
1838
1839 # type: Content of: <chapter><section><section><title>
1840 #: best-pkging-practices.dbk:1296
1841 msgid "Packages using <command>autoconf</command>/<command>automake</command>"
1842 msgstr ""
1843
1844 # type: Content of: <chapter><section><section><para>
1845 #: best-pkging-practices.dbk:1298
1846 msgid ""
1847 "Keeping <command>autoconf</command>'s <filename>config.sub</filename> and "
1848 "<filename>config.guess</filename> files up to date is critical for porters, "
1849 "especially on more volatile architectures.  Some very good packaging "
1850 "practices for any package using <command>autoconf</command> and/or "
1851 "<command>automake</command> have been synthesized in &file-bpp-autotools; "
1852 "from the <systemitem role=\"package\">autotools-dev</systemitem> package.  "
1853 "You're strongly encouraged to read this file and to follow the given "
1854 "recommendations."
1855 msgstr ""
1856
1857 # type: Content of: <chapter><section><section><title>
1858 #: best-pkging-practices.dbk:1310
1859 msgid "Libraries"
1860 msgstr ""
1861
1862 # type: Content of: <chapter><section><section><para>
1863 #: best-pkging-practices.dbk:1312
1864 msgid ""
1865 "Libraries are always difficult to package for various reasons.  The policy "
1866 "imposes many constraints to ease their maintenance and to make sure upgrades "
1867 "are as simple as possible when a new upstream version comes out.  Breakage "
1868 "in a library can result in dozens of dependent packages breaking."
1869 msgstr ""
1870
1871 # type: Content of: <chapter><section><section><para>
1872 #: best-pkging-practices.dbk:1318
1873 msgid ""
1874 "Good practices for library packaging have been grouped in <ulink url=\"&url-"
1875 "libpkg-guide;\">the library packaging guide</ulink>."
1876 msgstr ""
1877
1878 # type: Content of: <chapter><section><section><title>
1879 #: best-pkging-practices.dbk:1325
1880 msgid "Documentation"
1881 msgstr ""
1882
1883 # type: Content of: <chapter><section><section><para>
1884 #: best-pkging-practices.dbk:1327
1885 msgid ""
1886 "Be sure to follow the <ulink url=\"&url-debian-policy;ch-docs.html\">Policy "
1887 "on documentation</ulink>."
1888 msgstr ""
1889
1890 # type: Content of: <chapter><section><section><para>
1891 #: best-pkging-practices.dbk:1332
1892 msgid ""
1893 "If your package contains documentation built from XML or SGML, we recommend "
1894 "you not ship the XML or SGML source in the binary package(s).  If users want "
1895 "the source of the documentation, they should retrieve the source package."
1896 msgstr ""
1897
1898 # type: Content of: <chapter><section><section><para>
1899 #: best-pkging-practices.dbk:1337
1900 msgid ""
1901 "Policy specifies that documentation should be shipped in HTML format.  We "
1902 "also recommend shipping documentation in PDF and plain text format if "
1903 "convenient and if output of reasonable quality is possible.  However, it is "
1904 "generally not appropriate to ship plain text versions of documentation whose "
1905 "source format is HTML."
1906 msgstr ""
1907
1908 # type: Content of: <chapter><section><section><para>
1909 #: best-pkging-practices.dbk:1344
1910 msgid ""
1911 "Major shipped manuals should register themselves with <systemitem role="
1912 "\"package\">doc-base</systemitem> on installation.  See the <systemitem role="
1913 "\"package\">doc-base</systemitem> package documentation for more information."
1914 msgstr ""
1915
1916 # type: Content of: <chapter><section><section><title>
1917 #: best-pkging-practices.dbk:1352
1918 msgid "Specific types of packages"
1919 msgstr ""
1920
1921 # type: Content of: <chapter><section><section><para>
1922 #: best-pkging-practices.dbk:1354
1923 msgid ""
1924 "Several specific types of packages have special sub-policies and "
1925 "corresponding packaging rules and practices:"
1926 msgstr ""
1927
1928 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1929 #: best-pkging-practices.dbk:1360
1930 msgid ""
1931 "Perl related packages have a <ulink url=\"&url-perl-policy;\">Perl policy</"
1932 "ulink>, some examples of packages following that policy are <systemitem role="
1933 "\"package\">libdbd-pg-perl</systemitem> (binary perl module) or <systemitem "
1934 "role=\"package\">libmldbm-perl</systemitem> (arch independent perl module)."
1935 msgstr ""
1936
1937 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1938 #: best-pkging-practices.dbk:1369
1939 msgid ""
1940 "Python related packages have their python policy; see &file-python-policy; "
1941 "in the <systemitem role=\"package\">python</systemitem> package."
1942 msgstr ""
1943
1944 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1945 #: best-pkging-practices.dbk:1376
1946 msgid ""
1947 "Emacs related packages have the <ulink url=\"&url-emacs-policy;\">emacs "
1948 "policy</ulink>."
1949 msgstr ""
1950
1951 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1952 #: best-pkging-practices.dbk:1383
1953 msgid ""
1954 "Java related packages have their <ulink url=\"&url-java-policy;\">java "
1955 "policy</ulink>."
1956 msgstr ""
1957
1958 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1959 #: best-pkging-practices.dbk:1390
1960 msgid ""
1961 "Ocaml related packages have their own policy, found in &file-ocaml-policy; "
1962 "from the <systemitem role=\"package\">ocaml</systemitem> package.  A good "
1963 "example is the <systemitem role=\"package\">camlzip</systemitem> source "
1964 "package."
1965 msgstr ""
1966
1967 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1968 #: best-pkging-practices.dbk:1398
1969 msgid ""
1970 "Packages providing XML or SGML DTDs should conform to the recommendations "
1971 "found in the <systemitem role=\"package\">sgml-base-doc</systemitem> package."
1972 msgstr ""
1973
1974 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
1975 #: best-pkging-practices.dbk:1404
1976 msgid ""
1977 "Lisp packages should register themselves with <systemitem role=\"package"
1978 "\">common-lisp-controller</systemitem>, about which see &file-lisp-"
1979 "controller;."
1980 msgstr ""
1981
1982 # type: Content of: <chapter><section><section><title>
1983 #: best-pkging-practices.dbk:1434
1984 msgid "Architecture-independent data"
1985 msgstr ""
1986
1987 # type: Content of: <chapter><section><section><para>
1988 #: best-pkging-practices.dbk:1436
1989 msgid ""
1990 "It is not uncommon to have a large amount of architecture-independent data "
1991 "packaged with a program.  For example, audio files, a collection of icons, "
1992 "wallpaper patterns, or other graphic files.  If the size of this data is "
1993 "negligible compared to the size of the rest of the package, it's probably "
1994 "best to keep it all in a single package."
1995 msgstr ""
1996
1997 # type: Content of: <chapter><section><section><para>
1998 #: best-pkging-practices.dbk:1443
1999 msgid ""
2000 "However, if the size of the data is considerable, consider splitting it out "
2001 "into a separate, architecture-independent package (_all.deb).  By doing "
2002 "this, you avoid needless duplication of the same data into eleven or more ."
2003 "debs, one per each architecture.  While this adds some extra overhead into "
2004 "the <filename>Packages</filename> files, it saves a lot of disk space on "
2005 "Debian mirrors.  Separating out architecture-independent data also reduces "
2006 "processing time of <command>lintian</command> or <command>linda</command> "
2007 "(see <xref linkend=\"tools-lint\"/> ) when run over the entire Debian "
2008 "archive."
2009 msgstr ""
2010
2011 # type: Content of: <chapter><section><section><title>
2012 #: best-pkging-practices.dbk:1455
2013 msgid "Needing a certain locale during build"
2014 msgstr ""
2015
2016 # type: Content of: <chapter><section><section><para>
2017 #: best-pkging-practices.dbk:1457
2018 msgid ""
2019 "If you need a certain locale during build, you can create a temporary file "
2020 "via this trick:"
2021 msgstr ""
2022
2023 # type: Content of: <chapter><section><section><para>
2024 #: best-pkging-practices.dbk:1461
2025 msgid ""
2026 "If you set <varname>LOCPATH</varname> to the equivalent of <filename>/usr/"
2027 "lib/locale</filename>, and <varname>LC_ALL</varname> to the name of the "
2028 "locale you generate, you should get what you want without being root.  "
2029 "Something like this:"
2030 msgstr ""
2031
2032 # type: Content of: <chapter><section><section><screen>
2033 #: best-pkging-practices.dbk:1465
2034 #, no-wrap
2035 msgid ""
2036 "\n"
2037 "LOCALE_PATH=debian/tmpdir/usr/lib/locale\n"
2038 "LOCALE_NAME=en_IN\n"
2039 "LOCALE_CHARSET=UTF-8\n"
2040 "\n"
2041 "mkdir -p $LOCALE_PATH\n"
2042 "localedef -i $LOCALE_NAME.$LOCALE_CHARSET -f $LOCALE_CHARSET $LOCALE_PATH/$LOCALE_NAME.$LOCALE_CHARSET\n"
2043 "\n"
2044 "# Using the locale\n"
2045 "LOCPATH=$LOCALE_PATH LC_ALL=$LOCALE_NAME.$LOCALE_CHARSET date\n"
2046 msgstr ""
2047
2048 # type: Content of: <chapter><section><section><title>
2049 #: best-pkging-practices.dbk:1479
2050 msgid "Make transition packages deborphan compliant"
2051 msgstr ""
2052
2053 # type: Content of: <chapter><section><section><para>
2054 #: best-pkging-practices.dbk:1481
2055 msgid ""
2056 "Deborphan is a program for helping users to detect which packages can safely "
2057 "be removed from the system, i.e.  the ones that have no packages depending "
2058 "on them.  The default operation is to search only within the libs and "
2059 "oldlibs sections, to hunt down unused libraries.  But when passed the right "
2060 "argument, it tries to catch other useless packages."
2061 msgstr ""
2062
2063 # type: Content of: <chapter><section><section><para>
2064 #: best-pkging-practices.dbk:1488
2065 msgid ""
2066 "For example, with --guess-dummy, deborphan tries to search all transitional "
2067 "packages which were needed for upgrade but which can now safely be removed.  "
2068 "For that, it looks for the string dummy or transitional in their short "
2069 "description."
2070 msgstr ""
2071
2072 # type: Content of: <chapter><section><section><para>
2073 #: best-pkging-practices.dbk:1494
2074 msgid ""
2075 "So, when you are creating such a package, please make sure to add this text "
2076 "to your short description.  If you are looking for examples, just run: "
2077 "<command>apt-cache search .|grep dummy</command> or <command>apt-cache "
2078 "search .|grep transitional</command>."
2079 msgstr ""
2080
2081 # type: Content of: <chapter><section><section><title>
2082 #: best-pkging-practices.dbk:1502
2083 msgid "Best practices for <filename>orig.tar.gz</filename> files"
2084 msgstr ""
2085
2086 # type: Content of: <chapter><section><section><para>
2087 #: best-pkging-practices.dbk:1504
2088 msgid ""
2089 "There are two kinds of original source tarballs: Pristine source and "
2090 "repackaged upstream source."
2091 msgstr ""
2092
2093 # type: Content of: <chapter><section><section><section><title>
2094 #: best-pkging-practices.dbk:1508
2095 msgid "Pristine source"
2096 msgstr ""
2097
2098 # type: Content of: <chapter><section><section><section><para><footnote>
2099 #: best-pkging-practices.dbk:1510
2100 msgid ""
2101 "The defining characteristic of a pristine source tarball is that the .orig."
2102 "tar.gz file is byte-for-byte identical to a tarball officially distributed "
2103 "by the upstream author.  <footnote>"
2104 msgstr ""
2105
2106 # type: Content of: <chapter><section><section><section><para><footnote><para>
2107 #: best-pkging-practices.dbk:1512
2108 msgid ""
2109 "We cannot prevent upstream authors from changing the tarball they distribute "
2110 "without also incrementing the version number, so there can be no guarantee "
2111 "that a pristine tarball is identical to what upstream <emphasis>currently</"
2112 "emphasis> distributing at any point in time.  All that can be expected is "
2113 "that it is identical to something that upstream once <emphasis>did</"
2114 "emphasis> distribute.  If a difference arises later (say, if upstream "
2115 "notices that he wasn't using maximal comression in his original distribution "
2116 "and then re-<literal>gzip</literal>s it), that's just too bad.  Since there "
2117 "is no good way to upload a new .orig.tar.gz for the same version, there is "
2118 "not even any point in treating this situation as a bug."
2119 msgstr ""
2120
2121 # type: Content of: <chapter><section><section><section><para>
2122 #: best-pkging-practices.dbk:1522
2123 msgid ""
2124 "</footnote> This makes it possible to use checksums to easily verify that "
2125 "all changes between Debian's version and upstream's are contained in the "
2126 "Debian diff.  Also, if the original source is huge, upstream authors and "
2127 "others who already have the upstream tarball can save download time if they "
2128 "want to inspect your packaging in detail."
2129 msgstr ""
2130
2131 # type: Content of: <chapter><section><section><section><para>
2132 #: best-pkging-practices.dbk:1530
2133 msgid ""
2134 "There is no universally accepted guidelines that upstream authors follow "
2135 "regarding to the directory structure inside their tarball, but <command>dpkg-"
2136 "source</command> is nevertheless able to deal with most upstream tarballs as "
2137 "pristine source.  Its strategy is equivalent to the following:"
2138 msgstr ""
2139
2140 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2141 #: best-pkging-practices.dbk:1538
2142 msgid "It unpacks the tarball in an empty temporary directory by doing"
2143 msgstr ""
2144
2145 # type: Content of: <chapter><section><section><section><orderedlist><listitem><screen>
2146 #: best-pkging-practices.dbk:1540
2147 #, no-wrap
2148 msgid ""
2149 "\n"
2150 "zcat path/to/&lt;packagename&gt;_&lt;upstream-version&gt;.orig.tar.gz | tar xf -\n"
2151 msgstr ""
2152
2153 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2154 #: best-pkging-practices.dbk:1546
2155 msgid ""
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>&lt;packagename&gt;-&lt;upstream-version&gt;(.orig)</literal>.  The "
2159 "name of the top-level directory in the tarball does not matter, and is "
2160 "forgotten."
2161 msgstr ""
2162
2163 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2164 #: best-pkging-practices.dbk:1555
2165 msgid ""
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>&lt;packagename&gt;-&lt;upstream-"
2170 "version&gt;(.orig)</literal>."
2171 msgstr ""
2172
2173 # type: Content of: <chapter><section><section><section><title>
2174 #: best-pkging-practices.dbk:1566
2175 msgid "Repackaged upstream source"
2176 msgstr "upstream のソースをパッケージしなおす"
2177
2178 # type: Content of: <chapter><section><section><section><para>
2179 #: best-pkging-practices.dbk:1568
2180 msgid ""
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."
2186 msgstr ""
2187
2188 # type: Content of: <chapter><section><section><section><para>
2189 #: best-pkging-practices.dbk:1575
2190 msgid ""
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>&lt;upstream-version&gt;</literal> and <literal>&lt;debian-"
2197 "revision&gt;</literal>."
2198 msgstr ""
2199
2200 # type: Content of: <chapter><section><section><section><para>
2201 #: best-pkging-practices.dbk:1584
2202 msgid ""
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."
2210 msgstr ""
2211
2212 # type: Content of: <chapter><section><section><section><para>
2213 #: best-pkging-practices.dbk:1593
2214 msgid "A repackaged .orig.tar.gz"
2215 msgstr ""
2216
2217 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2218 #: best-pkging-practices.dbk:1598
2219 msgid ""
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>."
2227 msgstr ""
2228
2229 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para><footnote>
2230 #: best-pkging-practices.dbk:1610
2231 msgid ""
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 "
2234 "you.  <footnote>"
2235 msgstr ""
2236
2237 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para><footnote><para>
2238 #.  or similarly named 
2239 #: best-pkging-practices.dbk:1612
2240 msgid ""
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 "
2247 "source."
2248 msgstr ""
2249
2250 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2251 #: best-pkging-practices.dbk:1619
2252 msgid "</footnote>"
2253 msgstr ""
2254
2255 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2256 #: best-pkging-practices.dbk:1624
2257 msgid ""
2258 "<emphasis role=\"strong\">should</emphasis>, except where impossible for "
2259 "legal reasons, preserve the entire building and portablility infrastructure "
2260 "provided by the upstream author.  For example, it is not a sufficient reason "
2261 "for omitting a file that it is used only when building on MS-DOS.  "
2262 "Similarly, a Makefile provided by upstream should not be omitted even if the "
2263 "first thing your <filename>debian/rules</filename> does is to overwrite it "
2264 "by running a configure script."
2265 msgstr ""
2266
2267 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2268 #: best-pkging-practices.dbk:1633
2269 msgid ""
2270 "(<emphasis>Rationale:</emphasis> It is common for Debian users who need to "
2271 "build software for non-Debian platforms to fetch the source from a Debian "
2272 "mirror rather than trying to locate a canonical upstream distribution point)."
2273 msgstr ""
2274
2275 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2276 #: best-pkging-practices.dbk:1640
2277 msgid ""
2278 "<emphasis role=\"strong\">should</emphasis> use <literal>&lt;packagename&gt;-"
2279 "&lt;upstream-version&gt;.orig</literal> as the name of the top-level "
2280 "directory in its tarball.  This makes it possible to distinguish pristine "
2281 "tarballs from repackaged ones."
2282 msgstr ""
2283
2284 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2285 #: best-pkging-practices.dbk:1648
2286 msgid ""
2287 "<emphasis role=\"strong\">should</emphasis> be gzipped with maximal "
2288 "compression."
2289 msgstr ""
2290
2291 # type: Content of: <chapter><section><section><section><para>
2292 #: best-pkging-practices.dbk:1653
2293 msgid ""
2294 "The canonical way to meet the latter two points is to let <literal>dpkg-"
2295 "source -b</literal> construct the repackaged tarball from an unpacked "
2296 "directory."
2297 msgstr ""
2298
2299 # type: Content of: <chapter><section><section><section><title>
2300 #: best-pkging-practices.dbk:1659
2301 msgid "Changing binary files in <literal>diff.gz</literal>"
2302 msgstr ""
2303
2304 # type: Content of: <chapter><section><section><section><para><footnote>
2305 #: best-pkging-practices.dbk:1661
2306 msgid ""
2307 "Sometimes it is necessary to change binary files contained in the original "
2308 "tarball, or to add binary files that are not in it.  If this is done by "
2309 "simply copying the files into the debianized source tree, <command>dpkg-"
2310 "source</command> will not be able to handle this.  On the other hand, "
2311 "according to the guidelines given above, you cannot include such a changed "
2312 "binary file in a repackaged <filename>orig.tar.gz</filename>.  Instead, "
2313 "include the file in the <filename>debian</filename> directory in "
2314 "<command>uuencode</command>d (or similar) form <footnote>"
2315 msgstr ""
2316
2317 # type: Content of: <chapter><section><section><section><para><footnote><para>
2318 #: best-pkging-practices.dbk:1668
2319 msgid ""
2320 "The file should have a name that makes it clear which binary file it "
2321 "encodes.  Usually, some postfix indicating the encoding should be appended "
2322 "to the original filename.  Note that you don't need to depend on <systemitem "
2323 "role=\"package\">sharutils</systemitem> to get the <command>uudecode</"
2324 "command> program if you use <command>perl</command>'s <literal>pack</"
2325 "literal> function.  The code could look like"
2326 msgstr ""
2327
2328 # type: Content of: <chapter><section><section><section><para>
2329 #: best-pkging-practices.dbk:1676
2330 msgid ""
2331 "&example-uu; </footnote>.  The file would then be decoded and copied to its "
2332 "place during the build process.  Thus the change will be visible quite easy."
2333 msgstr ""
2334
2335 # type: Content of: <chapter><section><section><section><para>
2336 #: best-pkging-practices.dbk:1682
2337 msgid ""
2338 "Some packages use <command>dbs</command> to manage patches to their upstream "
2339 "source, and always create a new <literal>orig.tar.gz</literal> file that "
2340 "contains the real <literal>orig.tar.gz</literal> in its toplevel directory.  "
2341 "This is questionable with respect to the preference for pristine source.  On "
2342 "the other hand, it is easy to modify or add binary files in this case: Just "
2343 "put them into the newly created <literal>orig.tar.gz</literal> file, besides "
2344 "the real one, and copy them to the right place during the build process."
2345 msgstr ""
2346
2347 # type: Content of: <chapter><section><section><title>
2348 #: best-pkging-practices.dbk:1695
2349 msgid "Best practices for debug packages"
2350 msgstr ""
2351
2352 # type: Content of: <chapter><section><section><para>
2353 #: best-pkging-practices.dbk:1697
2354 msgid ""
2355 "A debug package is a package with a name ending in -dbg, that contains "
2356 "additional information that gdb can use.  Since Debian binaries are stripped "
2357 "by default, debugging information, including function names and line "
2358 "numbers, is otherwise not available when running gdb on Debian binaries.  "
2359 "Debug packages allow users who need this additional debugging information to "
2360 "install it, without bloating a regular system with the information."
2361 msgstr ""
2362
2363 # type: Content of: <chapter><section><section><para>
2364 #: best-pkging-practices.dbk:1705
2365 msgid ""
2366 "It is up to a package's maintainer whether to create a debug package or "
2367 "not.  Maintainers are encouraged to create debug packages for library "
2368 "packages, since this can aid in debugging many programs linked to a "
2369 "library.  In general, debug packages do not need to be added for all "
2370 "programs; doing so would bloat the archive.  But if a maintainer finds that "
2371 "users often need a debugging version of a program, it can be worthwhile to "
2372 "make a debug package for it.  Programs that are core infrastructure, such as "
2373 "apache and the X server are also good candidates for debug packages."
2374 msgstr ""
2375
2376 # type: Content of: <chapter><section><section><para>
2377 #: best-pkging-practices.dbk:1715
2378 msgid ""
2379 "Some debug packages may contain an entire special debugging build of a "
2380 "library or other binary, but most of them can save space and build time by "
2381 "instead containing separated debugging symbols that gdb can find and load on "
2382 "the fly when debugging a program or library.  The convention in Debian is to "
2383 "keep these symbols in <filename>/usr/lib/debug/path</filename>, where "
2384 "<emphasis>path</emphasis> is the path to the executable or library.  For "
2385 "example, debugging symbols for <filename>/usr/bin/foo</filename> go in "
2386 "<filename>/usr/lib/debug/usr/bin/foo</filename>, and debugging symbols for "
2387 "<filename>/usr/lib/libfoo.so.1</filename> go in <filename>/usr/lib/debug/usr/"
2388 "lib/libfoo.so.1</filename>."
2389 msgstr ""
2390
2391 # type: Content of: <chapter><section><section><para>
2392 #: best-pkging-practices.dbk:1727
2393 msgid ""
2394 "The debugging symbols can be extracted from an object file using objcopy --"
2395 "only-keep-debug.  Then the object file can be stripped, and objcopy --add-"
2396 "gnu-debuglink used to specify the path to the debugging symbol file.  "
2397 "<citerefentry> <refentrytitle>objcopy</refentrytitle> <manvolnum>1</"
2398 "manvolnum> </citerefentry> explains in detail how this works."
2399 msgstr ""
2400
2401 # type: Content of: <chapter><section><section><para>
2402 #: best-pkging-practices.dbk:1734
2403 msgid ""
2404 "The dh_strip command in debhelper supports creating debug packages, and can "
2405 "take care of using objcopy to separate out the debugging symbols for you.  "
2406 "If your package uses debhelper, all you need to do is call dh_strip --dbg-"
2407 "package=libfoo-dbg, and add an entry to debian/control for the debug package."
2408 msgstr ""
2409
2410 # type: Content of: <chapter><section><section><para>
2411 #: best-pkging-practices.dbk:1741
2412 msgid ""
2413 "Note that the Debian package should depend on the package that it provides "
2414 "debugging symbols for, and this dependency should be versioned.  For example:"
2415 msgstr ""
2416
2417 # type: Content of: <chapter><section><section><screen>
2418 #: best-pkging-practices.dbk:1744
2419 #, fuzzy, no-wrap
2420 msgid ""
2421 "\n"
2422 "Depends: libfoo-dbg (= ${binary:Version})\n"
2423 msgstr "Depends: libfoo-dbg (= ${binary:Version})"