1 # Debian Developer's Reference (Japanese)
2 # (C) Hideki Yamane <henrich@debian.org>, 2008-2011.
6 "Project-Id-Version: developers-reference 3.4.7\n"
7 "POT-Creation-Date: 2011-10-12 09:49+0300\n"
8 "PO-Revision-Date: 2011-10-16 19:27+0900\n"
9 "Last-Translator: Hideki Yamane <henrich@debian.org>\n"
10 "Language-Team: Debian JP Project <debian-doc@debian.or.jp>\n"
11 "Language: Japanese\n"
13 "Content-Type: text/plain; charset=UTF-8\n"
14 "Content-Transfer-Encoding: 8bit\n"
16 # type: Content of: <chapter><title>
17 #. type: Content of: <chapter><title>
18 #: best-pkging-practices.dbk:7
19 msgid "Best Packaging Practices"
20 msgstr "パッケージ化のベストプラクティス"
22 # type: Content of: <chapter><para>
23 #. type: Content of: <chapter><para>
24 #: best-pkging-practices.dbk:9
27 "Debian's quality is largely due to the <ulink url=\"&url-debian-policy;"
28 "\">Debian Policy</ulink>, which defines explicit baseline requirements which "
29 "all Debian packages must fulfill. Yet there is also a shared history of "
30 "experience which goes beyond the Debian Policy, an accumulation of years of "
31 "experience in packaging. Many very talented people have created great "
32 "tools, tools which help you, the Debian maintainer, create and maintain "
35 "Debian の品質は、<ulink url=\"&url-debian-policy;\">Debian Policy</ulink> に"
36 "大きく依存しています。これは、全ての Debian パッケージが満たす必要がある基本"
37 "的要求を明示的に規定している多くの非常に優秀な人々が素晴らしいツールを作って"
38 "おり、このツールがあなた、つまり Debian のメンテナが素晴らしいパッケージを作"
39 "り、維持していくのを手助けしてくれます。"
41 # type: Content of: <chapter><para>
42 #. type: Content of: <chapter><para>
43 #: best-pkging-practices.dbk:18
46 "This chapter provides some best practices for Debian developers. All "
47 "recommendations are merely that, and are not requirements or policy. These "
48 "are just some subjective hints, advice and pointers collected from Debian "
49 "developers. Feel free to pick and choose whatever works best for you."
51 "この章では、Debian 開発者へのベストプラクティスをいくつか提供します。すべての"
52 "勧めは単なる勧めであり、要求事項やポリシーではありません。あなたにとって一番"
53 "うまくいくやり方を、どうぞご自由に選んでください。"
55 # type: Content of: <chapter><section><title>
56 #. type: Content of: <chapter><section><title>
57 #: best-pkging-practices.dbk:24
58 msgid "Best practices for <filename>debian/rules</filename>"
59 msgstr "<filename>debian/rules</filename> についてのベストプラクティス"
61 # type: Content of: <chapter><section><para>
62 #. type: Content of: <chapter><section><para>
63 #: best-pkging-practices.dbk:26
65 "The following recommendations apply to the <filename>debian/rules</filename> "
66 "file. Since <filename>debian/rules</filename> controls the build process "
67 "and selects the files which go into the package (directly or indirectly), "
68 "it's usually the file maintainers spend the most time on."
70 "以下の推奨事項は、<filename>debian/rules</filename> ファイルに適用されます。"
71 "<filename>debian/rules</filename> は、ビルド作業を管理し、(直接にせよ、そうで"
72 "ないにせよ) パッケージにどのファイルが入るかを選択します。大抵の場合、メンテ"
75 # type: Content of: <chapter><section><section><title>
76 #. type: Content of: <chapter><section><section><title>
77 #: best-pkging-practices.dbk:32
78 msgid "Helper scripts"
81 # type: Content of: <chapter><section><section><para>
82 #. type: Content of: <chapter><section><section><para>
83 #: best-pkging-practices.dbk:34
85 "The rationale for using helper scripts in <filename>debian/rules</filename> "
86 "is that they let maintainers use and share common logic among many "
87 "packages. Take for instance the question of installing menu entries: you "
88 "need to put the file into <filename>/usr/share/menu</filename> (or "
89 "<filename>/usr/lib/menu</filename> for executable binary menufiles, if this "
90 "is needed), and add commands to the maintainer scripts to register and "
91 "unregister the menu entries. Since this is a very common thing for packages "
92 "to do, why should each maintainer rewrite all this on their own, sometimes "
93 "with bugs? Also, supposing the menu directory changed, every package would "
96 "<filename>debian/rules</filename> でヘルパースクリプトを使う根拠は、多くの"
97 "パッケージ間でメンテナらに共通のロジックを利用・共有させるようになるからで"
98 "す。メニューエントリのインストールについての問いを例にとってみましょう: ファ"
99 "イルを <filename>/usr/share/menu</filename> (必要であれば、実行形式のバイナリ"
100 "のメニューファイルの場合 <filename>/usr/lib/menu</filename>) に置き、メンテナ"
101 "スクリプトにメニューエントリを登録・解除するためのコマンドを追加する必要があ"
102 "ります。これはパッケージが行う、非常に一般的なことです。なぜ個々のメンテナが"
103 "これらのすべてを自分で書き直し、時にはバグを埋め込む必要があるでしょう? ま"
104 "た、メニューディレクトリが変更された場合、すべてのパッケージを変更する必要が"
107 # type: Content of: <chapter><section><section><para>
108 #. type: Content of: <chapter><section><section><para>
109 #: best-pkging-practices.dbk:45
111 "Helper scripts take care of these issues. Assuming you comply with the "
112 "conventions expected by the helper script, the helper takes care of all the "
113 "details. Changes in policy can be made in the helper script; then packages "
114 "just need to be rebuilt with the new version of the helper and no other "
117 "ヘルパースクリプトがこれらの問題を引き受けてくれます。ヘルパースクリプトの期"
118 "待するやり方に従っているならば、ヘルパースクリプトはすべての詳細について考慮"
119 "をします。ポリシーの変更はヘルパースクリプト中で行えます; そして、パッケージ"
120 "を新しいバージョンのヘルパースクリプトでリビルドする必要があるだけです。他に"
123 # type: Content of: <chapter><section><section><para>
124 #. type: Content of: <chapter><section><section><para>
125 #: best-pkging-practices.dbk:52
127 "<xref linkend=\"tools\"/> contains a couple of different helpers. The most "
128 "common and best (in our opinion) helper system is <systemitem role=\"package"
129 "\">debhelper</systemitem>. Previous helper systems, such as <systemitem "
130 "role=\"package\">debmake</systemitem>, were monolithic: you couldn't pick "
131 "and choose which part of the helper you found useful, but had to use the "
132 "helper to do everything. <systemitem role=\"package\">debhelper</"
133 "systemitem>, however, is a number of separate little <command>dh_*</command> "
134 "programs. For instance, <command>dh_installman</command> installs and "
135 "compresses man pages, <command>dh_installmenu</command> installs menu files, "
136 "and so on. Thus, it offers enough flexibility to be able to use the little "
137 "helper scripts, where useful, in conjunction with hand-crafted commands in "
138 "<filename>debian/rules</filename>."
140 "<xref linkend=\"tools\"/> には、複数の異なったヘルパーが含まれています。もっ"
141 "とも一般的で (我々の意見では) ベストなヘルパーシステムは <systemitem role="
142 "\"package\">debhelper</systemitem> です。<systemitem role=\"package"
143 "\">debmake</systemitem> のような、以前のヘルパーシステムはモノリシックでし"
144 "た: 使えそうなヘルパーの一部を取り出して選ぶことはできず、何を行うにもヘル"
145 "パーを使う必要がありました。ですが、<systemitem role=\"package\">debhelper</"
146 "systemitem> は、いくつもの分割された小さな <command>dh_*</command> プログラム"
147 "です。たとえば、<command>dh_installman</command> は man ページをインストール"
148 "して圧縮し、<command>dh_installmenu</command> は menu ファイルをインストール"
149 "するなどします。つまり、<filename>debian/rules</filename> 内で使える部分では"
150 "小さなヘルパースクリプトを使い、手製のコマンドを使うといった十分な柔軟性を与"
153 #. type: Content of: <chapter><section><section><para>
154 #: best-pkging-practices.dbk:66
156 "You can get started with <systemitem role=\"package\">debhelper</systemitem> "
157 "by reading <citerefentry> <refentrytitle>debhelper</refentrytitle> "
158 "<manvolnum>1</manvolnum> </citerefentry>, and looking at the examples that "
159 "come with the package. <command>dh_make</command>, from the <systemitem "
160 "role=\"package\">dh-make</systemitem> package (see <xref linkend=\"dh-make\"/"
161 ">), can be used to convert a vanilla source package to a <systemitem role="
162 "\"package\">debhelper</systemitem>ized package. This shortcut, though, "
163 "should not convince you that you do not need to bother understanding the "
164 "individual <command>dh_*</command> helpers. If you are going to use a "
165 "helper, you do need to take the time to learn to use that helper, to learn "
166 "its expectations and behavior."
168 "<citerefentry> <refentrytitle>debhelper</refentrytitle> <manvolnum>1</"
169 "manvolnum> </citerefentry> を読んで、パッケージに付属している例を参照すれば、"
170 "<systemitem role=\"package\">debhelper</systemitem> を使い始めることができま"
171 "す。 <systemitem role=\"package\">dh-make</systemitem> パッケージ (<xref "
172 "linkend=\"dh-make\"/> 参照) の <command>dh_make</command> は、素のソースパッ"
173 "ケージを <systemitem role=\"package\">debhelper</systemitem>化されたパッケー"
174 "ジに変換するのに利用できます。ですが、この近道では個々の <command>dh_*</"
175 "command> ヘルパーをわざわざ理解する必要がないので、満足できないでしょう。ヘル"
176 "パースクリプトを使おうとするのであれば、そのヘルパーを使うこと、つまり前提と"
177 "動作を学ぶのに時間を割く必要があります。"
179 # type: Content of: <chapter><section><section><para>
180 #. type: Content of: <chapter><section><section><para>
181 #: best-pkging-practices.dbk:79
183 "Some people feel that vanilla <filename>debian/rules</filename> files are "
184 "better, since you don't have to learn the intricacies of any helper system. "
185 "This decision is completely up to you. Use what works for you. Many "
186 "examples of vanilla <filename>debian/rules</filename> files are available at "
187 "<ulink url=\"&url-rules-files;\"></ulink>."
189 "いかなるヘルパーシステムの複雑さも学ぶ必要がないので、素の <filename>debian/"
190 "rules</filename> ファイルのほうが良いと考える人もいます。この判断は完全にあな"
191 "た次第です。あなたに合っている方を選んでください。素の <filename>debian/"
192 "rules</filename> ファイルの多くの例は <ulink url=\"&url-rules-files;\"></"
195 # type: Content of: <chapter><section><section><title>
196 #. type: Content of: <chapter><section><section><title>
197 #: best-pkging-practices.dbk:88
198 msgid "Separating your patches into multiple files"
199 msgstr "パッチを複数のファイルに分離する"
201 # type: Content of: <chapter><section><section><para>
202 #. type: Content of: <chapter><section><section><para>
203 #: best-pkging-practices.dbk:90
205 "Big, complex packages may have many bugs that you need to deal with. If you "
206 "correct a number of bugs directly in the source, and you're not careful, it "
207 "can get hard to differentiate the various patches that you applied. It can "
208 "get quite messy when you have to update the package to a new upstream "
209 "version which integrates some of the fixes (but not all). You can't take "
210 "the total set of diffs (e.g., from <filename>.diff.gz</filename>) and work "
211 "out which patch sets to back out as a unit as bugs are fixed upstream."
213 "巨大で複雑なパッケージには、対処が必要なたくさんのバグが含まれているかもしれ"
214 "ません。直接ソース中で大量のバグを修正し、あまり注意を払っていなかった場合、"
215 "適用した様々なパッチを識別するのは難しいことになるでしょう。(全てではなく) 幾"
216 "つか修正を取り入れた新しい開発元のバージョンへパッケージを更新する必要が出た"
217 "場合、とても悲惨なことになります。(例えば、<filename>.diff.gz</filename> か"
218 "ら) diff をすべて適用することもできませんし、開発元で修正されたバグごとにどの"
219 "パッチをバックアウトするようにすればよいのか分かりません。"
221 #. type: Content of: <chapter><section><section><para>
222 #: best-pkging-practices.dbk:99
224 "Fortunately, with the source format “3.0 (quilt)” it is now possible to keep "
225 "patches separate without having to modify <filename>debian/rules</filename> "
226 "to setup a patch system. Patches are stored in <filename>debian/patches/</"
227 "filename> and when the source package is unpacked patches listed in "
228 "<filename>debian/patches/series</filename> are automatically applied. As "
229 "the name implies, patches can be managed with <command>quilt</command>."
231 "幸いなことに、ソースフォーマット“3.0 (quilt)”では、パッチシステムを設定するた"
232 "めに <filename>debian/rules</filename> を変更することなく、パッチを分割して保"
233 "持できるようになっています。パッチは <filename>debian/patches/</filename> に"
234 "保持され、ソースパッケージが展開されるときに <filename>debian/patches/"
235 "series</filename> に記載されているパッチが自動的に適用されます。名前が指すよ"
236 "うに、パッチは <command>quilt</command> で管理することができます。"
238 #. type: Content of: <chapter><section><section><para>
239 #: best-pkging-practices.dbk:107
241 "When using the older source “1.0”, it's also possible to separate patches "
242 "but a dedicated patch system must be used: the patch files are shipped "
243 "within the Debian patch file (<filename>.diff.gz</filename>), usually within "
244 "the <filename>debian/</filename> directory. The only difference is that they "
245 "aren't applied immediately by <command>dpkg-source</command>, but by the "
246 "<literal>build</literal> rule of <filename>debian/rules</filename>, through "
247 "a dependency on the <literal>patch</literal> rule. Conversely, they are "
248 "reverted in the <literal>clean</literal> rule, through a dependency on the "
249 "<literal>unpatch</literal> rule."
251 "より古いソースフォーマット“1.0”を使っている場合でも、パッチを分割することは可"
252 "能ですが、専用のパッチシステムを使う必要があります: パッチファイルは Debian "
253 "パッチファイル (<filename>.diff.gz</filename>) 内に組み込まれ、通常 "
254 "<filename>debian/</filename> ディレクトリ内にあります。違いは、すぐに "
255 "<command>dpkg-source</command> では適用されないが、<filename>debian/rules</"
256 "filename> の <literal>build</literal> ルールで <literal>patch</literal> ルー"
257 "ルへの依存を通じて適用されることだけです。逆に言うと、これらのパッチは "
258 "<literal>unpatch</literal> ルールへの依存を通じて <literal>clean</literal> "
261 #. type: Content of: <chapter><section><section><para>
262 #: best-pkging-practices.dbk:119
264 "<command>quilt</command> is the recommended tool for this. It does all of "
265 "the above, and also allows to manage patch series. See the <systemitem role="
266 "\"package\">quilt</systemitem> package for more information."
268 "<command>quilt</command> はこの作業にお勧めのツールです。上記の全てを行う上、"
269 "パッチ一覧の管理も可能です。詳細な情報は <systemitem role=\"package\">quilt</"
270 "systemitem> パッケージを参照してください。"
272 #. type: Content of: <chapter><section><section><para>
273 #: best-pkging-practices.dbk:125
275 "There are other tools to manage patches, like <command>dpatch</command>, and "
276 "the patch system integrated with <systemitem role=\"package\">cdbs</"
279 "他にもパッチを管理するツールはあります。<command>dpatch</command> や、パッチ"
280 "システムが統合されている <systemitem role=\"package\">cdbs</systemitem> など"
283 # type: Content of: <chapter><section><section><title>
284 #. type: Content of: <chapter><section><section><title>
285 #: best-pkging-practices.dbk:132
286 msgid "Multiple binary packages"
287 msgstr "複数のバイナリパッケージ"
289 # type: Content of: <chapter><section><section><para>
290 #. type: Content of: <chapter><section><section><para>
291 #: best-pkging-practices.dbk:134
293 "A single source package will often build several binary packages, either to "
294 "provide several flavors of the same software (e.g., the <systemitem role="
295 "\"package\">vim</systemitem> source package) or to make several small "
296 "packages instead of a big one (e.g., so the user can install only the subset "
297 "needed, and thus save some disk space)."
299 "単一のソースパッケージはしばしば複数のバイナリパッケージを生成します。それ"
300 "は、同じソフトウェアで複数のフレーバーを提供することであったり (例: "
301 "<systemitem role=\"package\">vim</systemitem> ソースパッケージ)、巨大なパッ"
302 "ケージではなく複数の小さなパッケージを作ったりします (例: ユーザがサブセット"
303 "のみをインストールできるようにして、ディスク容量を節約できます)。"
305 # type: Content of: <chapter><section><section><para>
306 #. type: Content of: <chapter><section><section><para>
307 #: best-pkging-practices.dbk:141
310 "The second case can be easily managed in <filename>debian/rules</filename>. "
311 "You just need to move the appropriate files from the build directory into "
312 "the package's temporary trees. You can do this using <command>install</"
313 "command> or <command>dh_install</command> from <systemitem role=\"package"
314 "\">debhelper</systemitem>. Be sure to check the different permutations of "
315 "the various packages, ensuring that you have the inter-package dependencies "
316 "set right in <filename>debian/control</filename>."
318 "二つ目の例は、<filename>debian/rules</filename> で簡単に扱うことができます。"
319 "ビルドディレクトリからパッケージの一時ツリーへ、適切なファイルを移動する必要"
320 "があるだけです。これは、<command>install</command> または <systemitem role="
321 "\"package\">debhelper</systemitem> の <command>dh_install</command> を使って"
322 "できます。パッケージ間の依存関係を <filename>debian/control</filename> 内で正"
325 # type: Content of: <chapter><section><section><para>
326 #. type: Content of: <chapter><section><section><para>
327 #: best-pkging-practices.dbk:150
329 "The first case is a bit more difficult since it involves multiple recompiles "
330 "of the same software but with different configuration options. The "
331 "<systemitem role=\"package\">vim</systemitem> source package is an example "
332 "of how to manage this using an hand-crafted <filename>debian/rules</"
335 "最初の例は、同じソフトウェアでありながら異なった設定オプションで複数回再コン"
336 "パイルする必要があるので、ちょっと難しくなります。<systemitem role=\"package"
337 "\">vim</systemitem> ソースパッケージは、手作りの<filename>debian/rules</"
338 "filename> ファイルを使ってどのようにこの作業を扱うか、という例です。"
340 # type: Content of: <chapter><section><title>
341 #. type: Content of: <chapter><section><title>
342 #: best-pkging-practices.dbk:162
343 msgid "Best practices for <filename>debian/control</filename>"
344 msgstr "<filename>debian/control</filename> のベストプラクティス"
346 # type: Content of: <chapter><section><para>
347 #. type: Content of: <chapter><section><para>
348 #: best-pkging-practices.dbk:164
350 # debian policy 訳と照らし合わせてみる
352 "The following practices are relevant to the <filename>debian/control</"
353 "filename> file. They supplement the <ulink url=\"&url-debian-policy;ch-"
354 "binary.html#s-descriptions\">Policy on package descriptions</ulink>."
356 "以下のプラクティスは、<filename>debian/control</filename> ファイルに関するものです。"
357 "<ulink url=\"&url-debian-policy;ch-binary.html#s-descriptions\">"
358 "パッケージ説明文についてのポリシー</ulink> を補完します。"
360 # type: Content of: <chapter><section><para>
361 #. type: Content of: <chapter><section><para>
362 #: best-pkging-practices.dbk:170
365 "The description of the package, as defined by the corresponding field in the "
366 "<filename>control</filename> file, contains both the package synopsis and "
367 "the long description for the package. <xref linkend=\"bpp-desc-basics\"/> "
368 "describes common guidelines for both parts of the package description. "
369 "Following that, <xref linkend=\"bpp-pkg-synopsis\"/> provides guidelines "
370 "specific to the synopsis, and <xref linkend=\"bpp-pkg-desc\"/> contains "
371 "guidelines specific to the description."
373 "パッケージの説明文は、<filename>control</filename> ファイルの対応するフィールドで"
376 "とパッケージの長い説明文の両方を含んでいます。"
377 "<xref linkend=\"bpp-desc-basics\"/> では、パッケージ説明文の両方の部分についての一般的なガイドラインが記述されています。"
378 "それによると、<xref linkend=\"bpp-pkg-synopsis\"/> が synopsis に特化したガイドラインを提供しており、"
379 "そして <xref linkend=\"bpp-pkg-desc\"/> が説明文 (description) に特化したガイドラインを含んでいます。"
381 # type: Content of: <chapter><section><section><title>
382 #. type: Content of: <chapter><section><section><title>
383 #: best-pkging-practices.dbk:179
384 msgid "General guidelines for package descriptions"
385 msgstr "パッケージ説明文の基本的なガイドライン"
387 # type: Content of: <chapter><section><section><para>
388 #. type: Content of: <chapter><section><section><para>
389 #: best-pkging-practices.dbk:181
392 "The package description should be written for the average likely user, the "
393 "average person who will use and benefit from the package. For instance, "
394 "development packages are for developers, and can be technical in their "
395 "language. More general-purpose applications, such as editors, should be "
396 "written for a less technical user."
398 "パッケージの説明文は平均的なユーザーに向けて書く必要があります。平均的な人というのは、"
399 "パッケージを使って得をする人のことです。例えば、開発用パッケージであれば開発者向けですし、"
400 "彼ら向けの言葉でテクニカルに記述することができます。より汎用的なアプリケーション、例えば"
401 "エディタなどであれば、あまり技術的ではないユーザ向けに書く必要があります。"
403 # type: Content of: <chapter><section><section><para>
404 #. type: Content of: <chapter><section><section><para>
405 #: best-pkging-practices.dbk:188
408 "Our review of package descriptions lead us to conclude that most package "
409 "descriptions are technical, that is, are not written to make sense for non-"
410 "technical users. Unless your package really is only for technical users, "
413 "パッケージ説明文のレビューを行った結果、ほとんどがテクニカルなものであり、つまりこれは、"
414 "技術に詳しくはないユーザに通じるように書かれてはいないということです。あなたのパッケージが、"
415 "本当にテクニカルなユーザに対してのみではない場合、これは問題です。"
417 # type: Content of: <chapter><section><section><para>
418 #. type: Content of: <chapter><section><section><para>
419 #: best-pkging-practices.dbk:194
421 "How do you write for non-technical users? Avoid jargon. Avoid referring to "
422 "other applications or frameworks that the user might not be familiar with — "
423 "GNOME or KDE is fine, since users are probably familiar with these terms, "
424 "but GTK+ is probably not. Try not to assume any knowledge at all. If you "
425 "must use technical terms, introduce them."
427 "どうやって技術に詳しくはないユーザに対して書けばいいのでしょう? ジャーゴンを避けましょう。"
428 "ユーザが詳しくないであろう他のアプリケーションやフレームワークへの参照を避けましょうー"
429 "GNOME や KDE については、おそらくユーザはその言葉について知っているでしょうから構いません"
430 "が、GTK+ はおそらくダメです。まったく知識がないと仮定してみましょう。技術用語を使わねば"
433 # type: Content of: <chapter><section><section><para>
434 #. type: Content of: <chapter><section><section><para>
435 #: best-pkging-practices.dbk:201
438 "Be objective. Package descriptions are not the place for advocating your "
439 "package, no matter how much you love it. Remember that the reader may not "
440 "care about the same things you care about."
442 "客観的になりましょう。パッケージ説明文はあなたのパッケージの宣伝場所ではありません。"
443 "あなたがそのパッケージをどんなに愛しているかは関係ありません。"
445 # type: Content of: <chapter><section><section><para>
446 #. type: Content of: <chapter><section><section><para>
447 #: best-pkging-practices.dbk:206
449 "References to the names of any other software packages, protocol names, "
450 "standards, or specifications should use their canonical forms, if one "
451 "exists. For example, use X Window System, X11, or X; not X Windows, X-"
452 "Windows, or X Window. Use GTK+, not GTK or gtk. Use GNOME, not Gnome. Use "
453 "PostScript, not Postscript or postscript."
455 "他のソフトウェアパッケージ、プロトコル名、標準規格、仕様の名前を参照する場合"
456 "には、もしあれば正規名称を使いましょう。X Windows や X-Windows や X Window "
457 "ではなく、X Window System あるいは X11 または X を使いましょう。GTK や gtk "
458 "ではなく GTK+ を使いましょう。Gnome ではなく GNOME を使いましょう。"
459 "Postscript や postscript ではなく PostScript を使いましょう。"
461 # type: Content of: <chapter><section><section><para>
462 #. type: Content of: <chapter><section><section><para>
463 #: best-pkging-practices.dbk:213
465 "If you are having problems writing your description, you may wish to send it "
466 "along to &email-debian-l10n-english; and request feedback."
468 "説明文を書くことに問題があれば、&email-debian-l10n-english; へそれを送って"
469 "フィードバックを求めるとよいでしょう。"
471 # type: Content of: <chapter><section><section><title>
472 #. type: Content of: <chapter><section><section><title>
473 #: best-pkging-practices.dbk:219
474 msgid "The package synopsis, or short description"
475 msgstr "パッケージの概要、あるいは短い説明文"
477 #. type: Content of: <chapter><section><section><para>
478 #: best-pkging-practices.dbk:221
480 "Policy says the synopsis line (the short description) must be concise, not "
481 "repeating the package name, but also informative."
483 "ポリシーでは、概要行 (短い説明文) はパッケージ名を繰り返すのではなく、簡潔"
484 "かつ有益なものである必要がある、となっています。"
486 #. type: Content of: <chapter><section><section><para>
487 #: best-pkging-practices.dbk:225
489 "The synopsis functions as a phrase describing the package, not a complete "
490 "sentence, so sentential punctuation is inappropriate: it does not need extra "
491 "capital letters or a final period (full stop). It should also omit any "
492 "initial indefinite or definite article — \"a\", \"an\", or \"the\". Thus for "
496 #. type: Content of: <chapter><section><section><screen>
497 #: best-pkging-practices.dbk:231
501 "Description: exemplification support library\n"
504 "Description: exemplification support library\n"
506 #. type: Content of: <chapter><section><section><para>
507 #: best-pkging-practices.dbk:235
509 "Technically this is a noun phrase minus articles, as opposed to a verb "
510 "phrase. A good heuristic is that it should be possible to substitute the "
511 "package <replaceable>name</replaceable> and <replaceable>synopsis</"
512 "replaceable> into this formula:"
515 #. type: Content of: <chapter><section><section><para>
516 #: best-pkging-practices.dbk:240
518 "The package <replaceable>name</replaceable> provides {a,an,the,some} "
519 "<replaceable>synopsis</replaceable>."
522 #. type: Content of: <chapter><section><section><para>
523 #: best-pkging-practices.dbk:244
525 "Sets of related packages may use an alternative scheme that divides the "
526 "synopsis into two parts, the first a description of the whole suite and the "
527 "second a summary of the package's role within it:"
530 #. type: Content of: <chapter><section><section><screen>
531 #: best-pkging-practices.dbk:249
534 "Package: eg-tools\n"
535 "Description: simple exemplification system (utilities)\n"
538 "Description: simple exemplification system - documentation\n"
540 "Package: eg-tools\n"
541 "Description: simple exemplification system (utilities)\n"
544 "Description: simple exemplification system - documentation\n"
546 #. type: Content of: <chapter><section><section><para>
547 #: best-pkging-practices.dbk:256
549 "These synopses follow a modified formula. Where a package "
550 "\"<replaceable>name</replaceable>\" has a synopsis \"<replaceable>suite</"
551 "replaceable> (<replaceable>role</replaceable>)\" or \"<replaceable>suite</"
552 "replaceable> - <replaceable>role</replaceable>\", the elements should be "
553 "phrased so that they fit into the formula:"
556 #. type: Content of: <chapter><section><section><para>
557 #: best-pkging-practices.dbk:263
559 "The package <replaceable>name</replaceable> provides {a,an,the} "
560 "<replaceable>role</replaceable> for the <replaceable>suite</replaceable>."
563 # type: Content of: <chapter><section><section><title>
564 #. type: Content of: <chapter><section><section><title>
565 #: best-pkging-practices.dbk:269
566 msgid "The long description"
569 # type: Content of: <chapter><section><section><para>
570 #. type: Content of: <chapter><section><section><para>
571 #: best-pkging-practices.dbk:271
573 "The long description is the primary information available to the user about "
574 "a package before they install it. It should provide all the information "
575 "needed to let the user decide whether to install the package. Assume that "
576 "the user has already read the package synopsis."
579 # type: Content of: <chapter><section><section><para>
580 #. type: Content of: <chapter><section><section><para>
581 #: best-pkging-practices.dbk:277
582 msgid "The long description should consist of full and complete sentences."
585 # type: Content of: <chapter><section><section><para>
586 #. type: Content of: <chapter><section><section><para>
587 #: best-pkging-practices.dbk:280
589 "The first paragraph of the long description should answer the following "
590 "questions: what does the package do? what task does it help the user "
591 "accomplish? It is important to describe this in a non-technical way, unless "
592 "of course the audience for the package is necessarily technical."
595 # type: Content of: <chapter><section><section><para>
596 #. type: Content of: <chapter><section><section><para>
597 #: best-pkging-practices.dbk:286
599 "The following paragraphs should answer the following questions: Why do I as "
600 "a user need this package? What other features does the package have? What "
601 "outstanding features and deficiencies are there compared to other packages "
602 "(e.g., if you need X, use Y instead)? Is this package related to other "
603 "packages in some way that is not handled by the package manager (e.g., this "
604 "is the client for the foo server)?"
607 # type: Content of: <chapter><section><section><para>
608 #. type: Content of: <chapter><section><section><para>
609 #: best-pkging-practices.dbk:294
611 "Be careful to avoid spelling and grammar mistakes. Ensure that you spell-"
612 "check it. Both <command>ispell</command> and <command>aspell</command> have "
613 "special modes for checking <filename>debian/control</filename> files:"
615 "スペルミスや文法の間違いを避けるよう、注意してください。スペルチェックを"
616 "確実に行ってください。<command>ispell</command> と <command>aspell</command> "
617 "の双方に、<filename>debian/control</filename> ファイルをチェックするための"
620 #. type: Content of: <chapter><section><section><screen>
621 #: best-pkging-practices.dbk:299
623 msgid "ispell -d american -g debian/control\n"
624 msgstr "ispell -d american -g debian/control\n"
626 #. type: Content of: <chapter><section><section><screen>
627 #: best-pkging-practices.dbk:302
629 msgid "aspell -d en -D -c debian/control\n"
630 msgstr "aspell -d en -D -c debian/control\n"
632 # type: Content of: <chapter><section><section><para>
633 #. type: Content of: <chapter><section><section><para>
634 #: best-pkging-practices.dbk:305
636 "Users usually expect these questions to be answered in the package "
639 "通常、ユーザは以下のような疑問がパッケージ説明文で答えられることを期待"
642 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
643 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
644 #: best-pkging-practices.dbk:310
646 "What does the package do? If it is an add-on to another package, then the "
647 "short description of the package we are an add-on to should be put in here."
649 "パッケージは何をするの? 他のパッケージのアドオンだった場合、パッケージが"
650 "アドオンであるということを概要文に書く必要があります。"
652 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
653 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
654 #: best-pkging-practices.dbk:316
656 "Why should I want this package? This is related to the above, but not the "
657 "same (this is a mail user agent; this is cool, fast, interfaces with PGP and "
658 "LDAP and IMAP, has features X, Y, and Z)."
660 "なぜこのパッケージを使うべきなの? これは上記に関連しますが、同じではありません "
661 "(これはメールユーザーエージェントです; cool で、速く、PGP や LDAP や IMAP の"
662 "インターフェイスがあり、X や Y や Z の機能があります)。"
664 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
665 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
666 #: best-pkging-practices.dbk:323
668 "If this package should not be installed directly, but is pulled in by "
669 "another package, this should be mentioned."
671 "パッケージが直接インストールされるべきではないが、他のパッケージから引っ張られる時には、"
674 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
675 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
676 #: best-pkging-practices.dbk:329
679 "If the package is <literal>experimental</literal>, or there are other "
680 "reasons it should not be used, if there are other packages that should be "
681 "used instead, it should be here as well."
683 "パッケージが<literal>実験的</literal>である、あるいは使われない方が良い他の理由がある"
684 "場合、同様にここに記載する必要があります。"
686 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
687 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
688 #: best-pkging-practices.dbk:336
690 "How is this package different from the competition? Is it a better "
691 "implementation? more features? different features? Why should I choose this "
694 "パッケージは競合のものと比べてどうでしょうか? より良い実装なのでしょうか? 機能がより豊富"
695 "なのでしょうか? 違った機能があるのでしょうか? このパッケージを選ぶ理由は何でしょう。"
697 # type: Content of: <chapter><section><section><title>
698 #. type: Content of: <chapter><section><section><title>
699 #: best-pkging-practices.dbk:349
700 msgid "Upstream home page"
703 # type: Content of: <chapter><section><section><para>
704 #. type: Content of: <chapter><section><section><para>
705 #: best-pkging-practices.dbk:351
707 "We recommend that you add the URL for the package's home page in the "
708 "<literal>Homepage</literal> field of the <literal>Source</literal> section "
709 "in <filename>debian/control</filename>. Adding this information in the "
710 "package description itself is considered deprecated."
712 "<filename>debian/control</filename> 中の <literal>Source</literal> "
713 "セクションの <literal>Homepage</literal> フィールドへ、パッケージのホームページの "
714 "URL を追加することをお勧めします。この情報をパッケージ説明文自身に追加するのは推奨されない "
715 "(deprecated) であると考えられています。"
717 # type: Content of: <chapter><section><section><title>
718 #. type: Content of: <chapter><section><section><title>
719 #: best-pkging-practices.dbk:359
720 msgid "Version Control System location"
721 msgstr "バージョン管理システムの場所"
723 # type: Content of: <chapter><section><section><para>
724 #. type: Content of: <chapter><section><section><para>
725 #: best-pkging-practices.dbk:361
727 "There are additional fields for the location of the Version Control System "
728 "in <filename>debian/control</filename>."
730 "<filename>debian/control</filename> には、バージョン管理システムの位置についての"
733 # type: Content of: <chapter><section><section><section><title>
734 #. type: Content of: <chapter><section><section><section><title>
735 #: best-pkging-practices.dbk:365
739 # type: Content of: <chapter><section><section><section><para>
740 #. type: Content of: <chapter><section><section><section><para>
741 #: best-pkging-practices.dbk:367
743 "Value of this field should be a <literal>http://</literal> URL pointing to a "
744 "web-browsable copy of the Version Control System repository used to maintain "
745 "the given package, if available."
747 "このフィールドの値は、指定したパッケージのメンテナンスに使われているバージョン管理システムの"
748 "リポジトリのコピーがもしあれば、それを指し示す <literal>http://</literal> URL である必要"
751 # type: Content of: <chapter><section><section><section><para>
752 #. type: Content of: <chapter><section><section><section><para>
753 #: best-pkging-practices.dbk:372
755 "The information is meant to be useful for the final user, willing to browse "
756 "the latest work done on the package (e.g. when looking for the patch fixing "
757 "a bug tagged as <literal>pending</literal> in the bug tracking system)."
759 "この情報は、パッケージに行われた最新の作業を閲覧したいエンドユーザにとって有用であるのが"
760 "目的です (例: バグ追跡システムで <literal>pending</literal> とタグがつけられているバグ"
763 # type: Content of: <chapter><section><section><section><title>
764 #. type: Content of: <chapter><section><section><section><title>
765 #: best-pkging-practices.dbk:379
769 # type: Content of: <chapter><section><section><section><para>
770 #. type: Content of: <chapter><section><section><section><para>
771 #: best-pkging-practices.dbk:381
773 "Value of this field should be a string identifying unequivocally the "
774 "location of the Version Control System repository used to maintain the given "
775 "package, if available. <literal>*</literal> identify the Version Control "
776 "System; currently the following systems are supported by the package "
777 "tracking system: <literal>arch</literal>, <literal>bzr</literal> (Bazaar), "
778 "<literal>cvs</literal>, <literal>darcs</literal>, <literal>git</literal>, "
779 "<literal>hg</literal> (Mercurial), <literal>mtn</literal> (Monotone), "
780 "<literal>svn</literal> (Subversion). It is allowed to specify different VCS "
781 "fields for the same package: they will all be shown in the PTS web interface."
783 "このフィールドの値は、もし利用可能でなのであれば、指定されたパッケージをメンテナンスするのに"
784 "使われているバージョン管理システムの位置を明確に識別できる文字列である必要があります。"
785 "<literal>*</literal> はバージョン管理システムの識別に使われます; 現在では、以下のシステム"
786 "がパッケージ追跡システムによってサポートされています: <literal>arch</literal>、<literal>"
787 "bzr</literal> (Bazaar)、<literal>cvs</literal>、<literal>darcs</literal>、"
788 "<literal>git</literal>、<literal>hg</literal> (Mercurial)、<literal>mtn</literal> "
789 "(Monotone)、<literal>svn</literal> (Subversion)。同じパッケージについて異なった "
790 "VCS を指定することも可能です: これらはすべて PTS のウェブインターフェイスに表示されます。"
792 # type: Content of: <chapter><section><section><section><para>
793 #. type: Content of: <chapter><section><section><section><para>
794 #: best-pkging-practices.dbk:392
796 "The information is meant to be useful for a user knowledgeable in the given "
797 "Version Control System and willing to build the current version of a package "
798 "from the VCS sources. Other uses of this information might include "
799 "automatic building of the latest VCS version of the given package. To this "
800 "end the location pointed to by the field should better be version agnostic "
801 "and point to the main branch (for VCSs supporting such a concept). Also, "
802 "the location pointed to should be accessible to the final user; fulfilling "
803 "this requirement might imply pointing to an anonymous access of the "
804 "repository instead of pointing to an SSH-accessible version of the same."
807 # type: Content of: <chapter><section><section><section><para>
808 #. type: Content of: <chapter><section><section><section><para>
809 #: best-pkging-practices.dbk:403
811 "In the following example, an instance of the field for a Subversion "
812 "repository of the <systemitem role=\"package\">vim</systemitem> package is "
813 "shown. Note how the URL is in the <literal>svn://</literal> scheme (instead "
814 "of <literal>svn+ssh://</literal>) and how it points to the <filename>trunk/</"
815 "filename> branch. The use of the <literal>Vcs-Browser</literal> and "
816 "<literal>Homepage</literal> fields described above is also shown."
818 "以下の例では、<systemitem role=\"package\">vim</systemitem> パッケージの Subversion "
819 "リポジトリに対するフィールドの例が挙げられています。(<literal>svn+ssh://</literal> "
820 "ではなく) <literal>svn://</literal> スキーム中で URL がどのようになっているか、"
821 "<filename>trunk/</filename> ブランチをどのように指し示しているかに注意してください。"
822 "上で挙げられた <literal>Vcs-Browser</literal> フィールドと <literal>Homepage</literal> "
825 # type: Content of: <chapter><section><section><section><screen>
826 #. type: Content of: <chapter><section><section><section><screen>
827 #: best-pkging-practices.dbk:412
831 " Section: editors\n"
832 " Priority: optional\n"
834 " Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim\n"
835 " Vcs-Browser: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim\n"
836 " Homepage: http://www.vim.org\n"
839 " Section: editors\n"
840 " Priority: optional\n"
842 " Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim\n"
843 " Vcs-Browser: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim\n"
844 " Homepage: http://www.vim.org\n"
846 # type: Content of: <chapter><section><title>
847 #. type: Content of: <chapter><section><title>
848 #: best-pkging-practices.dbk:427
849 msgid "Best practices for <filename>debian/changelog</filename>"
850 msgstr "<filename>debian/changelog</filename> のベストプラクティス"
852 # type: Content of: <chapter><section><para>
853 #. type: Content of: <chapter><section><para>
854 #: best-pkging-practices.dbk:429
856 # debian policy 訳と照らし合わせてみる
858 "The following practices supplement the <ulink url=\"&url-debian-policy;ch-"
859 "docs.html#s-changelogs\">Policy on changelog files</ulink>."
861 "以下のプラクティスは <ulink url=\"&url-debian-policy;ch-docs.html"
862 "#s-changelogs\">changelog ファイルに対するポリシー</ulink>を補完します。"
864 # type: Content of: <chapter><section><section><title>
865 #. type: Content of: <chapter><section><section><title>
866 #: best-pkging-practices.dbk:434
867 msgid "Writing useful changelog entries"
868 msgstr "役立つ changelog のエントリを書く"
870 # type: Content of: <chapter><section><section><para>
871 #. type: Content of: <chapter><section><section><para>
872 #: best-pkging-practices.dbk:436
874 "The changelog entry for a package revision documents changes in that "
875 "revision, and only them. Concentrate on describing significant and user-"
876 "visible changes that were made since the last version."
879 # type: Content of: <chapter><section><section><para>
880 #. type: Content of: <chapter><section><section><para>
881 #: best-pkging-practices.dbk:441
883 "Focus on <emphasis>what</emphasis> was changed — who, how and when are "
884 "usually less important. Having said that, remember to politely attribute "
885 "people who have provided notable help in making the package (e.g., those who "
886 "have sent in patches)."
889 # type: Content of: <chapter><section><section><para>
890 #. type: Content of: <chapter><section><section><para>
891 #: best-pkging-practices.dbk:447
893 "There's no need to elaborate the trivial and obvious changes. You can also "
894 "aggregate several changes in one entry. On the other hand, don't be overly "
895 "terse if you have undertaken a major change. Be especially clear if there "
896 "are changes that affect the behaviour of the program. For further "
897 "explanations, use the <filename>README.Debian</filename> file."
900 # type: Content of: <chapter><section><section><para>
901 #. type: Content of: <chapter><section><section><para>
902 #: best-pkging-practices.dbk:454
904 "Use common English so that the majority of readers can comprehend it. Avoid "
905 "abbreviations, tech-speak and jargon when explaining changes that close "
906 "bugs, especially for bugs filed by users that did not strike you as "
907 "particularly technically savvy. Be polite, don't swear."
910 # type: Content of: <chapter><section><section><para>
911 #. type: Content of: <chapter><section><section><para>
912 #: best-pkging-practices.dbk:460
914 "It is sometimes desirable to prefix changelog entries with the names of the "
915 "files that were changed. However, there's no need to explicitly list each "
916 "and every last one of the changed files, especially if the change was small "
917 "or repetitive. You may use wildcards."
920 # type: Content of: <chapter><section><section><para>
921 #. type: Content of: <chapter><section><section><para>
922 #: best-pkging-practices.dbk:466
924 "When referring to bugs, don't assume anything. Say what the problem was, "
925 "how it was fixed, and append the closes: #nnnnn string. See <xref linkend="
926 "\"upload-bugfix\"/> for more information."
929 # type: Content of: <chapter><section><section><title>
930 #. type: Content of: <chapter><section><section><title>
931 #: best-pkging-practices.dbk:473
932 msgid "Common misconceptions about changelog entries"
933 msgstr "changelog のエントリに関するよくある誤解"
935 # type: Content of: <chapter><section><section><para>
936 #. type: Content of: <chapter><section><section><para>
937 #: best-pkging-practices.dbk:475
939 "The changelog entries should <emphasis role=\"strong\">not</emphasis> "
940 "document generic packaging issues (Hey, if you're looking for foo.conf, it's "
941 "in /etc/blah/.), since administrators and users are supposed to be at least "
942 "remotely acquainted with how such things are generally arranged on Debian "
943 "systems. Do, however, mention if you change the location of a configuration "
947 #. type: Content of: <chapter><section><section><para>
948 #: best-pkging-practices.dbk:483
950 "The only bugs closed with a changelog entry should be those that are "
951 "actually fixed in the same package revision. Closing unrelated bugs in the "
952 "changelog is bad practice. See <xref linkend=\"upload-bugfix\"/>."
955 # type: Content of: <chapter><section><section><para>
956 #. type: Content of: <chapter><section><section><para>
957 #: best-pkging-practices.dbk:488
959 "The changelog entries should <emphasis role=\"strong\">not</emphasis> be "
960 "used for random discussion with bug reporters (I don't see segfaults when "
961 "starting foo with option bar; send in more info), general statements on "
962 "life, the universe and everything (sorry this upload took me so long, but I "
963 "caught the flu), or pleas for help (the bug list on this package is huge, "
964 "please lend me a hand). Such things usually won't be noticed by their "
965 "target audience, but may annoy people who wish to read information about "
966 "actual changes in the package. See <xref linkend=\"bug-answering\"/> for "
967 "more information on how to use the bug tracking system."
970 # type: Content of: <chapter><section><section><para>
971 #. type: Content of: <chapter><section><section><para>
972 #: best-pkging-practices.dbk:499
974 "It is an old tradition to acknowledge bugs fixed in non-maintainer uploads "
975 "in the first changelog entry of the proper maintainer upload. As we have "
976 "version tracking now, it is enough to keep the NMUed changelog entries and "
977 "just mention this fact in your own changelog entry."
980 # type: Content of: <chapter><section><section><title>
981 #. type: Content of: <chapter><section><section><title>
982 #: best-pkging-practices.dbk:507
983 msgid "Common errors in changelog entries"
984 msgstr "changelog のエントリ中のよくある間違い"
986 # type: Content of: <chapter><section><section><para>
987 #. type: Content of: <chapter><section><section><para>
988 #: best-pkging-practices.dbk:509
990 "The following examples demonstrate some common errors or examples of bad "
991 "style in changelog entries."
993 "以下の例で、changelog エントリ中のよくある間違いや間違ったスタイルの例を挙げ"
996 # type: Content of: <chapter><section><section><screen>
997 #. type: Content of: <chapter><section><section><screen>
998 #: best-pkging-practices.dbk:513
1000 msgid " * Fixed all outstanding bugs.\n"
1001 msgstr " * Fixed all outstanding bugs.\n"
1003 # type: Content of: <chapter><section><section><para>
1004 #. type: Content of: <chapter><section><section><para>
1005 #: best-pkging-practices.dbk:516
1006 msgid "This doesn't tell readers anything too useful, obviously."
1007 msgstr "これは、全く読み手に何も有用なことを教えてくれません。"
1009 # type: Content of: <chapter><section><section><screen>
1010 #. type: Content of: <chapter><section><section><screen>
1011 #: best-pkging-practices.dbk:519
1013 msgid " * Applied patch from Jane Random.\n"
1014 msgstr " * Applied patch from Jane Random.\n"
1016 # type: Content of: <chapter><section><section><para>
1017 #. type: Content of: <chapter><section><section><para>
1018 #: best-pkging-practices.dbk:522
1019 msgid "What was the patch about?"
1020 msgstr "何についてのパッチですか?"
1022 # type: Content of: <chapter><section><section><screen>
1023 #. type: Content of: <chapter><section><section><screen>
1024 #: best-pkging-practices.dbk:525
1026 msgid " * Late night install target overhaul.\n"
1027 msgstr " * Late night install target overhaul.\n"
1029 # type: Content of: <chapter><section><section><para>
1030 #. type: Content of: <chapter><section><section><para>
1031 #: best-pkging-practices.dbk:528
1033 "Overhaul which accomplished what? Is the mention of late night supposed to "
1034 "remind us that we shouldn't trust that code?"
1037 # type: Content of: <chapter><section><section><screen>
1038 #. type: Content of: <chapter><section><section><screen>
1039 #: best-pkging-practices.dbk:532
1041 msgid " * Fix vsync FU w/ ancient CRTs.\n"
1042 msgstr " * Fix vsync FU w/ ancient CRTs.\n"
1044 # type: Content of: <chapter><section><section><para>
1045 #. type: Content of: <chapter><section><section><para>
1046 #: best-pkging-practices.dbk:535
1049 "Too many acronyms, and it's not overly clear what the, uh, fsckup (oops, a "
1050 "curse word!) was actually about, or how it was fixed."
1051 msgstr "略称が多すぎ、どうやって修正したのか"
1053 # type: Content of: <chapter><section><section><screen>
1054 #. type: Content of: <chapter><section><section><screen>
1055 #: best-pkging-practices.dbk:539
1057 msgid " * This is not a bug, closes: #nnnnnn.\n"
1058 msgstr " * This is not a bug, closes: #nnnnnn.\n"
1060 # type: Content of: <chapter><section><section><para>
1061 #. type: Content of: <chapter><section><section><para>
1062 #: best-pkging-practices.dbk:542
1064 "First of all, there's absolutely no need to upload the package to convey "
1065 "this information; instead, use the bug tracking system. Secondly, there's "
1066 "no explanation as to why the report is not a bug."
1069 # type: Content of: <chapter><section><section><screen>
1070 #. type: Content of: <chapter><section><section><screen>
1071 #: best-pkging-practices.dbk:547
1073 msgid " * Has been fixed for ages, but I forgot to close; closes: #54321.\n"
1074 msgstr " * Has been fixed for ages, but I forgot to close; closes: #54321.\n"
1076 # type: Content of: <chapter><section><section><para>
1077 #. type: Content of: <chapter><section><section><para>
1078 #: best-pkging-practices.dbk:550
1080 "If for some reason you didn't mention the bug number in a previous changelog "
1081 "entry, there's no problem, just close the bug normally in the BTS. There's "
1082 "no need to touch the changelog file, presuming the description of the fix is "
1083 "already in (this applies to the fixes by the upstream authors/maintainers as "
1084 "well, you don't have to track bugs that they fixed ages ago in your "
1088 # type: Content of: <chapter><section><section><screen>
1089 #. type: Content of: <chapter><section><section><screen>
1090 #: best-pkging-practices.dbk:557
1092 msgid " * Closes: #12345, #12346, #15432\n"
1093 msgstr " * Closes: #12345, #12346, #15432\n"
1095 # type: Content of: <chapter><section><section><para>
1096 #. type: Content of: <chapter><section><section><para>
1097 #: best-pkging-practices.dbk:560
1099 "Where's the description? If you can't think of a descriptive message, start "
1100 "by inserting the title of each different bug."
1102 "説明はどこ? 説明文を考えられないのなら、それぞれのバグのタイトルを入れるとこ"
1105 #. type: Content of: <chapter><section><section><title>
1106 #: best-pkging-practices.dbk:566
1108 msgid "Supplementing changelogs with <filename>NEWS.Debian</filename> files"
1109 msgstr "<filename>NEWS.Debian</filename> ファイルで changelog を"
1111 #. type: Content of: <chapter><section><section><para>
1112 #: best-pkging-practices.dbk:568
1114 "Important news about changes in a package can also be put in <filename>NEWS."
1115 "Debian</filename> files. The news will be displayed by tools like "
1116 "<systemitem role=\"package\">apt-listchanges</systemitem>, before all the "
1117 "rest of the changelogs. This is the preferred means to let the user know "
1118 "about significant changes in a package. It is better than using <systemitem "
1119 "role=\"package\">debconf</systemitem> notes since it is less annoying and "
1120 "the user can go back and refer to the <filename>NEWS.Debian</filename> file "
1121 "after the install. And it's better than listing major changes in "
1122 "<filename>README.Debian</filename>, since the user can easily miss such "
1126 #. type: Content of: <chapter><section><section><para>
1127 #: best-pkging-practices.dbk:579
1129 "The file format is the same as a debian changelog file, but leave off the "
1130 "asterisks and describe each news item with a full paragraph when necessary "
1131 "rather than the more concise summaries that would go in a changelog. It's a "
1132 "good idea to run your file through <literal>dpkg-parsechangelog</literal> to "
1133 "check its formatting as it will not be automatically checked during build as "
1134 "the changelog is. Here is an example of a real <filename>NEWS.Debian</"
1138 # type: Content of: <chapter><section><section><screen>
1139 #. type: Content of: <chapter><section><section><screen>
1140 #: best-pkging-practices.dbk:588
1143 "cron (3.0pl1-74) unstable; urgency=low\n"
1145 " The checksecurity script is no longer included with the cron package:\n"
1146 " it now has its own package, checksecurity. If you liked the\n"
1147 " functionality provided with that script, please install the new\n"
1150 " -- Steve Greenland <stevegr@debian.org> Sat, 6 Sep 2003 17:15:03 -0500\n"
1152 "cron (3.0pl1-74) unstable; urgency=low\n"
1154 " The checksecurity script is no longer included with the cron package:\n"
1155 " it now has its own package, checksecurity. If you liked the\n"
1156 " functionality provided with that script, please install the new\n"
1159 " -- Steve Greenland <stevegr@debian.org> Sat, 6 Sep 2003 17:15:03 -0500\n"
1161 #. type: Content of: <chapter><section><section><para>
1162 #: best-pkging-practices.dbk:598
1164 "The <filename>NEWS.Debian</filename> file is installed as <filename>/usr/"
1165 "share/doc/<replaceable>package</replaceable>/NEWS.Debian.gz</filename>. It "
1166 "is compressed, and always has that name even in Debian native packages. If "
1167 "you use <literal>debhelper</literal>, <literal>dh_installchangelogs</"
1168 "literal> will install <filename>debian/NEWS</filename> files for you."
1171 # type: Content of: <chapter><section><section><para>
1172 #. type: Content of: <chapter><section><section><para>
1173 #: best-pkging-practices.dbk:605
1175 "Unlike changelog files, you need not update <filename>NEWS.Debian</filename> "
1176 "files with every release. Only update them if you have something "
1177 "particularly newsworthy that user should know about. If you have no news at "
1178 "all, there's no need to ship a <filename>NEWS.Debian</filename> file in your "
1179 "package. No news is good news!"
1182 # type: Content of: <chapter><section><title>
1183 #. type: Content of: <chapter><section><title>
1184 #: best-pkging-practices.dbk:627
1185 msgid "Best practices for maintainer scripts"
1186 msgstr "メンテナスクリプトのベストプラクティス"
1188 # type: Content of: <chapter><section><para>
1189 #. type: Content of: <chapter><section><para>
1190 #: best-pkging-practices.dbk:629
1192 "Maintainer scripts include the files <filename>debian/postinst</filename>, "
1193 "<filename>debian/preinst</filename>, <filename>debian/prerm</filename> and "
1194 "<filename>debian/postrm</filename>. These scripts take care of any package "
1195 "installation or deinstallation setup which isn't handled merely by the "
1196 "creation or removal of files and directories. The following instructions "
1197 "supplement the <ulink url=\"&url-debian-policy;\">Debian Policy</ulink>."
1199 "メンテナスクリプトには <filename>debian/postinst</filename>、<filename>"
1200 "debian/preinst</filename>、<filename>debian/prerm</filename>、<filename>"
1201 "debian/postrm</filename> ファイルが含まれます。これらのスクリプトは、単なる"
1202 "ファイルやディレクトリの作成や削除では扱われない、パッケージのインストール"
1203 "と削除のセットアップの面倒をみます。以下の説明は、<ulink url=\"&url-debian-"
1204 "policy;\">Debian ポリシー</ulink>を補完します。"
1206 # type: Content of: <chapter><section><para>
1207 #. type: Content of: <chapter><section><para>
1208 #: best-pkging-practices.dbk:637
1210 "Maintainer scripts must be idempotent. That means that you need to make "
1211 "sure nothing bad will happen if the script is called twice where it would "
1212 "usually be called once."
1214 "メンテナスクリプトは冪等でなければなりません。これは、通常は 1 回呼ばれる"
1215 "スクリプトが 2 回呼ばれた場合、何も悪いことが起きないのを保証する必要が"
1218 # type: Content of: <chapter><section><para>
1219 #. type: Content of: <chapter><section><para>
1220 #: best-pkging-practices.dbk:642
1222 "Standard input and output may be redirected (e.g. into pipes) for logging "
1223 "purposes, so don't rely on them being a tty."
1225 "標準入出力はログの取得のためにリダイレクトされることがあります (例: パイプへ"
1226 "向けられる)。ですので、これらが tty であることに依存してはいけません。"
1228 # type: Content of: <chapter><section><para>
1229 #. type: Content of: <chapter><section><para>
1230 #: best-pkging-practices.dbk:646
1232 "All prompting or interactive configuration should be kept to a minimum. "
1233 "When it is necessary, you should use the <systemitem role=\"package"
1234 "\">debconf</systemitem> package for the interface. Remember that prompting "
1235 "in any case can only be in the <literal>configure</literal> stage of the "
1236 "<filename>postinst</filename> script."
1238 "質問や対話的な設定はすべて最小限に止めておく必要があります。必要になった時は、"
1239 "インターフェイスに <systemitem role=\"package\">debconf</systemitem> パッケージ"
1240 "を使いましょう。どのような場合でも、質問は <filename>postinst</filename> "
1241 "スクリプトの <literal>configure</literal> 段階にのみ、配置することができます。"
1243 #FIXME-trans: enable?
1244 # type: Content of: <chapter><section><para>
1245 #. type: Content of: <chapter><section><para>
1246 #: best-pkging-practices.dbk:653
1249 "Keep the maintainer scripts as simple as possible. We suggest you use pure "
1250 "POSIX shell scripts. Remember, if you do need any bash features, the "
1251 "maintainer script must have a bash shebang line. POSIX shell or Bash are "
1252 "preferred to Perl, since they enable <systemitem role=\"package\">debhelper</"
1253 "systemitem> to easily add bits to the scripts."
1255 "メンテナスクリプトは、できる限りシンプルなものにしておきましょう。あなたが、"
1256 "純粋な POSIX シェルスクリプトを使っているものだとします。覚えておいてください。"
1257 "何かしら bash の機能が必要になったら、メンテナスクリプトは bash のシェバン行"
1258 "にしておく必要があります。スクリプトを少し"
1259 "<systemitem role=\"package\">debhelper</systemitem> "
1260 "Perl より、POSIX シェルあるいは Bash の方が好まれます。"
1262 # type: Content of: <chapter><section><para>
1263 #. type: Content of: <chapter><section><para>
1264 #: best-pkging-practices.dbk:660
1266 "If you change your maintainer scripts, be sure to test package removal, "
1267 "double installation, and purging. Be sure that a purged package is "
1268 "completely gone, that is, it must remove any files created, directly or "
1269 "indirectly, in any maintainer script."
1271 "メンテナスクリプトを変更したら、パッケージの削除や二重インストール、purge "
1272 "のテストを確認してください。purge されたパッケージが完全に削除されたことを"
1273 "確認してください。つまり、メンテナスクリプト中で直接/間接を問わず作成された"
1274 "ファイルを削除する必要があるということです。"
1276 # type: Content of: <chapter><section><para>
1277 #. type: Content of: <chapter><section><para>
1278 #: best-pkging-practices.dbk:666
1280 "If you need to check for the existence of a command, you should use "
1283 "コマンドの存在をチェックする必要がある場合は、こんな感じで行います"
1285 # type: Content of: <chapter><section><programlisting>
1286 #. type: Content of: <chapter><section><programlisting>
1287 #: best-pkging-practices.dbk:669
1289 msgid "if [ -x /usr/sbin/install-docs ]; then ..."
1290 msgstr "if [ -x /usr/sbin/install-docs ]; then ..."
1292 # type: Content of: <chapter><section><para>
1293 #. type: Content of: <chapter><section><para>
1294 #: best-pkging-practices.dbk:671
1296 "If you don't wish to hard-code the path of a command in your maintainer "
1297 "script, the following POSIX-compliant shell function may help:"
1299 "メンテナスクリプト中でコマンドの path をハードコードしたくない場合には、"
1300 "以下の POSIX 互換シェル機能が役立つでしょう:"
1302 #. type: Content of: <chapter><section><para>
1303 #: best-pkging-practices.dbk:676
1305 "You can use this function to search <varname>$PATH</varname> for a command "
1306 "name, passed as an argument. It returns true (zero) if the command was "
1307 "found, and false if not. This is really the most portable way, since "
1308 "<literal>command -v</literal>, <command>type</command>, and <command>which</"
1309 "command> are not POSIX."
1311 "コマンド名を引数として渡すことで、<varname>$PATH</varname> の検索するのに"
1312 "この関数を使うことができます。コマンドが見つかった場合は true (ゼロ) を返し、"
1313 "そうでない場合は false を返します。<literal>command -v</literal>、<command>"
1314 "type</command>、<command>which</command> は POSIX に無いので、これがもっとも"
1317 # type: Content of: <chapter><section><para>
1318 #. type: Content of: <chapter><section><para>
1319 #: best-pkging-practices.dbk:683
1321 "While <command>which</command> is an acceptable alternative, since it is "
1322 "from the required <systemitem role=\"package\">debianutils</systemitem> "
1323 "package, it's not on the root partition. That is, it's in <filename>/usr/"
1324 "bin</filename> rather than <filename>/bin</filename>, so one can't use it in "
1325 "scripts which are run before the <filename>/usr</filename> partition is "
1326 "mounted. Most scripts won't have this problem, though."
1328 "<command>which</command> は、Required となっている <systemitem role"
1329 "=\"package\">debianutils</systemitem> パッケージにあるので、別解として利用"
1330 "可能ですが、ルートパーティションにありません。つまり、<filename>/usr/bin"
1331 "</filename> にあって <filename>/bin</filename> ではないので、<filename>/usr"
1332 "</filename> パーティションがマウントする前に走るスクリプトの中では使えない"
1333 "ということです。ほとんどのスクリプトは、この問題を持つようなことはありませんが。"
1335 # type: Content of: <chapter><section><title>
1336 #. type: Content of: <chapter><section><title>
1337 #: best-pkging-practices.dbk:693
1339 "Configuration management with <systemitem role=\"package\">debconf</"
1342 "<systemitem role=\"package\">debconf</systemitem> による設定管理"
1344 # type: Content of: <chapter><section><para>
1345 #. type: Content of: <chapter><section><para>
1346 #: best-pkging-practices.dbk:695
1348 "<systemitem role=\"package\">Debconf</systemitem> is a configuration "
1349 "management system which can be used by all the various packaging scripts "
1350 "(<filename>postinst</filename> mainly) to request feedback from the user "
1351 "concerning how to configure the package. Direct user interactions must now "
1352 "be avoided in favor of <systemitem role=\"package\">debconf</systemitem> "
1353 "interaction. This will enable non-interactive installations in the future."
1356 # type: Content of: <chapter><section><para>
1357 #. type: Content of: <chapter><section><para>
1358 #: best-pkging-practices.dbk:703
1360 "Debconf is a great tool but it is often poorly used. Many common mistakes "
1361 "are listed in the <citerefentry> <refentrytitle>debconf-devel</"
1362 "refentrytitle> <manvolnum>7</manvolnum> </citerefentry> man page. It is "
1363 "something that you must read if you decide to use debconf. Also, we "
1364 "document some best practices here."
1367 # type: Content of: <chapter><section><para>
1368 #. type: Content of: <chapter><section><para>
1369 #: best-pkging-practices.dbk:710
1371 "These guidelines include some writing style and typography recommendations, "
1372 "general considerations about debconf usage as well as more specific "
1373 "recommendations for some parts of the distribution (the installation system "
1377 # type: Content of: <chapter><section><section><title>
1378 #. type: Content of: <chapter><section><section><title>
1379 #: best-pkging-practices.dbk:716
1380 msgid "Do not abuse debconf"
1381 msgstr "debconf を乱用しない"
1383 # type: Content of: <chapter><section><section><para>
1384 #. type: Content of: <chapter><section><section><para>
1385 #: best-pkging-practices.dbk:718
1387 "Since debconf appeared in Debian, it has been widely abused and several "
1388 "criticisms received by the Debian distribution come from debconf abuse with "
1389 "the need of answering a wide bunch of questions before getting any little "
1393 #. type: Content of: <chapter><section><section><para>
1394 #: best-pkging-practices.dbk:724
1396 "Keep usage notes to what they belong: the <filename>NEWS.Debian</filename>, "
1397 "or <filename>README.Debian</filename> file. Only use notes for important "
1398 "notes which may directly affect the package usability. Remember that notes "
1399 "will always block the install until confirmed or bother the user by email."
1402 # type: Content of: <chapter><section><section><para>
1403 #. type: Content of: <chapter><section><section><para>
1404 #: best-pkging-practices.dbk:730
1406 "Carefully choose the questions priorities in maintainer scripts. See "
1407 "<citerefentry> <refentrytitle>debconf-devel</refentrytitle> <manvolnum>7</"
1408 "manvolnum> </citerefentry> for details about priorities. Most questions "
1409 "should use medium and low priorities."
1412 # type: Content of: <chapter><section><section><title>
1413 #. type: Content of: <chapter><section><section><title>
1414 #: best-pkging-practices.dbk:738
1415 msgid "General recommendations for authors and translators"
1418 # type: Content of: <chapter><section><section><section><title>
1419 #. type: Content of: <chapter><section><section><section><title>
1420 #: best-pkging-practices.dbk:740
1421 msgid "Write correct English"
1424 # type: Content of: <chapter><section><section><section><para>
1425 #. type: Content of: <chapter><section><section><section><para>
1426 #: best-pkging-practices.dbk:742
1428 "Most Debian package maintainers are not native English speakers. So, "
1429 "writing properly phrased templates may not be easy for them."
1432 # type: Content of: <chapter><section><section><section><para>
1433 #. type: Content of: <chapter><section><section><section><para>
1434 #: best-pkging-practices.dbk:746
1436 "Please use (and abuse) &email-debian-l10n-english; mailing list. Have your "
1437 "templates proofread."
1440 #. type: Content of: <chapter><section><section><section><para>
1441 #: best-pkging-practices.dbk:750
1443 "Badly written templates give a poor image of your package, of your work... "
1444 "or even of Debian itself."
1447 # type: Content of: <chapter><section><section><section><para>
1448 #. type: Content of: <chapter><section><section><section><para>
1449 #: best-pkging-practices.dbk:754
1451 "Avoid technical jargon as much as possible. If some terms sound common to "
1452 "you, they may be impossible to understand for others. If you cannot avoid "
1453 "them, try to explain them (use the extended description). When doing so, "
1454 "try to balance between verbosity and simplicity."
1457 # type: Content of: <chapter><section><section><section><title>
1458 #. type: Content of: <chapter><section><section><section><title>
1459 #: best-pkging-practices.dbk:762
1460 msgid "Be kind to translators"
1463 # type: Content of: <chapter><section><section><section><para>
1464 #. type: Content of: <chapter><section><section><section><para>
1465 #: best-pkging-practices.dbk:764
1467 "Debconf templates may be translated. Debconf, along with its sister package "
1468 "<command>po-debconf</command> offers a simple framework for getting "
1469 "templates translated by translation teams or even individuals."
1472 #. type: Content of: <chapter><section><section><section><para>
1473 #: best-pkging-practices.dbk:769
1475 "Please use gettext-based templates. Install <systemitem role=\"package\">po-"
1476 "debconf</systemitem> on your development system and read its documentation "
1477 "(<command>man po-debconf</command> is a good start)."
1480 #. type: Content of: <chapter><section><section><section><para>
1481 #: best-pkging-practices.dbk:774
1483 "Avoid changing templates too often. Changing templates text induces more "
1484 "work to translators which will get their translation fuzzied. A fuzzy "
1485 "translation is a string for which the original changed since it was "
1486 "translated, therefore requiring some update by a translator to be usable. "
1487 "When changes are small enough, the original translation is kept in PO files "
1488 "but marked as <literal>fuzzy</literal>."
1491 #. type: Content of: <chapter><section><section><section><para>
1492 #: best-pkging-practices.dbk:782
1494 "If you plan to do changes to your original templates, please use the "
1495 "notification system provided with the <systemitem role=\"package\">po-"
1496 "debconf</systemitem> package, namely the <command>podebconf-report-po</"
1497 "command>, to contact translators. Most active translators are very "
1498 "responsive and getting their work included along with your modified "
1499 "templates will save you additional uploads. If you use gettext-based "
1500 "templates, the translator's name and e-mail addresses are mentioned in the "
1501 "PO files headers and will be used by <command>podebconf-report-po</command>."
1504 #. type: Content of: <chapter><section><section><section><para>
1505 #: best-pkging-practices.dbk:794
1506 msgid "A recommended use of that utility is:"
1509 #. type: Content of: <chapter><section><section><section><programlisting>
1510 #: best-pkging-practices.dbk:796
1512 msgid "cd debian/po && podebconf-report-po --call --languageteam --withtranslators --deadline=\"+10 days\""
1515 #. type: Content of: <chapter><section><section><section><para>
1516 #: best-pkging-practices.dbk:798
1518 "This command will first synchronize the PO and POT files in <filename>debian/"
1519 "po</filename> with the templates files listed in <filename>debian/po/"
1520 "POTFILES.in</filename>. Then, it will send a call for new translations, in "
1521 "the &email-debian-i18n; mailing list. Finally, it will also send a call for "
1522 "translation updates to the language team (mentioned in the <literal>Language-"
1523 "Team</literal> field of each PO file) as well as the last translator "
1524 "(mentioned in <literal>Last-translator</literal>)."
1527 #. type: Content of: <chapter><section><section><section><para>
1528 #: best-pkging-practices.dbk:807
1530 "Giving a deadline to translators is always appreciated, so that they can "
1531 "organize their work. Please remember that some translation teams have a "
1532 "formalized translate/review process and a delay lower than 10 days is "
1533 "considered as unreasonable. A shorter delay puts too much pressure on "
1534 "translation teams and should be kept for very minor changes."
1537 # type: Content of: <chapter><section><section><section><para>
1538 #. type: Content of: <chapter><section><section><section><para>
1539 #: best-pkging-practices.dbk:814
1541 "If in doubt, you may also contact the translation team for a given language "
1542 "(debian-l10n-xxxxx@&lists-host;), or the &email-debian-i18n; mailing list."
1545 # type: Content of: <chapter><section><section><section><title>
1546 #. type: Content of: <chapter><section><section><section><title>
1547 #: best-pkging-practices.dbk:821
1548 msgid "Unfuzzy complete translations when correcting typos and spelling"
1551 #. type: Content of: <chapter><section><section><section><para>
1552 #: best-pkging-practices.dbk:823
1554 "When the text of a debconf template is corrected and you are <emphasis role="
1555 "\"strong\">sure</emphasis> that the change does <emphasis role=\"strong"
1556 "\">not</emphasis> affect translations, please be kind to translators and "
1557 "<emphasis>unfuzzy</emphasis> their translations."
1560 # type: Content of: <chapter><section><section><section><para>
1561 #. type: Content of: <chapter><section><section><section><para>
1562 #: best-pkging-practices.dbk:829
1564 "If you don't do so, the whole template will not be translated as long as a "
1565 "translator will send you an update."
1568 #. type: Content of: <chapter><section><section><section><para>
1569 #: best-pkging-practices.dbk:833
1571 "To <emphasis>unfuzzy</emphasis> translations, you can use two methods. The "
1572 "first method does <emphasis>preventive</emphasis> search and replace actions "
1573 "in the PO files. The latter uses <command>gettext</command> utilities to "
1574 "<emphasis>unfuzzy</emphasis> strings."
1577 #. type: Content of: <chapter><section><section><section><para>
1578 #: best-pkging-practices.dbk:839
1579 msgid "<emphasis>Preventive unfuzzy</emphasis> method:"
1582 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1583 #: best-pkging-practices.dbk:844
1585 "Try finding a complete translation file <emphasis role=\"strong\">before</"
1586 "emphasis> the change:"
1589 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1590 #: best-pkging-practices.dbk:847 best-pkging-practices.dbk:918
1592 msgid "for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null --statistics $i; done"
1595 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1596 #: best-pkging-practices.dbk:849
1598 "The file only showing <emphasis>translated</emphasis> items will be used as "
1599 "the reference file. If there is none (which should not happen if you take "
1600 "care to properly interact with translators), you should use the file with "
1601 "the most translated strings."
1604 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1605 #: best-pkging-practices.dbk:857
1607 "Identify the needed change. In this example, let's assume the change is "
1608 "about fixing a typo in the word <literal>typo</literal> which was "
1609 "inadvertently written as <literal>tpyo</literal>. Therefore, the change is "
1610 "<command>s/tpyo/typo</command>."
1613 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1614 #: best-pkging-practices.dbk:865
1616 "Check that this change is only applied to the place where you really intend "
1617 "to make it and <emphasis role=\"strong\">not</emphasis> in any other place "
1618 "where the original string is appropriate. This specifically applies to "
1619 "change in punctuation, for instance."
1622 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1623 #: best-pkging-practices.dbk:873
1625 "Modify all PO files by using <command>sed</command>. The use of that command "
1626 "is recommended over any text editor to guarantee that the files encoding "
1627 "will not be broken by the edit action:"
1630 # type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1631 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1632 #: best-pkging-practices.dbk:878
1636 "for i in *.po; do sed -i 's/tpyo/typo/g' $i; done\n"
1639 "for i in *.po; do sed -i 's/tpyo/typo/g' $i; done\n"
1641 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1642 #: best-pkging-practices.dbk:884
1643 msgid "Change the debconf template file to fix the typo."
1646 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1647 #: best-pkging-practices.dbk:889
1648 msgid "Run <command>debconf-updatepo</command>."
1649 msgstr "<command>debconf-updatepo</command> を実行する。"
1651 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1652 #: best-pkging-practices.dbk:894
1654 "Check the <filename>foo.po</filename> reference file. Its statistics should "
1658 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1659 #: best-pkging-practices.dbk:898
1661 msgid "msgfmt -o /dev/null --statistics debian/po/foo.po\n"
1662 msgstr "msgfmt -o /dev/null --statistics debian/po/foo.po\n"
1664 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1665 #: best-pkging-practices.dbk:903
1667 "If the file's statistics changed, you did something wrong. Try again or ask "
1668 "for help on the &email-debian-i18n; mailing list."
1671 #. type: Content of: <chapter><section><section><section><para>
1672 #: best-pkging-practices.dbk:909
1673 msgid "Gettext utilities method:"
1674 msgstr "gettext ユーティリティを使う方法:"
1676 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1677 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1678 #: best-pkging-practices.dbk:914
1681 "Put all incomplete PO files out of the way. You can check the completeness "
1682 "by using (needs the <systemitem role=\"package\">gettext</systemitem> "
1683 "package installed):"
1686 "以下の様にすれば達成度をチェックできます (<systemitem role=\"package\">gettext</systemitem> "
1687 "パッケージがインストールされている必要があります):"
1689 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1690 #: best-pkging-practices.dbk:922
1692 "Move all files which report either fuzzy strings to a temporary place. "
1693 "Files which report no fuzzy strings (only translated and untranslated) will "
1697 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1698 #: best-pkging-practices.dbk:929
1700 "Now <emphasis role=\"strong\">and now only</emphasis>, modify the template "
1701 "for the typos and check again that translation are not impacted (typos, "
1702 "spelling errors, sometimes typographical corrections are usually OK)."
1705 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1706 #: best-pkging-practices.dbk:936
1709 "Run <command>debconf-updatepo</command>. This will fuzzy all strings you "
1710 "modified in translations. You can see this by running the above again."
1712 "<command>debconf-updatepo</command> を実行します。これは、翻訳中であなたが"
1713 "変更したすべての文字列を fuzzy にします。"
1715 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1716 #: best-pkging-practices.dbk:942
1717 msgid "Use the following command:"
1718 msgstr "以下のコマンドを利用してください:"
1720 # type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1721 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
1722 #: best-pkging-practices.dbk:944
1724 msgid "for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done"
1725 msgstr "for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done"
1727 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1728 #: best-pkging-practices.dbk:948
1730 "Move back to <filename>debian/po</filename> the files which showed fuzzy "
1731 "strings in the first step."
1733 "最初の手順で fuzzy 文字列を表示していた <filename>debian/po</filename> のファイルに"
1736 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
1737 #: best-pkging-practices.dbk:953
1738 msgid "Run <command>debconf-updatepo</command> again."
1739 msgstr "再度 <command>debconf-updatepo</command> を実行してください。"
1741 # type: Content of: <chapter><section><section><section><title>
1742 #. type: Content of: <chapter><section><section><section><title>
1743 #: best-pkging-practices.dbk:960
1744 msgid "Do not make assumptions about interfaces"
1747 #. type: Content of: <chapter><section><section><section><para>
1748 #: best-pkging-practices.dbk:962
1750 "Templates text should not make reference to widgets belonging to some "
1751 "debconf interfaces. Sentences like <emphasis>If you answer Yes...</"
1752 "emphasis> have no meaning for users of graphical interfaces which use "
1753 "checkboxes for boolean questions."
1756 # type: Content of: <chapter><section><section><section><para>
1757 #. type: Content of: <chapter><section><section><section><para>
1758 #: best-pkging-practices.dbk:967
1760 "String templates should also avoid mentioning the default values in their "
1761 "description. First, because this is redundant with the values seen by the "
1762 "users. Also, because these default values may be different from the "
1763 "maintainer choices (for instance, when the debconf database was preseeded)."
1766 # type: Content of: <chapter><section><section><section><para>
1767 #. type: Content of: <chapter><section><section><section><para>
1768 #: best-pkging-practices.dbk:973
1770 "More generally speaking, try to avoid referring to user actions. Just give "
1774 # type: Content of: <chapter><section><section><section><title>
1775 #. type: Content of: <chapter><section><section><section><title>
1776 #: best-pkging-practices.dbk:979
1777 msgid "Do not use first person"
1780 #. type: Content of: <chapter><section><section><section><para>
1781 #: best-pkging-practices.dbk:981
1783 "You should avoid the use of first person (<emphasis>I will do this...</"
1784 "emphasis> or <emphasis>We recommend...</emphasis>). The computer is not a "
1785 "person and the Debconf templates do not speak for the Debian developers. "
1786 "You should use neutral construction. Those of you who already wrote "
1787 "scientific publications, just write your templates like you would write a "
1788 "scientific paper. However, try using active voice if still possible, like "
1789 "<emphasis>Enable this if ...</emphasis> instead of <emphasis>This can be "
1790 "enabled if...</emphasis>."
1793 # type: Content of: <chapter><section><section><section><title>
1794 #. type: Content of: <chapter><section><section><section><title>
1795 #: best-pkging-practices.dbk:991
1796 msgid "Be gender neutral"
1797 msgstr "性差に対して中立であってください"
1799 # type: Content of: <chapter><section><section><section><para>
1800 #. type: Content of: <chapter><section><section><section><para>
1801 #: best-pkging-practices.dbk:993
1804 "The world is made of men and women. Please use gender-neutral constructions "
1807 "世界は男と女で成り立っています。記述の際には、性差に対して中立な書き方を行ってください。"
1809 # type: Content of: <chapter><section><section><title>
1810 #. type: Content of: <chapter><section><section><title>
1811 #: best-pkging-practices.dbk:1001
1812 msgid "Templates fields definition"
1813 msgstr "テンプレートのフィールド定義"
1815 # type: Content of: <chapter><section><section><para>
1816 #. type: Content of: <chapter><section><section><para>
1817 #: best-pkging-practices.dbk:1003
1819 "This part gives some information which is mostly taken from the "
1820 "<citerefentry> <refentrytitle>debconf-devel</refentrytitle> <manvolnum>7</"
1821 "manvolnum> </citerefentry> manual page."
1824 # type: Content of: <chapter><section><section><section><title>
1825 #. type: Content of: <chapter><section><section><section><title>
1826 #: best-pkging-practices.dbk:1008
1830 #. type: Content of: <chapter><section><section><section><section><title>
1831 #: best-pkging-practices.dbk:1010
1835 # type: Content of: <chapter><section><section><section><section><para>
1836 #. type: Content of: <chapter><section><section><section><section><para>
1837 #: best-pkging-practices.dbk:1012
1839 "Results in a free-form input field that the user can type any string into."
1842 #. type: Content of: <chapter><section><section><section><section><title>
1843 #: best-pkging-practices.dbk:1017
1847 # type: Content of: <chapter><section><section><section><section><para>
1848 #. type: Content of: <chapter><section><section><section><section><para>
1849 #: best-pkging-practices.dbk:1019
1851 "Prompts the user for a password. Use this with caution; be aware that the "
1852 "password the user enters will be written to debconf's database. You should "
1853 "probably clean that value out of the database as soon as is possible."
1856 #. type: Content of: <chapter><section><section><section><section><title>
1857 #: best-pkging-practices.dbk:1026
1861 # type: Content of: <chapter><section><section><section><section><para>
1862 #. type: Content of: <chapter><section><section><section><section><para>
1863 #: best-pkging-practices.dbk:1028
1865 "A true/false choice. Remember: true/false, <emphasis role=\"strong\">not "
1866 "yes/no</emphasis>..."
1868 "true/false の選択です。注意点: true/false であって、<emphasis role=\"strong\">"
1869 "yes/no ではありません</emphasis>..."
1871 #. type: Content of: <chapter><section><section><section><section><title>
1872 #: best-pkging-practices.dbk:1034
1876 #. type: Content of: <chapter><section><section><section><section><para>
1877 #: best-pkging-practices.dbk:1036
1879 "A choice between one of a number of values. The choices must be specified "
1880 "in a field named 'Choices'. Separate the possible values with commas and "
1881 "spaces, like this: <literal>Choices: yes, no, maybe</literal>."
1884 #. type: Content of: <chapter><section><section><section><section><para>
1885 #: best-pkging-practices.dbk:1041
1887 "If choices are translatable strings, the 'Choices' field may be marked as "
1888 "translatable by using <literal>__Choices</literal>. The double underscore "
1889 "will split out each choice in a separate string."
1892 #. type: Content of: <chapter><section><section><section><section><para>
1893 #: best-pkging-practices.dbk:1046
1895 "The <command>po-debconf</command> system also offers interesting "
1896 "possibilities to only mark <emphasis role=\"strong\">some</emphasis> choices "
1897 "as translatable. Example:"
1900 #. type: Content of: <chapter><section><section><section><section><programlisting>
1901 #: best-pkging-practices.dbk:1051
1904 "Template: foo/bar\n"
1906 "#flag:translate:3\n"
1907 "__Choices: PAL, SECAM, Other\n"
1908 "_Description: TV standard:\n"
1909 " Please choose the TV standard used in your country.\n"
1911 "Template: foo/bar\n"
1913 "#flag:translate:3\n"
1914 "__Choices: PAL, SECAM, Other\n"
1915 "_Description: TV standard:\n"
1916 " Please choose the TV standard used in your country.\n"
1918 #. type: Content of: <chapter><section><section><section><section><para>
1919 #: best-pkging-practices.dbk:1059
1921 "In that example, only the 'Other' string is translatable while others are "
1922 "acronyms that should not be translated. The above allows only 'Other' to be "
1923 "included in PO and POT files."
1926 #. type: Content of: <chapter><section><section><section><section><para>
1927 #: best-pkging-practices.dbk:1064
1929 "The debconf templates flag system offers many such possibilities. The "
1930 "<citerefentry> <refentrytitle>po-debconf</refentrytitle> <manvolnum>7</"
1931 "manvolnum> </citerefentry> manual page lists all these possibilities."
1934 #. type: Content of: <chapter><section><section><section><section><title>
1935 #: best-pkging-practices.dbk:1072
1937 msgstr "multiselect"
1939 # type: Content of: <chapter><section><section><section><section><para>
1940 #. type: Content of: <chapter><section><section><section><section><para>
1941 #: best-pkging-practices.dbk:1074
1943 "Like the select data type, except the user can choose any number of items "
1944 "from the choices list (or chose none of them)."
1947 #. type: Content of: <chapter><section><section><section><section><title>
1948 #: best-pkging-practices.dbk:1080
1952 # type: Content of: <chapter><section><section><section><section><para>
1953 #. type: Content of: <chapter><section><section><section><section><para>
1954 #: best-pkging-practices.dbk:1082
1956 "Rather than being a question per se, this datatype indicates a note that can "
1957 "be displayed to the user. It should be used only for important notes that "
1958 "the user really should see, since debconf will go to great pains to make "
1959 "sure the user sees it; halting the install for them to press a key, and even "
1960 "mailing the note to them in some cases."
1963 #. type: Content of: <chapter><section><section><section><section><title>
1964 #: best-pkging-practices.dbk:1091
1968 # type: Content of: <chapter><section><section><section><section><para>
1969 #. type: Content of: <chapter><section><section><section><section><para>
1970 #: best-pkging-practices.dbk:1093
1971 msgid "This type is now considered obsolete: don't use it."
1972 msgstr "この種類は現状では古すぎるものと考えられています: 使わないでください。"
1974 #. type: Content of: <chapter><section><section><section><section><title>
1975 #: best-pkging-practices.dbk:1098
1979 # type: Content of: <chapter><section><section><section><section><para>
1980 #. type: Content of: <chapter><section><section><section><section><para>
1981 #: best-pkging-practices.dbk:1100
1983 "This type is designed to handle error messages. It is mostly similar to the "
1984 "note type. Frontends may present it differently (for instance, the dialog "
1985 "frontend of cdebconf draws a red screen instead of the usual blue one)."
1988 # type: Content of: <chapter><section><section><section><section><para>
1989 #. type: Content of: <chapter><section><section><section><section><para>
1990 #: best-pkging-practices.dbk:1105
1992 "It is recommended to use this type for any message that needs user attention "
1993 "for a correction of any kind."
1996 # type: Content of: <chapter><section><section><section><title>
1997 #. type: Content of: <chapter><section><section><section><title>
1998 #: best-pkging-practices.dbk:1113
1999 msgid "Description: short and extended description"
2002 # type: Content of: <chapter><section><section><section><para>
2003 #. type: Content of: <chapter><section><section><section><para>
2004 #: best-pkging-practices.dbk:1115
2006 "Template descriptions have two parts: short and extended. The short "
2007 "description is in the Description: line of the template."
2010 # type: Content of: <chapter><section><section><section><para>
2011 #. type: Content of: <chapter><section><section><section><para>
2012 #: best-pkging-practices.dbk:1119
2014 "The short description should be kept short (50 characters or so) so that it "
2015 "may be accommodated by most debconf interfaces. Keeping it short also helps "
2016 "translators, as usually translations tend to end up being longer than the "
2020 # type: Content of: <chapter><section><section><section><para>
2021 #. type: Content of: <chapter><section><section><section><para>
2022 #: best-pkging-practices.dbk:1125
2024 "The short description should be able to stand on its own. Some interfaces "
2025 "do not show the long description by default, or only if the user explicitely "
2026 "asks for it or even do not show it at all. Avoid things like What do you "
2030 # type: Content of: <chapter><section><section><section><para>
2031 #. type: Content of: <chapter><section><section><section><para>
2032 #: best-pkging-practices.dbk:1131
2034 "The short description does not necessarily have to be a full sentence. This "
2035 "is part of the keep it short and efficient recommendation."
2038 # type: Content of: <chapter><section><section><section><para>
2039 #. type: Content of: <chapter><section><section><section><para>
2040 #: best-pkging-practices.dbk:1135
2042 "The extended description should not repeat the short description word for "
2043 "word. If you can't think up a long description, then first, think some "
2044 "more. Post to debian-devel. Ask for help. Take a writing class! That "
2045 "extended description is important. If after all that you still can't come "
2046 "up with anything, leave it blank."
2049 # type: Content of: <chapter><section><section><section><para>
2050 #. type: Content of: <chapter><section><section><section><para>
2051 #: best-pkging-practices.dbk:1142
2053 "The extended description should use complete sentences. Paragraphs should "
2054 "be kept short for improved readability. Do not mix two ideas in the same "
2055 "paragraph but rather use another paragraph."
2058 # type: Content of: <chapter><section><section><section><para>
2059 #. type: Content of: <chapter><section><section><section><para>
2060 #: best-pkging-practices.dbk:1147
2062 "Don't be too verbose. User tend to ignore too long screens. 20 lines are "
2063 "by experience a border you shouldn't cross, because that means that in the "
2064 "classical dialog interface, people will need to scroll, and lot of people "
2065 "just don't do that."
2068 # type: Content of: <chapter><section><section><section><para>
2069 #. type: Content of: <chapter><section><section><section><para>
2070 #: best-pkging-practices.dbk:1153
2072 "The extended description should <emphasis role=\"strong\">never</emphasis> "
2073 "include a question."
2076 # type: Content of: <chapter><section><section><section><para>
2077 #. type: Content of: <chapter><section><section><section><para>
2078 #: best-pkging-practices.dbk:1157
2080 "For specific rules depending on templates type (string, boolean, etc.), "
2081 "please read below."
2084 # type: Content of: <chapter><section><section><section><title>
2085 #. type: Content of: <chapter><section><section><section><title>
2086 #: best-pkging-practices.dbk:1163
2090 #. type: Content of: <chapter><section><section><section><para>
2091 #: best-pkging-practices.dbk:1165
2093 "This field should be used for select and multiselect types. It contains the "
2094 "possible choices which will be presented to users. These choices should be "
2095 "separated by commas."
2098 # type: Content of: <chapter><section><section><section><title>
2099 #. type: Content of: <chapter><section><section><section><title>
2100 #: best-pkging-practices.dbk:1172
2104 # type: Content of: <chapter><section><section><section><para>
2105 #. type: Content of: <chapter><section><section><section><para>
2106 #: best-pkging-practices.dbk:1174
2108 "This field is optional. It contains the default answer for string, select "
2109 "and multiselect templates. For multiselect templates, it may contain a "
2110 "comma-separated list of choices."
2113 # type: Content of: <chapter><section><section><title>
2114 #. type: Content of: <chapter><section><section><title>
2115 #: best-pkging-practices.dbk:1183
2116 msgid "Templates fields specific style guide"
2119 # type: Content of: <chapter><section><section><section><title>
2120 #. type: Content of: <chapter><section><section><section><title>
2121 #: best-pkging-practices.dbk:1185
2125 # type: Content of: <chapter><section><section><section><para>
2126 #. type: Content of: <chapter><section><section><section><para>
2127 #: best-pkging-practices.dbk:1187
2129 "No specific indication except: use the appropriate type by referring to the "
2133 # type: Content of: <chapter><section><section><section><title>
2134 #. type: Content of: <chapter><section><section><section><title>
2135 #: best-pkging-practices.dbk:1193
2136 msgid "Description field"
2139 # type: Content of: <chapter><section><section><section><para>
2140 #. type: Content of: <chapter><section><section><section><para>
2141 #: best-pkging-practices.dbk:1195
2143 "Below are specific instructions for properly writing the Description (short "
2144 "and extended) depending on the template type."
2147 # type: Content of: <chapter><section><section><section><section><title>
2148 #. type: Content of: <chapter><section><section><section><section><title>
2149 #: best-pkging-practices.dbk:1199
2150 msgid "String/password templates"
2151 msgstr "String/password テンプレート"
2153 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2154 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2155 #: best-pkging-practices.dbk:1203
2157 "The short description is a prompt and <emphasis role=\"strong\">not</"
2158 "emphasis> a title. Avoid question style prompts (IP Address?) in favour of "
2159 "opened prompts (IP address:). The use of colons is recommended."
2162 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2163 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2164 #: best-pkging-practices.dbk:1210
2166 "The extended description is a complement to the short description. In the "
2167 "extended part, explain what is being asked, rather than ask the same "
2168 "question again using longer words. Use complete sentences. Terse writing "
2169 "style is strongly discouraged."
2172 # type: Content of: <chapter><section><section><section><section><title>
2173 #. type: Content of: <chapter><section><section><section><section><title>
2174 #: best-pkging-practices.dbk:1220
2175 msgid "Boolean templates"
2176 msgstr "Boolean テンプレート"
2178 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2179 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2180 #: best-pkging-practices.dbk:1224
2182 "The short description should be phrased in the form of a question which "
2183 "should be kept short and should generally end with a question mark. Terse "
2184 "writing style is permitted and even encouraged if the question is rather "
2185 "long (remember that translations are often longer than original versions)."
2188 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2189 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2190 #: best-pkging-practices.dbk:1232
2192 "Again, please avoid referring to specific interface widgets. A common "
2193 "mistake for such templates is if you answer Yes-type constructions."
2196 # type: Content of: <chapter><section><section><section><section><title>
2197 #. type: Content of: <chapter><section><section><section><section><title>
2198 #: best-pkging-practices.dbk:1240
2199 msgid "Select/Multiselect"
2200 msgstr "Select/Multiselect"
2202 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2203 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2204 #: best-pkging-practices.dbk:1244
2206 "The short description is a prompt and <emphasis role=\"strong\">not</"
2207 "emphasis> a title. Do <emphasis role=\"strong\">not</emphasis> use useless "
2208 "Please choose... constructions. Users are clever enough to figure out they "
2209 "have to choose something...:)"
2212 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2213 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2214 #: best-pkging-practices.dbk:1252
2216 "The extended description will complete the short description. It may refer "
2217 "to the available choices. It may also mention that the user may choose more "
2218 "than one of the available choices, if the template is a multiselect one "
2219 "(although the interface often makes this clear)."
2222 # type: Content of: <chapter><section><section><section><section><title>
2223 #. type: Content of: <chapter><section><section><section><section><title>
2224 #: best-pkging-practices.dbk:1262
2228 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2229 #: best-pkging-practices.dbk:1266
2231 "The short description should be considered to be a <emphasis role=\"strong"
2232 "\">title</emphasis>."
2235 # type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2236 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2237 #: best-pkging-practices.dbk:1271
2239 "The extended description is what will be displayed as a more detailed "
2240 "explanation of the note. Phrases, no terse writing style."
2243 #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
2244 #: best-pkging-practices.dbk:1277
2246 "<emphasis role=\"strong\">Do not abuse debconf.</emphasis> Notes are the "
2247 "most common way to abuse debconf. As written in debconf-devel manual page: "
2248 "it's best to use them only for warning about very serious problems. The "
2249 "<filename>NEWS.Debian</filename> or <filename>README.Debian</filename> files "
2250 "are the appropriate location for a lot of notes. If, by reading this, you "
2251 "consider converting your Note type templates to entries in <filename>NEWS."
2252 "Debian</filename> or <filename>README.Debian</filename>, plus consider "
2253 "keeping existing translations for the future."
2256 # type: Content of: <chapter><section><section><section><title>
2257 #. type: Content of: <chapter><section><section><section><title>
2258 #: best-pkging-practices.dbk:1292
2259 msgid "Choices field"
2262 # type: Content of: <chapter><section><section><section><para>
2263 #. type: Content of: <chapter><section><section><section><para>
2264 #: best-pkging-practices.dbk:1294
2266 "If the Choices are likely to change often, please consider using the "
2267 "__Choices trick. This will split each individual choice into a single "
2268 "string, which will considerably help translators for doing their work."
2271 # type: Content of: <chapter><section><section><section><title>
2272 #. type: Content of: <chapter><section><section><section><title>
2273 #: best-pkging-practices.dbk:1301 best-pkging-practices.dbk:1339
2274 msgid "Default field"
2277 #. type: Content of: <chapter><section><section><section><para>
2278 #: best-pkging-practices.dbk:1303
2280 "If the default value, for a select template, is likely to vary depending on "
2281 "the user language (for instance, if the choice is a language choice), please "
2282 "use the _Default trick."
2285 #. type: Content of: <chapter><section><section><section><para>
2286 #: best-pkging-practices.dbk:1308
2288 "This special field allow translators to put the most appropriate choice "
2289 "according to their own language. It will become the default choice when "
2290 "their language is used while your own mentioned Default Choice will be used "
2291 "when using English."
2294 # type: Content of: <chapter><section><section><section><para>
2295 #. type: Content of: <chapter><section><section><section><para>
2296 #: best-pkging-practices.dbk:1314
2297 msgid "Example, taken from the geneweb package templates:"
2298 msgstr "geneweb パッケージのテンプレートを例にとってみましょう:"
2300 #. type: Content of: <chapter><section><section><section><screen>
2301 #: best-pkging-practices.dbk:1317
2304 "Template: geneweb/lang\n"
2306 "__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"
2307 "# This is the default choice. Translators may put their own language here\n"
2308 "# instead of the default.\n"
2309 "# WARNING : you MUST use the ENGLISH NAME of your language\n"
2310 "# For instance, the french translator will need to put French (fr) here.\n"
2311 "_Default: English[ translators, please see comment in PO files]\n"
2312 "_Description: Geneweb default language:\n"
2314 "Template: geneweb/lang\n"
2316 "__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"
2317 "# This is the default choice. Translators may put their own language here\n"
2318 "# instead of the default.\n"
2319 "# WARNING : you MUST use the ENGLISH NAME of your language\n"
2320 "# For instance, the french translator will need to put French (fr) here.\n"
2321 "_Default: English[ translators, please see comment in PO files]\n"
2322 "_Description: Geneweb default language:\n"
2324 # type: Content of: <chapter><section><section><section><para>
2325 #. type: Content of: <chapter><section><section><section><para>
2326 #: best-pkging-practices.dbk:1328
2328 "Note the use of brackets which allow internal comments in debconf fields. "
2329 "Also note the use of comments which will show up in files the translators "
2333 #. type: Content of: <chapter><section><section><section><para>
2334 #: best-pkging-practices.dbk:1333
2336 "The comments are needed as the _Default trick is a bit confusing: the "
2337 "translators may put their own choice"
2340 # type: Content of: <chapter><section><section><section><para>
2341 #. type: Content of: <chapter><section><section><section><para>
2342 #: best-pkging-practices.dbk:1341
2344 "Do NOT use empty default field. If you don't want to use default values, do "
2345 "not use Default at all."
2348 #. type: Content of: <chapter><section><section><section><para>
2349 #: best-pkging-practices.dbk:1345
2351 "If you use po-debconf (and you <emphasis role=\"strong\">should</emphasis>, "
2352 "see <xref linkend=\"s6.5.2.2\"/>), consider making this field translatable, "
2353 "if you think it may be translated."
2356 #. type: Content of: <chapter><section><section><section><para>
2357 #: best-pkging-practices.dbk:1350
2359 "If the default value may vary depending on language/country (for instance "
2360 "the default value for a language choice), consider using the special "
2361 "_Default type documented in <citerefentry> <refentrytitle>po-debconf</"
2362 "refentrytitle> <manvolnum>7</manvolnum> </citerefentry>."
2365 # type: Content of: <chapter><section><title>
2366 #. type: Content of: <chapter><section><title>
2367 #: best-pkging-practices.dbk:1362
2368 msgid "Internationalization"
2371 #. type: Content of: <chapter><section><para>
2372 #: best-pkging-practices.dbk:1364
2374 "This section contains global information for developers to make translators' "
2375 "life easier. More information for translators and developers interrested in "
2376 "internationalization are available in the <ulink url=\"&url-i18n-l10n;"
2377 "\">Internationalisation and localisation in Debian</ulink> documentation."
2380 # type: Content of: <chapter><section><section><title>
2381 #. type: Content of: <chapter><section><section><title>
2382 #: best-pkging-practices.dbk:1371
2383 msgid "Handling debconf translations"
2384 msgstr "debconf の翻訳を取り扱う"
2386 # type: Content of: <chapter><section><section><para>
2387 #. type: Content of: <chapter><section><section><para>
2388 #: best-pkging-practices.dbk:1373
2390 "Like porters, translators have a difficult task. They work on many packages "
2391 "and must collaborate with many different maintainers. Moreover, most of the "
2392 "time, they are not native English speakers, so you may need to be "
2393 "particularly patient with them."
2396 # type: Content of: <chapter><section><section><para>
2397 #. type: Content of: <chapter><section><section><para>
2398 #: best-pkging-practices.dbk:1379
2400 "The goal of <systemitem role=\"package\">debconf</systemitem> was to make "
2401 "packages configuration easier for maintainers and for users. Originally, "
2402 "translation of debconf templates was handled with <command>debconf-"
2403 "mergetemplate</command>. However, that technique is now deprecated; the "
2404 "best way to accomplish <systemitem role=\"package\">debconf</systemitem> "
2405 "internationalization is by using the <systemitem role=\"package\">po-"
2406 "debconf</systemitem> package. This method is easier both for maintainer and "
2407 "translators; transition scripts are provided."
2410 #. type: Content of: <chapter><section><section><para>
2411 #: best-pkging-practices.dbk:1389
2413 "Using <systemitem role=\"package\">po-debconf</systemitem>, the translation "
2414 "is stored in <filename>.po</filename> files (drawing from <command>gettext</"
2415 "command> translation techniques). Special template files contain the "
2416 "original messages and mark which fields are translatable. When you change "
2417 "the value of a translatable field, by calling <command>debconf-updatepo</"
2418 "command>, the translation is marked as needing attention from the "
2419 "translators. Then, at build time, the <command>dh_installdebconf</command> "
2420 "program takes care of all the needed magic to add the template along with "
2421 "the up-to-date translations into the binary packages. Refer to the "
2422 "<citerefentry> <refentrytitle>po-debconf</refentrytitle> <manvolnum>7</"
2423 "manvolnum> </citerefentry> manual page for details."
2426 # type: Content of: <chapter><section><section><title>
2427 #. type: Content of: <chapter><section><section><title>
2428 #: best-pkging-practices.dbk:1405
2429 msgid "Internationalized documentation"
2432 # type: Content of: <chapter><section><section><para>
2433 #. type: Content of: <chapter><section><section><para>
2434 #: best-pkging-practices.dbk:1407
2436 "Internationalizing documentation is crucial for users, but a lot of labor. "
2437 "There's no way to eliminate all that work, but you can make things easier "
2441 #. type: Content of: <chapter><section><section><para>
2442 #: best-pkging-practices.dbk:1412
2444 "If you maintain documentation of any size, it is easier for translators if "
2445 "they have access to a source control system. That lets translators see the "
2446 "differences between two versions of the documentation, so, for instance, "
2447 "they can see what needs to be retranslated. It is recommended that the "
2448 "translated documentation maintain a note about what source control revision "
2449 "the translation is based on. An interesting system is provided by <ulink "
2450 "url=\"&url-i18n-doc-check;\">doc-check</ulink> in the <systemitem role="
2451 "\"package\">debian-installer</systemitem> package, which shows an overview "
2452 "of the translation status for any given language, using structured comments "
2453 "for the current revision of the file to be translated and, for a translated "
2454 "file, the revision of the original file the translation is based on. You "
2455 "might wish to adapt and provide that in your VCS area."
2458 # type: Content of: <chapter><section><section><para>
2459 #. type: Content of: <chapter><section><section><para>
2460 #: best-pkging-practices.dbk:1426
2462 "If you maintain XML or SGML documentation, we suggest that you isolate any "
2463 "language-independent information and define those as entities in a separate "
2464 "file which is included by all the different translations. This makes it "
2465 "much easier, for instance, to keep URLs up to date across multiple files."
2468 #. type: Content of: <chapter><section><section><para>
2469 #: best-pkging-practices.dbk:1432
2471 "Some tools (e.g. <systemitem role=\"package\">po4a</systemitem>, <systemitem "
2472 "role=\"package\">poxml</systemitem>, or the <systemitem role=\"package"
2473 "\">translate-toolkit</systemitem>) are specialized in extracting the "
2474 "translatable material from different formats. They produce PO files, a "
2475 "format quite common to translators, which permits to see what needs to be "
2476 "retranslated when the translated document is updated."
2479 # type: Content of: <chapter><section><title>
2480 #. type: Content of: <chapter><section><title>
2481 #: best-pkging-practices.dbk:1444
2482 msgid "Common packaging situations"
2485 # type: Content of: <chapter><section><section><title>
2486 #. type: Content of: <chapter><section><section><title>
2487 #: best-pkging-practices.dbk:1455
2488 msgid "Packages using <command>autoconf</command>/<command>automake</command>"
2490 "<command>autoconf</command>/<command>automake</command> を使っているパッケー"
2493 # type: Content of: <chapter><section><section><para>
2494 #. type: Content of: <chapter><section><section><para>
2495 #: best-pkging-practices.dbk:1457
2497 "Keeping <command>autoconf</command>'s <filename>config.sub</filename> and "
2498 "<filename>config.guess</filename> files up to date is critical for porters, "
2499 "especially on more volatile architectures. Some very good packaging "
2500 "practices for any package using <command>autoconf</command> and/or "
2501 "<command>automake</command> have been synthesized in &file-bpp-autotools; "
2502 "from the <systemitem role=\"package\">autotools-dev</systemitem> package. "
2503 "You're strongly encouraged to read this file and to follow the given "
2507 # type: Content of: <chapter><section><section><title>
2508 #. type: Content of: <chapter><section><section><title>
2509 #: best-pkging-practices.dbk:1469
2513 # type: Content of: <chapter><section><section><para>
2514 #. type: Content of: <chapter><section><section><para>
2515 #: best-pkging-practices.dbk:1471
2517 "Libraries are always difficult to package for various reasons. The policy "
2518 "imposes many constraints to ease their maintenance and to make sure upgrades "
2519 "are as simple as possible when a new upstream version comes out. Breakage "
2520 "in a library can result in dozens of dependent packages breaking."
2523 # type: Content of: <chapter><section><section><para>
2524 #. type: Content of: <chapter><section><section><para>
2525 #: best-pkging-practices.dbk:1477
2527 "Good practices for library packaging have been grouped in <ulink url=\"&url-"
2528 "libpkg-guide;\">the library packaging guide</ulink>."
2531 # type: Content of: <chapter><section><section><title>
2532 #. type: Content of: <chapter><section><section><title>
2533 #: best-pkging-practices.dbk:1484
2534 msgid "Documentation"
2537 # type: Content of: <chapter><section><section><para>
2538 #. type: Content of: <chapter><section><section><para>
2539 #: best-pkging-practices.dbk:1486
2541 "Be sure to follow the <ulink url=\"&url-debian-policy;ch-docs.html\">Policy "
2542 "on documentation</ulink>."
2545 # type: Content of: <chapter><section><section><para>
2546 #. type: Content of: <chapter><section><section><para>
2547 #: best-pkging-practices.dbk:1491
2549 "If your package contains documentation built from XML or SGML, we recommend "
2550 "you not ship the XML or SGML source in the binary package(s). If users want "
2551 "the source of the documentation, they should retrieve the source package."
2554 # type: Content of: <chapter><section><section><para>
2555 #. type: Content of: <chapter><section><section><para>
2556 #: best-pkging-practices.dbk:1496
2558 "Policy specifies that documentation should be shipped in HTML format. We "
2559 "also recommend shipping documentation in PDF and plain text format if "
2560 "convenient and if output of reasonable quality is possible. However, it is "
2561 "generally not appropriate to ship plain text versions of documentation whose "
2562 "source format is HTML."
2565 # type: Content of: <chapter><section><section><para>
2566 #. type: Content of: <chapter><section><section><para>
2567 #: best-pkging-practices.dbk:1503
2569 "Major shipped manuals should register themselves with <systemitem role="
2570 "\"package\">doc-base</systemitem> on installation. See the <systemitem role="
2571 "\"package\">doc-base</systemitem> package documentation for more information."
2574 #. type: Content of: <chapter><section><section><para>
2575 #: best-pkging-practices.dbk:1509
2577 "Debian policy (section 12.1) directs that manual pages should accompany "
2578 "every program, utility, and function, and suggests them for other objects "
2579 "like configuration files. If the work you are packaging does not have such "
2580 "manual pages, consider writing them for inclusion in your package, and "
2581 "submitting them upstream."
2584 #. type: Content of: <chapter><section><section><para>
2585 #: best-pkging-practices.dbk:1516
2587 "The manpages do not need to be written directly in the troff format. "
2588 "Popular source formats are Docbook, POD and reST, which can be converted "
2589 "using <command>xsltproc</command>, <command>pod2man</command> and "
2590 "<command>rst2man</command> respectively. To a lesser extent, the "
2591 "<command>help2man</command> program can also be used to write a stub."
2594 # type: Content of: <chapter><section><section><title>
2595 #. type: Content of: <chapter><section><section><title>
2596 #: best-pkging-practices.dbk:1525
2597 msgid "Specific types of packages"
2600 # type: Content of: <chapter><section><section><para>
2601 #. type: Content of: <chapter><section><section><para>
2602 #: best-pkging-practices.dbk:1527
2604 "Several specific types of packages have special sub-policies and "
2605 "corresponding packaging rules and practices:"
2608 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2609 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2610 #: best-pkging-practices.dbk:1533
2612 "Perl related packages have a <ulink url=\"&url-perl-policy;\">Perl policy</"
2613 "ulink>, some examples of packages following that policy are <systemitem role="
2614 "\"package\">libdbd-pg-perl</systemitem> (binary perl module) or <systemitem "
2615 "role=\"package\">libmldbm-perl</systemitem> (arch independent perl module)."
2618 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2619 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2620 #: best-pkging-practices.dbk:1542
2622 "Python related packages have their python policy; see &file-python-policy; "
2623 "in the <systemitem role=\"package\">python</systemitem> package."
2626 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2627 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2628 #: best-pkging-practices.dbk:1549
2630 "Emacs related packages have the <ulink url=\"&url-emacs-policy;\">emacs "
2634 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2635 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2636 #: best-pkging-practices.dbk:1556
2638 "Java related packages have their <ulink url=\"&url-java-policy;\">java "
2642 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2643 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2644 #: best-pkging-practices.dbk:1563
2646 "Ocaml related packages have their own policy, found in &file-ocaml-policy; "
2647 "from the <systemitem role=\"package\">ocaml</systemitem> package. A good "
2648 "example is the <systemitem role=\"package\">camlzip</systemitem> source "
2652 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2653 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2654 #: best-pkging-practices.dbk:1571
2656 "Packages providing XML or SGML DTDs should conform to the recommendations "
2657 "found in the <systemitem role=\"package\">sgml-base-doc</systemitem> package."
2660 # type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2661 #. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
2662 #: best-pkging-practices.dbk:1577
2664 "Lisp packages should register themselves with <systemitem role=\"package"
2665 "\">common-lisp-controller</systemitem>, about which see &file-lisp-"
2669 # type: Content of: <chapter><section><section><title>
2670 #. type: Content of: <chapter><section><section><title>
2671 #: best-pkging-practices.dbk:1607
2672 msgid "Architecture-independent data"
2673 msgstr "アーキテクチャ非依存のデータ"
2675 # type: Content of: <chapter><section><section><para>
2676 #. type: Content of: <chapter><section><section><para>
2677 #: best-pkging-practices.dbk:1609
2679 "It is not uncommon to have a large amount of architecture-independent data "
2680 "packaged with a program. For example, audio files, a collection of icons, "
2681 "wallpaper patterns, or other graphic files. If the size of this data is "
2682 "negligible compared to the size of the rest of the package, it's probably "
2683 "best to keep it all in a single package."
2686 #. type: Content of: <chapter><section><section><para>
2687 #: best-pkging-practices.dbk:1616
2689 "However, if the size of the data is considerable, consider splitting it out "
2690 "into a separate, architecture-independent package (<filename>_all.deb</"
2691 "filename>). By doing this, you avoid needless duplication of the same data "
2692 "into eleven or more .debs, one per each architecture. While this adds some "
2693 "extra overhead into the <filename>Packages</filename> files, it saves a lot "
2694 "of disk space on Debian mirrors. Separating out architecture-independent "
2695 "data also reduces processing time of <command>lintian</command> (see <xref "
2696 "linkend=\"tools-lint\"/>) when run over the entire Debian archive."
2699 # type: Content of: <chapter><section><section><title>
2700 #. type: Content of: <chapter><section><section><title>
2701 #: best-pkging-practices.dbk:1628
2702 msgid "Needing a certain locale during build"
2705 # type: Content of: <chapter><section><section><para>
2706 #. type: Content of: <chapter><section><section><para>
2707 #: best-pkging-practices.dbk:1630
2709 "If you need a certain locale during build, you can create a temporary file "
2713 # type: Content of: <chapter><section><section><para>
2714 #. type: Content of: <chapter><section><section><para>
2715 #: best-pkging-practices.dbk:1634
2717 "If you set <varname>LOCPATH</varname> to the equivalent of <filename>/usr/"
2718 "lib/locale</filename>, and <varname>LC_ALL</varname> to the name of the "
2719 "locale you generate, you should get what you want without being root. "
2720 "Something like this:"
2723 # type: Content of: <chapter><section><section><screen>
2724 #. type: Content of: <chapter><section><section><screen>
2725 #: best-pkging-practices.dbk:1639
2728 "LOCALE_PATH=debian/tmpdir/usr/lib/locale\n"
2729 "LOCALE_NAME=en_IN\n"
2730 "LOCALE_CHARSET=UTF-8\n"
2732 "mkdir -p $LOCALE_PATH\n"
2733 "localedef -i $LOCALE_NAME.$LOCALE_CHARSET -f $LOCALE_CHARSET $LOCALE_PATH/$LOCALE_NAME.$LOCALE_CHARSET\n"
2735 "# Using the locale\n"
2736 "LOCPATH=$LOCALE_PATH LC_ALL=$LOCALE_NAME.$LOCALE_CHARSET date\n"
2738 "LOCALE_PATH=debian/tmpdir/usr/lib/locale\n"
2739 "LOCALE_NAME=en_IN\n"
2740 "LOCALE_CHARSET=UTF-8\n"
2742 "mkdir -p $LOCALE_PATH\n"
2743 "localedef -i $LOCALE_NAME.$LOCALE_CHARSET -f $LOCALE_CHARSET $LOCALE_PATH/$LOCALE_NAME.$LOCALE_CHARSET\n"
2746 "LOCPATH=$LOCALE_PATH LC_ALL=$LOCALE_NAME.$LOCALE_CHARSET date\n"
2748 # type: Content of: <chapter><section><section><title>
2749 #. type: Content of: <chapter><section><section><title>
2750 #: best-pkging-practices.dbk:1652
2751 msgid "Make transition packages deborphan compliant"
2754 # type: Content of: <chapter><section><section><para>
2755 #. type: Content of: <chapter><section><section><para>
2756 #: best-pkging-practices.dbk:1654
2758 "Deborphan is a program for helping users to detect which packages can safely "
2759 "be removed from the system, i.e. the ones that have no packages depending "
2760 "on them. The default operation is to search only within the libs and "
2761 "oldlibs sections, to hunt down unused libraries. But when passed the right "
2762 "argument, it tries to catch other useless packages."
2765 # type: Content of: <chapter><section><section><para>
2766 #. type: Content of: <chapter><section><section><para>
2767 #: best-pkging-practices.dbk:1661
2769 "For example, with <literal>--guess-dummy</literal>, <command>deborphan</"
2770 "command> tries to search all transitional packages which were needed for "
2771 "upgrade but which can now safely be removed. For that, it looks for the "
2772 "string dummy or transitional in their short description."
2775 # type: Content of: <chapter><section><section><para>
2776 #. type: Content of: <chapter><section><section><para>
2777 #: best-pkging-practices.dbk:1668
2779 "So, when you are creating such a package, please make sure to add this text "
2780 "to your short description. If you are looking for examples, just run: "
2781 "<command>apt-cache search .|grep dummy</command> or <command>apt-cache "
2782 "search .|grep transitional</command>."
2785 #. type: Content of: <chapter><section><section><para>
2786 #: best-pkging-practices.dbk:1674
2788 "Also, it is recommended to adjust its section to <literal>oldlibs</literal> "
2789 "and its priority to <literal>extra</literal> in order to ease "
2790 "<command>deborphan</command>'s job."
2793 # type: Content of: <chapter><section><title>
2794 #. type: Content of: <chapter><section><section><title>
2795 #: best-pkging-practices.dbk:1683
2798 #| "Best practices for <filename>.orig.tar.{gz,bz2,lzma}</filename> files"
2799 msgid "Best practices for <filename>.orig.tar.{gz,bz2,xz}</filename> files"
2801 "<filename>.orig.tar.{gz,bz2,lzma}</filename> についてのベストプラクティス"
2803 # type: Content of: <chapter><section><section><para>
2804 #. type: Content of: <chapter><section><section><para>
2805 #: best-pkging-practices.dbk:1685
2807 "There are two kinds of original source tarballs: Pristine source and "
2808 "repackaged upstream source."
2811 # type: Content of: <chapter><section><section><section><title>
2812 #. type: Content of: <chapter><section><section><section><title>
2813 #: best-pkging-practices.dbk:1689
2814 msgid "Pristine source"
2817 #. type: Content of: <chapter><section><section><section><para><footnote><para>
2818 #: best-pkging-practices.dbk:1693
2820 "We cannot prevent upstream authors from changing the tarball they distribute "
2821 "without also incrementing the version number, so there can be no guarantee "
2822 "that a pristine tarball is identical to what upstream <emphasis>currently</"
2823 "emphasis> distributing at any point in time. All that can be expected is "
2824 "that it is identical to something that upstream once <emphasis>did</"
2825 "emphasis> distribute. If a difference arises later (say, if upstream "
2826 "notices that he wasn't using maximal compression in his original "
2827 "distribution and then re-<command>gzip</command>s it), that's just too bad. "
2828 "Since there is no good way to upload a new <filename>.orig.tar.{gz,bz2,xz}</"
2829 "filename> for the same version, there is not even any point in treating this "
2830 "situation as a bug."
2833 #. type: Content of: <chapter><section><section><section><para>
2834 #: best-pkging-practices.dbk:1691
2836 "The defining characteristic of a pristine source tarball is that the "
2837 "<filename>.orig.tar.{gz,bz2,xz}</filename> file is byte-for-byte identical "
2838 "to a tarball officially distributed by the upstream author.<placeholder type="
2839 "\"footnote\" id=\"0\"/> This makes it possible to use checksums to easily "
2840 "verify that all changes between Debian's version and upstream's are "
2841 "contained in the Debian diff. Also, if the original source is huge, "
2842 "upstream authors and others who already have the upstream tarball can save "
2843 "download time if they want to inspect your packaging in detail."
2846 # type: Content of: <chapter><section><section><section><para>
2847 #. type: Content of: <chapter><section><section><section><para>
2848 #: best-pkging-practices.dbk:1711
2850 "There is no universally accepted guidelines that upstream authors follow "
2851 "regarding to the directory structure inside their tarball, but <command>dpkg-"
2852 "source</command> is nevertheless able to deal with most upstream tarballs as "
2853 "pristine source. Its strategy is equivalent to the following:"
2856 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2857 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2858 #: best-pkging-practices.dbk:1719
2859 msgid "It unpacks the tarball in an empty temporary directory by doing"
2862 # type: Content of: <chapter><section><section><section><orderedlist><listitem><screen>
2863 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><screen>
2864 #: best-pkging-practices.dbk:1722
2866 msgid "zcat path/to/<replaceable>packagename</replaceable>_<replaceable>upstream-version</replaceable>.orig.tar.gz | tar xf -\n"
2867 msgstr "zcat path/to/<replaceable>パッケージ名</replaceable>_<replaceable>upstream-version</replaceable>.orig.tar.gz | tar xf -\n"
2869 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2870 #: best-pkging-practices.dbk:1727
2872 "If, after this, the temporary directory contains nothing but one directory "
2873 "and no other files, <command>dpkg-source</command> renames that directory to "
2874 "<filename><replaceable>packagename</replaceable>-<replaceable>upstream-"
2875 "version</replaceable>(.orig)</filename>. The name of the top-level "
2876 "directory in the tarball does not matter, and is forgotten."
2879 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2880 #: best-pkging-practices.dbk:1736
2882 "Otherwise, the upstream tarball must have been packaged without a common top-"
2883 "level directory (shame on the upstream author!). In this case, "
2884 "<command>dpkg-source</command> renames the temporary directory "
2885 "<emphasis>itself</emphasis> to <filename><replaceable>packagename</"
2886 "replaceable>-<replaceable>upstream-version</replaceable>(.orig)</filename>."
2889 # type: Content of: <chapter><section><section><section><title>
2890 #. type: Content of: <chapter><section><section><section><title>
2891 #: best-pkging-practices.dbk:1747
2892 msgid "Repackaged upstream source"
2893 msgstr "upstream のソースをパッケージしなおす"
2895 # type: Content of: <chapter><section><section><section><para>
2896 #. type: Content of: <chapter><section><section><section><para>
2897 #: best-pkging-practices.dbk:1749
2899 "You <emphasis role=\"strong\">should</emphasis> upload packages with a "
2900 "pristine source tarball if possible, but there are various reasons why it "
2901 "might not be possible. This is the case if upstream does not distribute the "
2902 "source as gzipped tar at all, or if upstream's tarball contains non-DFSG-"
2903 "free material that you must remove before uploading."
2906 #. type: Content of: <chapter><section><section><section><para>
2907 #: best-pkging-practices.dbk:1756
2909 "In these cases the developer must construct a suitable <filename>.orig.tar."
2910 "{gz,bz2,xz}</filename> file himself. We refer to such a tarball as a "
2911 "repackaged upstream source. Note that a repackaged upstream source is "
2912 "different from a Debian-native package. A repackaged source still comes "
2913 "with Debian-specific changes in a separate <filename>.diff.gz</filename> or "
2914 "<filename>.debian.tar.{gz,bz2,xz}</filename> and still has a version number "
2915 "composed of <replaceable>upstream-version</replaceable> and "
2916 "<replaceable>debian-version</replaceable>."
2919 #. type: Content of: <chapter><section><section><section><para>
2920 #: best-pkging-practices.dbk:1765
2922 "There may be cases where it is desirable to repackage the source even though "
2923 "upstream distributes a <filename>.tar.{gz,bz2,xz}</filename> that could in "
2924 "principle be used in its pristine form. The most obvious is if "
2925 "<emphasis>significant</emphasis> space savings can be achieved by "
2926 "recompressing the tar archive or by removing genuinely useless cruft from "
2927 "the upstream archive. Use your own discretion here, but be prepared to "
2928 "defend your decision if you repackage source that could have been pristine."
2931 # type: Content of: <chapter><section><title>
2932 #. type: Content of: <chapter><section><section><section><para>
2933 #: best-pkging-practices.dbk:1774
2936 #| "Best practices for <filename>.orig.tar.{gz,bz2,lzma}</filename> files"
2937 msgid "A repackaged <filename>.orig.tar.{gz,bz2,xz}</filename>"
2939 "<filename>.orig.tar.{gz,bz2,lzma}</filename> についてのベストプラクティス"
2941 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2942 #: best-pkging-practices.dbk:1779
2944 "<emphasis role=\"strong\">should</emphasis> be documented in the resulting "
2945 "source package. Detailed information on how the repackaged source was "
2946 "obtained, and on how this can be reproduced should be provided in "
2947 "<filename>debian/copyright</filename>. It is also a good idea to provide a "
2948 "<literal>get-orig-source</literal> target in your <filename>debian/rules</"
2949 "filename> file that repeats the process, as described in the Policy Manual, "
2950 "<ulink url=\"&url-debian-policy;ch-source.html#s-debianrules\">Main building "
2951 "script: <filename>debian/rules</filename></ulink>."
2954 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para><footnote><para>
2955 #: best-pkging-practices.dbk:1794
2957 "As a special exception, if the omission of non-free files would lead to the "
2958 "source failing to build without assistance from the Debian diff, it might be "
2959 "appropriate to instead edit the files, omitting only the non-free parts of "
2960 "them, and/or explain the situation in a <filename>README.source</filename> "
2961 "file in the root of the source tree. But in that case please also urge the "
2962 "upstream author to make the non-free components easier separable from the "
2963 "rest of the source."
2966 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2967 #: best-pkging-practices.dbk:1792
2969 "<emphasis role=\"strong\">should not</emphasis> contain any file that does "
2970 "not come from the upstream author(s), or whose contents has been changed by "
2971 "you.<placeholder type=\"footnote\" id=\"0\"/>"
2974 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2975 #: best-pkging-practices.dbk:1805
2977 "<emphasis role=\"strong\">should</emphasis>, except where impossible for "
2978 "legal reasons, preserve the entire building and portablility infrastructure "
2979 "provided by the upstream author. For example, it is not a sufficient reason "
2980 "for omitting a file that it is used only when building on MS-DOS. "
2981 "Similarly, a <filename>Makefile</filename> provided by upstream should not "
2982 "be omitted even if the first thing your <filename>debian/rules</filename> "
2983 "does is to overwrite it by running a configure script."
2986 # type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2987 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2988 #: best-pkging-practices.dbk:1814
2990 "(<emphasis>Rationale:</emphasis> It is common for Debian users who need to "
2991 "build software for non-Debian platforms to fetch the source from a Debian "
2992 "mirror rather than trying to locate a canonical upstream distribution point)."
2995 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
2996 #: best-pkging-practices.dbk:1821
2998 "<emphasis role=\"strong\">should</emphasis> use "
2999 "<filename><replaceable>packagename</replaceable>-<replaceable>upstream-"
3000 "version</replaceable>.orig</filename> as the name of the top-level directory "
3001 "in its tarball. This makes it possible to distinguish pristine tarballs "
3002 "from repackaged ones."
3005 #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
3006 #: best-pkging-practices.dbk:1829
3008 "<emphasis role=\"strong\">should</emphasis> be gzipped or bzipped with "
3009 "maximal compression."
3012 #. type: Content of: <chapter><section><section><section><title>
3013 #: best-pkging-practices.dbk:1836
3014 msgid "Changing binary files"
3017 #. type: Content of: <chapter><section><section><section><para>
3018 #: best-pkging-practices.dbk:1838
3020 "Sometimes it is necessary to change binary files contained in the original "
3021 "tarball, or to add binary files that are not in it. This is fully supported "
3022 "when using source packages in “3.0 (quilt)” format, see the "
3023 "<citerefentry><refentrytitle>dpkg-source</refentrytitle><manvolnum>1</"
3024 "manvolnum></citerefentry> manual page for details. When using the older "
3025 "format “1.0”, binary files can't be stored in the <filename>.diff.gz</"
3026 "filename> so you must store an <command>uuencode</command>d (or similar) "
3027 "version of the file(s) and decode it at build time in <filename>debian/"
3028 "rules</filename> (and move it in its official location)."
3031 # type: Content of: <chapter><section><section><title>
3032 #. type: Content of: <chapter><section><section><title>
3033 #: best-pkging-practices.dbk:1853
3034 msgid "Best practices for debug packages"
3037 #. type: Content of: <chapter><section><section><para>
3038 #: best-pkging-practices.dbk:1855
3040 "A debug package is a package with a name ending in -dbg, that contains "
3041 "additional information that <command>gdb</command> can use. Since Debian "
3042 "binaries are stripped by default, debugging information, including function "
3043 "names and line numbers, is otherwise not available when running "
3044 "<command>gdb</command> on Debian binaries. Debug packages allow users who "
3045 "need this additional debugging information to install it, without bloating a "
3046 "regular system with the information."
3049 # type: Content of: <chapter><section><section><para>
3050 #. type: Content of: <chapter><section><section><para>
3051 #: best-pkging-practices.dbk:1863
3053 "It is up to a package's maintainer whether to create a debug package or "
3054 "not. Maintainers are encouraged to create debug packages for library "
3055 "packages, since this can aid in debugging many programs linked to a "
3056 "library. In general, debug packages do not need to be added for all "
3057 "programs; doing so would bloat the archive. But if a maintainer finds that "
3058 "users often need a debugging version of a program, it can be worthwhile to "
3059 "make a debug package for it. Programs that are core infrastructure, such as "
3060 "apache and the X server are also good candidates for debug packages."
3063 #. type: Content of: <chapter><section><section><para>
3064 #: best-pkging-practices.dbk:1873
3066 "Some debug packages may contain an entire special debugging build of a "
3067 "library or other binary, but most of them can save space and build time by "
3068 "instead containing separated debugging symbols that <command>gdb</command> "
3069 "can find and load on the fly when debugging a program or library. The "
3070 "convention in Debian is to keep these symbols in <filename>/usr/lib/debug/"
3071 "<replaceable>path</replaceable></filename>, where <replaceable>path</"
3072 "replaceable> is the path to the executable or library. For example, "
3073 "debugging symbols for <filename>/usr/bin/foo</filename> go in <filename>/usr/"
3074 "lib/debug/usr/bin/foo</filename>, and debugging symbols for <filename>/usr/"
3075 "lib/libfoo.so.1</filename> go in <filename>/usr/lib/debug/usr/lib/libfoo."
3079 #. type: Content of: <chapter><section><section><para>
3080 #: best-pkging-practices.dbk:1885
3082 "The debugging symbols can be extracted from an object file using "
3083 "<command>objcopy --only-keep-debug</command>. Then the object file can be "
3084 "stripped, and <command>objcopy --add-gnu-debuglink</command> used to specify "
3085 "the path to the debugging symbol file. <citerefentry> "
3086 "<refentrytitle>objcopy</refentrytitle> <manvolnum>1</manvolnum> </"
3087 "citerefentry> explains in detail how this works."
3090 #. type: Content of: <chapter><section><section><para>
3091 #: best-pkging-practices.dbk:1893
3093 "The <command>dh_strip</command> command in <systemitem role=\"package"
3094 "\">debhelper</systemitem> supports creating debug packages, and can take "
3095 "care of using <command>objcopy</command> to separate out the debugging "
3096 "symbols for you. If your package uses <systemitem role=\"package"
3097 "\">debhelper</systemitem>, all you need to do is call <command>dh_strip --"
3098 "dbg-package=libfoo-dbg</command>, and add an entry to <filename>debian/"
3099 "control</filename> for the debug package."
3102 #. type: Content of: <chapter><section><section><para>
3103 #: best-pkging-practices.dbk:1900
3105 "Note that the debug package should depend on the package that it provides "
3106 "debugging symbols for, and this dependency should be versioned. For example:"
3109 # type: Content of: <chapter><section><section><screen>
3110 #. type: Content of: <chapter><section><section><screen>
3111 #: best-pkging-practices.dbk:1904
3113 msgid "Depends: libfoo (= ${binary:Version})\n"
3114 msgstr "Depends: libfoo (= ${binary:Version})\n"
3116 # type: Content of: <chapter><section><title>
3117 #. type: Content of: <chapter><section><section><title>
3118 #: best-pkging-practices.dbk:1908
3120 #| msgid "Best practices for maintainer scripts"
3121 msgid "Best practices for meta-packages"
3122 msgstr "メンテナスクリプトのベストプラクティス"
3124 #. type: Content of: <chapter><section><section><para>
3125 #: best-pkging-practices.dbk:1910
3127 "A meta-package is a mostly empty package that makes it easy to install a "
3128 "coherent set of packages that can evolve over time. It achieves this by "
3129 "depending on all the packages of the set. Thanks to the power of APT, the "
3130 "meta-package maintainer can adjust the dependencies and the user's system "
3131 "will automatically get the supplementary packages. The dropped packages that "
3132 "were automatically installed will be also be marked as removal candidates "
3133 "(and are even automatically removed by <command>aptitude</command>). "
3134 "<systemitem role=\"package\">gnome</systemitem> and <systemitem role="
3135 "\"package\">linux-image-amd64</systemitem> are two examples of meta-packages "
3136 "(built by the source packages <systemitem role=\"package\">meta-gnome2</"
3137 "systemitem> and <systemitem role=\"package\">linux-latest</systemitem>)."
3140 #. type: Content of: <chapter><section><section><para>
3141 #: best-pkging-practices.dbk:1924
3143 "The long description of the meta-package must clearly document its purpose "
3144 "so that the user knows what he will lose if he removes the package. Being "
3145 "explicit about the consequences is recommended. This is particularly "
3146 "important for meta-packages which are installed during initial installation "
3147 "and that have not been explicitly installed by the user. Those tend to be "
3148 "important to ensure smooth system upgrades and the user should be "
3149 "discouraged from uninstalling them to avoid potential breakages."