HOWTO: sync Japanese HOWTO
[linux-2.6.git] / Documentation / ja_JP / HOWTO
1 \177377NOTE:
2 This is a version of Documentation/HOWTO translated into Japanese.
3 This document is maintained by Tsugikazu Shibata <tshibata@ab.jp.nec.com>
4 and the JF Project team <www.linux.or.jp/JF>.
5 If you find any difference between this document and the original file
6 or a problem with the translation,
7 please contact the maintainer of this file or JF project.
8
9 Please also note that the purpose of this file is to be easier to read
10 for non English (read: Japanese) speakers and is not intended as a
11 fork. So if you have any comments or updates for this file, please try
12 to update the original English file first.
13
14 Last Updated: 2007/07/18
15 ==================================
16 これは、
17 linux-2.6.22/Documentation/HOWTO
18 の和訳です。
19
20 翻訳団体: JF プロジェクト < http://www.linux.or.jp/JF/ >
21 翻訳日: 2007/07/16
22 翻訳者: Tsugikazu Shibata <tshibata at ab dot jp dot nec dot com>
23 校正者: 松倉さん <nbh--mats at nifty dot com>
24          小林 雅典さん (Masanori Kobayasi) <zap03216 at nifty dot ne dot jp>
25          武井伸光さん、<takei at webmasters dot gr dot jp>
26          かねこさん (Seiji Kaneko) <skaneko at a2 dot mbn dot or dot jp>
27          野口さん (Kenji Noguchi) <tokyo246 at gmail dot com>
28          河内さん (Takayoshi Kochi) <t-kochi at bq dot jp dot nec dot com>
29          岩本さん (iwamoto) <iwamoto.kn at ncos dot nec dot co dot jp>
30 ==================================
31
32 Linux カーネル開発のやり方
33 -------------------------------
34
35 これは上のトピック( Linux カーネル開発のやり方)の重要な事柄を網羅した
36 ドキュメントです。ここには Linux カーネル開発者になるための方法と
37 Linux カーネル開発コミュニティと共に活動するやり方を学ぶ方法が含まれて
38 います。カーネルプログラミングに関する技術的な項目に関することは何も含
39 めないようにしていますが、カーネル開発者となるための正しい方向に向かう
40 手助けになります。
41
42 もし、このドキュメントのどこかが古くなっていた場合には、このドキュメン
43 トの最後にリストしたメンテナーにパッチを送ってください。
44
45 はじめに
46 ---------
47
48 あなたは Linux カーネルの開発者になる方法を学びたいのでしょうか? そ
49 れともあなたは上司から「このデバイスの Linux ドライバを書くように」と
50 言われているのでしょうか? 
51 この文書の目的は、あなたが踏むべき手順と、コミュニティと一緒にうまく働
52 くヒントを書き下すことで、あなたが知るべき全てのことを教えることです。
53 また、このコミュニティがなぜ今うまくまわっているのかという理由の一部も
54 説明しようと試みています。
55
56
57 カーネルは 少量のアーキテクチャ依存部分がアセンブリ言語で書かれている
58 以外は大部分は C 言語で書かれています。C言語をよく理解していることはカー
59 ネル開発者には必要です。アーキテクチャ向けの低レベル部分の開発をするの
60 でなければ、(どんなアーキテクチャでも)アセンブリ(訳注: 言語)は必要あり
61 ません。以下の本は、C 言語の十分な知識や何年もの経験に取って代わるもの
62 ではありませんが、少なくともリファレンスとしてはいい本です。
63  - "The C Programming Language" by Kernighan and Ritchie [Prentice Hall]
64  -『プログラミング言語C第2版』(B.W. カーニハン/D.M. リッチー著 石田晴久訳) [共立出版]
65  - "Practical C Programming" by Steve Oualline [O'Reilly]
66  - 『C実践プログラミング第3版』(Steve Oualline著 望月康司監訳 谷口功訳) [オライリージャパン]
67  - "C:  A Reference Manual" by Harbison and Steele [Prentice Hall]
68  - 『新・詳説 C 言語 H&S リファレンス』
69        (サミュエル P ハービソン/ガイ L スティール共著 斉藤 信男監訳)[ソフトバンク]
70
71 カーネルは GNU C と GNU ツールチェインを使って書かれています。カーネル
72 は ISO C89 仕様に準拠して書く一方で、標準には無い言語拡張を多く使って
73 います。カーネルは標準 C ライブラリとは関係がないといった、C 言語フリー
74 スタンディング環境です。そのため、C の標準で使えないものもあります。任
75 意の long long の除算や浮動小数点は使えません。
76 ときどき、カーネルがツールチェインや C 言語拡張に置いている前提がどう
77 なっているのかわかりにくいことがあり、また、残念なことに決定的なリファ
78 レンスは存在しません。情報を得るには、gcc の info ページ( info gcc )を
79 みてください。
80
81 あなたは既存の開発コミュニティと一緒に作業する方法を学ぼうとしているこ
82 とに留意してください。そのコミュニティは、コーディング、スタイル、
83 開発手順について高度な標準を持つ、多様な人の集まりです。
84 地理的に分散した大規模なチームに対してもっともうまくいくとわかったこと
85 をベースにしながら、これらの標準は長い時間をかけて築かれてきました。
86 これらはきちんと文書化されていますから、事前にこれらの標準についてでき
87 るだけたくさん学んでください。また皆があなたやあなたの会社のやり方に合わ
88 せてくれると思わないでください。
89
90 法的問題
91 ------------
92
93 Linux カーネルのソースコードは GPL ライセンスの下でリリースされていま
94 す。ライセンスの詳細については、ソースツリーのメインディレクトリに存在
95 する、COPYING のファイルをみてください。もしライセンスについてさらに質
96 問があれば、Linux Kernel メーリングリストに質問するのではなく、どうぞ
97 法律家に相談してください。メーリングリストの人達は法律家ではなく、法的
98 問題については彼らの声明はあてにするべきではありません。
99
100 GPL に関する共通の質問や回答については、以下を参照してください。
101         http://www.gnu.org/licenses/gpl-faq.html
102
103 ドキュメント
104 ------------
105
106 Linux カーネルソースツリーは幅広い範囲のドキュメントを含んでおり、それ
107 らはカーネルコミュニティと会話する方法を学ぶのに非常に貴重なものです。
108 新しい機能がカーネルに追加される場合、その機能の使い方について説明した
109 新しいドキュメントファイルも追加することを勧めます。
110 カーネルの変更が、カーネルがユーザ空間に公開しているインターフェイスの
111 変更を引き起こす場合、その変更を説明するマニュアルページのパッチや情報
112 をマニュアルページのメンテナ mtk-manpages@gmx.net に送ることを勧めます。
113
114 以下はカーネルソースツリーに含まれている読んでおくべきファイルの一覧で
115 す-
116
117   README
118     このファイルは Linuxカーネルの簡単な背景とカーネルを設定(訳注
119     configure )し、生成(訳注 build )するために必要なことは何かが書かれ
120     ています。カーネルに関して初めての人はここからスタートするとよいで
121     しょう。
122
123   Documentation/Changes
124      このファイルはカーネルをうまく生成(訳注 build )し、走らせるのに最
125      小限のレベルで必要な数々のソフトウェアパッケージの一覧を示してい
126      ます。
127
128   Documentation/CodingStyle
129     これは Linux カーネルのコーディングスタイルと背景にある理由を記述
130     しています。全ての新しいコードはこのドキュメントにあるガイドライン
131     に従っていることを期待されています。大部分のメンテナーはこれらのルー
132     ルに従っているものだけを受け付け、多くの人は正しいスタイルのコード
133     だけをレビューします。
134
135   Documentation/SubmittingPatches
136   Documentation/SubmittingDrivers
137      これらのファイルには、どうやってうまくパッチを作って投稿するかに
138      ついて非常に詳しく書かれており、以下を含みます(これだけに限らない
139      けれども)
140         - Email に含むこと
141         - Email の形式
142         - だれに送るか
143      これらのルールに従えばうまくいくことを保証することではありません
144      が (すべてのパッチは内容とスタイルについて精査を受けるので)、
145      ルールに従わなければ間違いなくうまくいかないでしょう。
146
147      この他にパッチを作る方法についてのよくできた記述は-
148
149         "The Perfect Patch"
150                 http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt
151         "Linux kernel patch submission format"
152                 http://linux.yyz.us/patch-format.html
153
154   Documentation/stable_api_nonsense.txt
155      このファイルはカーネルの中に不変のAPIを持たないことにした意識的な
156      決断の背景にある理由について書かれています。以下のようなことを含
157      んでいます-
158        - サブシステムとの間に層を作ること(コンパチビリティのため?)
159        - オペレーティングシステム間のドライバの移植性
160        - カーネルソースツリーの素早い変更を遅らせる(もしくは素早い変更
161          を妨げる)
162      このドキュメントは Linux 開発の思想を理解するのに非常に重要です。
163      そして、他のOSでの開発者が Linux に移る時にとても重要です。
164
165   Documentation/SecurityBugs
166     もし Linux カーネルでセキュリティ問題を発見したように思ったら、こ
167     のドキュメントのステップに従ってカーネル開発者に連絡し、問題解決を
168     支援してください。
169
170   Documentation/ManagementStyle
171     このドキュメントは Linux カーネルのメンテナー達がどう行動するか、
172     彼らの手法の背景にある共有されている精神について記述しています。こ
173     れはカーネル開発の初心者なら(もしくは、単に興味があるだけの人でも)
174     重要です。なぜならこのドキュメントは、カーネルメンテナー達の独特な
175     行動についての多くの誤解や混乱を解消するからです。
176
177   Documentation/stable_kernel_rules.txt
178     このファイルはどのように stable カーネルのリリースが行われるかのルー
179     ルが記述されています。そしてこれらのリリースの中のどこかで変更を取
180     り入れてもらいたい場合に何をすればいいかが示されています。
181
182   Documentation/kernel-docs.txt
183   カーネル開発に付随する外部ドキュメントのリストです。もしあなたが
184     探しているものがカーネル内のドキュメントでみつからなかった場合、
185     このリストをあたってみてください。
186
187   Documentation/applying-patches.txt
188     パッチとはなにか、パッチをどうやって様々なカーネルの開発ブランチに
189     適用するのかについて正確に記述した良い入門書です。
190
191 カーネルはソースコードから自動的に生成可能な多数のドキュメントを自分自
192 身でもっています。これにはカーネル内 API のすべての記述や、どう正しく
193 ロックをかけるかの規則が含まれます。このドキュメントは
194 Documentation/DocBook/ ディレクトリに作られ、以下のように
195         make pdfdocs
196         make psdocs
197         make htmldocs
198         make mandocs
199 コマンドを実行するとメインカーネルのソースディレクトリから
200 それぞれ、PDF, Postscript, HTML, man page の形式で生成されます。
201
202 カーネル開発者になるには
203 ---------------------------
204
205 もしあなたが、Linux カーネル開発について何も知らないならば、
206 KernelNewbies プロジェクトを見るべきです
207         http://kernelnewbies.org
208
209 このサイトには役に立つメーリングリストがあり、基本的なカーネル開発に関
210 するほとんどどんな種類の質問もできます (既に回答されているようなことを
211 聞く前にまずはアーカイブを調べてください)。
212 またここには、リアルタイムで質問を聞くことができる IRC チャネルや、Linux
213 カーネルの開発に関して学ぶのに便利なたくさんの役に立つドキュメントがあ
214 ります。
215
216 web サイトには、コードの構成、サブシステム、現在存在するプロジェクト(ツ
217 リーにあるもの無いものの両方)の基本的な管理情報があります。
218 ここには、また、カーネルのコンパイルのやり方やパッチの当て方などの間接
219 的な基本情報も記述されています。
220
221 あなたがどこからスタートしてよいかわからないが、Linux カーネル開発コミュ
222 ニティに参加して何かすることをさがしている場合には、Linux kernel
223 Janitor's プロジェクトにいけばよいでしょう -
224         http://janitor.kernelnewbies.org/
225 ここはそのようなスタートをするのにうってつけの場所です。ここには、
226 Linux カーネルソースツリーの中に含まれる、きれいにし、修正しなければな
227 らない、単純な問題のリストが記述されています。このプロジェクトに関わる
228 開発者と一緒に作業することで、あなたのパッチを Linuxカーネルツリーに入
229 れるための基礎を学ぶことができ、そしてもしあなたがまだアイディアを持っ
230 ていない場合には、次にやる仕事の方向性が見えてくるかもしれません。
231
232 もしあなたが、すでにひとまとまりコードを書いていて、カーネルツリーに入
233 れたいと思っていたり、それに関する適切な支援を求めたい場合、カーネル
234 メンターズプロジェクトはそのような皆さんを助けるためにできました。
235 ここにはメーリングリストがあり、以下から参照できます
236         http://selenic.com/mailman/listinfo/kernel-mentors
237
238 実際に Linux カーネルのコードについて修正を加える前に、どうやってその
239 コードが動作するのかを理解することが必要です。そのためには、特別なツー
240 ルの助けを借りてでも、それを直接よく読むことが最良の方法です(ほとんど
241 のトリッキーな部分は十分にコメントしてありますから)。そういうツールで
242 特におすすめなのは、Linux クロスリファレンスプロジェクトです。これは、
243 自己参照方式で、索引がついた web 形式で、ソースコードを参照することが
244 できます。この最新の素晴しいカーネルコードのリポジトリは以下で見つかり
245 ます-
246         http://sosdg.org/~coywolf/lxr/
247
248 開発プロセス
249 -----------------------
250
251 Linux カーネルの開発プロセスは現在幾つかの異なるメインカーネル「ブラン
252 チ」と多数のサブシステム毎のカーネルブランチから構成されます。
253 これらのブランチとは-
254   - メインの 2.6.x カーネルツリー
255   - 2.6.x.y -stable カーネルツリー
256   - 2.6.x -git カーネルパッチ
257   - 2.6.x -mm カーネルパッチ
258   - サブシステム毎のカーネルツリーとパッチ
259
260 2.6.x カーネルツリー
261 -----------------
262
263 2.6.x カーネルは Linus Torvalds によってメンテナンスされ、kernel.org
264 の pub/linux/kernel/v2.6/ ディレクトリに存在します。この開発プロセスは
265 以下のとおり-
266
267   - 新しいカーネルがリリースされた直後に、2週間の特別期間が設けられ、
268     この期間中に、メンテナー達は Linus に大きな差分を送ることができま
269     す。このような差分は通常 -mm カーネルに数週間含まれてきたパッチで
270     す。 大きな変更は git(カーネルのソース管理ツール、詳細は
271     http://git.or.cz/  参照) を使って送るのが好ましいやり方ですが、パッ
272     チファイルの形式のまま送るのでも十分です。
273
274   - 2週間後、-rc1 カーネルがリリースされ、この後にはカーネル全体の安定
275     性に影響をあたえるような新機能は含まない類のパッチしか取り込むこと
276     はできません。新しいドライバ(もしくはファイルシステム)のパッチは
277     -rc1 の後で受け付けられることもあることを覚えておいてください。な
278     ぜなら、変更が独立していて、追加されたコードの外の領域に影響を与え
279     ない限り、退行のリスクは無いからです。-rc1 がリリースされた後、
280     Linus へパッチを送付するのに git を使うこともできますが、パッチは
281     レビューのために、パブリックなメーリングリストへも同時に送る必要が
282     あります。
283
284   - 新しい -rc は Linus が、最新の git ツリーがテスト目的であれば十分
285     に安定した状態にあると判断したときにリリースされます。目標は毎週新
286     しい -rc カーネルをリリースすることです。
287
288   - このプロセスはカーネルが 「準備ができた」と考えられるまで継続しま
289     す。このプロセスはだいたい 6週間継続します。
290
291 Andrew Morton が Linux-kernel メーリングリストにカーネルリリースについ
292 て書いたことをここで言っておくことは価値があります-
293   「カーネルがいつリリースされるかは誰も知りません。なぜなら、これは現
294   実に認識されたバグの状況によりリリースされるのであり、前もって決めら
295   れた計画によってリリースされるものではないからです。」
296
297 2.6.x.y -stable カーネルツリー
298 ---------------------------
299
300 バージョンに4つ目の数字がついたカーネルは -stable カーネルです。これに
301 は、2.6.x カーネルで見つかったセキュリティ問題や重大な後戻りに対する比
302 較的小さい重要な修正が含まれます。
303
304 これは、開発/実験的バージョンのテストに協力することに興味が無く、
305 最新の安定したカーネルを使いたいユーザに推奨するブランチです。
306
307 もし、2.6.x.y カーネルが存在しない場合には、番号が一番大きい 2.6.x
308 が最新の安定版カーネルです。
309
310 2.6.x.y は "stable" チーム <stable@kernel.org> でメンテされており、だ
311 いたい隔週でリリースされています。
312
313 カーネルツリーに入っている、Documentation/stable_kernel_rules.txt ファ
314 イルにはどのような種類の変更が -stable ツリーに受け入れ可能か、またリ
315 リースプロセスがどう動くかが記述されています。
316
317 2.6.x -git パッチ
318 ------------------
319
320 git リポジトリで管理されているLinus のカーネルツリーの毎日のスナップ
321 ショットがあります。(だから -git という名前がついています)。これらのパッ
322 チはおおむね毎日リリースされており、Linus のツリーの現状を表します。こ
323 れは -rc カーネルと比べて、パッチが大丈夫かどうかも確認しないで自動的
324 に生成されるので、より実験的です。
325
326 2.6.x -mm カーネルパッチ
327 ------------------------
328
329 Andrew Morton によってリリースされる実験的なカーネルパッチ群です。
330 Andrew は個別のサブシステムカーネルツリーとパッチを全て集めてきて
331 linux-kernel メーリングリストで収集された多数のパッチと同時に一つにま
332 とめます。
333 このツリーは新機能とパッチが検証される場となります。ある期間の間パッチ
334 が -mm に入って価値を証明されたら、Andrew やサブシステムメンテナが、メ
335 インラインへ入れるように Linus にプッシュします。
336
337 メインカーネルツリーに含めるために Linus に送る前に、すべての新しいパッ
338 チが -mm ツリーでテストされることが強く推奨されます。
339
340 これらのカーネルは安定して動作すべきシステムとして使うのには適切ではあ
341 りませんし、カーネルブランチの中でももっとも動作にリスクが高いものです。
342
343 もしあなたが、カーネル開発プロセスの支援をしたいと思っているのであれば、
344 どうぞこれらのカーネルリリースをテストに使ってみて、そしてもし問題があ
345 れば、またもし全てが正しく動作したとしても、linux-kernel メーリングリ
346 ストにフィードバックを提供してください。
347
348 すべての他の実験的パッチに加えて、これらのカーネルは通常リリース時点で
349 メインラインの -git カーネルに含まれる全ての変更も含んでいます。
350
351 -mm カーネルは決まったスケジュールではリリースされません、しかし通常幾
352 つかの -mm カーネル (1 から 3 が普通)が各-rc カーネルの間にリリースさ
353 れます。
354
355 サブシステム毎のカーネルツリーとパッチ
356 -------------------------------------------
357
358 カーネルの様々な領域で何が起きているかを見られるようにするため、多くの
359 カーネルサブシステム開発者は彼らの開発ツリーを公開しています。これらの
360 ツリーは説明したように -mm カーネルリリースに入れ込まれます。
361
362 以下はさまざまなカーネルツリーの中のいくつかのリスト-
363
364   git ツリー-
365     - Kbuild の開発ツリー、Sam Ravnborg <sam@ravnborg.org>
366         git.kernel.org:/pub/scm/linux/kernel/git/sam/kbuild.git
367
368     - ACPI の開発ツリー、 Len Brown <len.brown@intel.com>
369         git.kernel.org:/pub/scm/linux/kernel/git/lenb/linux-acpi-2.6.git
370
371     - Block の開発ツリー、Jens Axboe <axboe@suse.de>
372         git.kernel.org:/pub/scm/linux/kernel/git/axboe/linux-2.6-block.git
373
374     - DRM の開発ツリー、Dave Airlie <airlied@linux.ie>
375         git.kernel.org:/pub/scm/linux/kernel/git/airlied/drm-2.6.git
376
377     - ia64 の開発ツリー、Tony Luck <tony.luck@intel.com>
378         git.kernel.org:/pub/scm/linux/kernel/git/aegl/linux-2.6.git
379
380     - infiniband, Roland Dreier <rolandd@cisco.com>
381         git.kernel.org:/pub/scm/linux/kernel/git/roland/infiniband.git
382
383     - libata, Jeff Garzik <jgarzik@pobox.com>
384         git.kernel.org:/pub/scm/linux/kernel/git/jgarzik/libata-dev.git
385
386     - ネットワークドライバ, Jeff Garzik <jgarzik@pobox.com>
387         git.kernel.org:/pub/scm/linux/kernel/git/jgarzik/netdev-2.6.git
388
389     - pcmcia, Dominik Brodowski <linux@dominikbrodowski.net>
390         git.kernel.org:/pub/scm/linux/kernel/git/brodo/pcmcia-2.6.git
391
392     - SCSI, James Bottomley <James.Bottomley@SteelEye.com>
393         git.kernel.org:/pub/scm/linux/kernel/git/jejb/scsi-misc-2.6.git
394
395   quilt ツリー-
396     - USB, PCI ドライバコアと I2C, Greg Kroah-Hartman <gregkh@suse.de>
397         kernel.org/pub/linux/kernel/people/gregkh/gregkh-2.6/
398     - x86-64 と i386 の仲間 Andi Kleen <ak@suse.de>
399
400   その他のカーネルツリーは http://git.kernel.org/ と MAINTAINERS ファ
401   イルに一覧表があります。
402
403 バグレポート
404 -------------
405
406 bugzilla.kernel.org は Linux カーネル開発者がカーネルのバグを追跡する
407 場所です。ユーザは見つけたバグの全てをこのツールで報告すべきです。
408 どう kernel bugzilla を使うかの詳細は、以下を参照してください-
409         http://test.kernel.org/bugzilla/faq.html
410
411 メインカーネルソースディレクトリにあるファイル REPORTING-BUGS はカーネ
412 ルバグらしいものについてどうレポートするかの良いテンプレートであり、問
413 題の追跡を助けるためにカーネル開発者にとってどんな情報が必要なのかの詳
414 細が書かれています。
415
416 メーリングリスト
417 -------------
418
419 上のいくつかのドキュメントで述べていますが、コアカーネル開発者の大部分
420 は Linux kernel メーリングリストに参加しています。このリストの登録/脱
421 退の方法については以下を参照してください-
422         http://vger.kernel.org/vger-lists.html#linux-kernel
423
424 このメーリングリストのアーカイブは web 上の多数の場所に存在します。こ
425 れらのアーカイブを探すにはサーチエンジンを使いましょう。例えば-
426         http://dir.gmane.org/gmane.linux.kernel
427
428 リストに投稿する前にすでにその話題がアーカイブに存在するかどうかを検索
429 することを是非やってください。多数の事がすでに詳細に渡って議論されて
430 おり、アーカイブにのみ記録されています。
431
432 大部分のカーネルサブシステムも自分の個別の開発を実施するメーリングリス
433 トを持っています。個々のグループがどんなリストを持っているかは、
434 MAINTAINERS ファイルにリストがありますので参照してください。
435
436 多くのリストは kernel.org でホストされています。これらの情報は以下にあ
437 ります-
438         http://vger.kernel.org/vger-lists.html
439
440 メーリングリストを使う場合、良い行動習慣に従うようにしましょう。
441 少し安っぽいが、以下の URL は上のリスト(や他のリスト)で会話する場合の
442 シンプルなガイドラインを示しています-
443         http://www.albion.com/netiquette/
444
445 もし複数の人があなたのメールに返事をした場合、CC: で受ける人のリストは
446 だいぶ多くなるでしょう。良い理由がない場合、CC: リストから誰かを削除を
447 しないように、また、メーリングリストのアドレスだけにリプライすることの
448 ないようにしましょう。1つは送信者から、もう1つはリストからのように、メー
449 ルを2回受けることになってもそれに慣れ、しゃれたメールヘッダーを追加し
450 てこの状態を変えようとしないように。人々はそのようなことは好みません。
451
452 今までのメールでのやりとりとその間のあなたの発言はそのまま残し、
453 "John Kernlehacker wrote ...:" の行をあなたのリプライの先頭行にして、
454 メールの先頭でなく、各引用行の間にあなたの言いたいことを追加するべきで
455 す。
456
457 もしパッチをメールに付ける場合は、Documentaion/SubmittingPatches に提
458 示されているように、それは プレーンな可読テキストにすることを忘れない
459 ようにしましょう。カーネル開発者は 添付や圧縮したパッチを扱いたがりま
460 せん-
461 彼らはあなたのパッチの行毎にコメントを入れたいので、そのためにはそうす
462 るしかありません。あなたのメールプログラムが空白やタブを圧縮しないよう
463 に確認した方がいいです。最初の良いテストとしては、自分にメールを送って
464 みて、そのパッチを自分で当ててみることです。もしそれがうまく行かないな
465 ら、あなたのメールプログラムを直してもらうか、正しく動くように変えるべ
466 きです。
467
468 とりわけ、他の登録者に対する尊敬を表すようにすることを覚えておいてくだ
469 さい。
470
471 コミュニティと共に働くこと
472 --------------------------
473
474 カーネルコミュニティのゴールは可能なかぎり最高のカーネルを提供すること
475 です。あなたがパッチを受け入れてもらうために投稿した場合、それは、技術
476 的メリットだけがレビューされます。その際、あなたは何を予想すべきでしょ
477 うか?
478   - 批判
479   - コメント
480   - 変更の要求
481   - パッチの正当性の証明要求
482   - 沈黙
483
484 思い出してください、ここはあなたのパッチをカーネルに入れる話です。あ
485 なたは、あなたのパッチに対する批判とコメントを受け入れるべきで、それら
486 を技術的レベルで評価して、パッチを再作成するか、なぜそれらの変更をすべ
487 きでないかを明確で簡潔な理由の説明を提供してください。
488 もし、あなたのパッチに何も反応がない場合、たまにはメールの山に埋もれて
489 見逃され、あなたの投稿が忘れられてしまうこともあるので、数日待って再度
490 投稿してください。
491
492 あなたがやるべきでないものは?
493   - 質問なしにあなたのパッチが受け入れられると想像すること
494   - 守りに入ること
495   - コメントを無視すること
496   - 要求された変更を何もしないでパッチを出し直すこと
497
498 可能な限り最高の技術的解決を求めているコミュニティでは、パッチがどのく
499 らい有益なのかについては常に異なる意見があります。あなたは協調的である
500 べきですし、また、あなたのアイディアをカーネルに対してうまく合わせるよ
501 うにすることが望まれています。もしくは、最低限あなたのアイディアがそれ
502 だけの価値があるとすすんで証明するようにしなければなりません。
503 正しい解決に向かって進もうという意志がある限り、間違うことがあっても許
504 容されることを忘れないでください。
505
506 あなたの最初のパッチに単に 1ダースもの修正を求めるリストの返答になるこ
507 とも普通のことです。これはあなたのパッチが受け入れられないということで
508 は *ありません*、そしてあなた自身に反対することを意味するのでも *ありま
509 せん*。単に自分のパッチに対して指摘された問題を全て修正して再送すれば
510 いいのです。
511
512
513 カーネルコミュニティと企業組織のちがい
514 -----------------------------------------------------------------
515
516 カーネルコミュニティは大部分の伝統的な会社の開発環境とは異ったやり方で
517 動いています。以下は問題を避けるためにできるとよいことののリストです-
518
519   あなたの提案する変更について言うときのうまい言い方:
520
521     - "これは複数の問題を解決します"
522     - "これは2000行のコードを削除します"
523     - "以下のパッチは、私が言おうとしていることを説明するものです"
524     - "私はこれを5つの異なるアーキテクチャでテストしたのですが..."
525     - "以下は一連の小さなパッチ群ですが..."
526     - "これは典型的なマシンでの性能を向上させます.."
527
528   やめた方がいい悪い言い方:
529
530     - このやり方で AIX/ptx/Solaris ではできたので、できるはずだ
531     - 私はこれを20年もの間やってきた、だから
532     - これは、私の会社が金儲けをするために必要だ
533     - これは我々のエンタープライズ向け商品ラインのためである
534     - これは 私が自分のアイディアを記述した、1000ページの設計資料である
535     - 私はこれについて、6ケ月作業している。
536     - 以下は ... に関する5000行のパッチです
537     - 私は現在のぐちゃぐちゃを全部書き直した、それが以下です...
538     - 私は〆切がある、そのためこのパッチは今すぐ適用される必要がある
539
540 カーネルコミュニティが大部分の伝統的なソフトウェアエンジニアリングの労
541 働環境と異なるもう一つの点は、やりとりに顔を合わせないということです。
542 email と irc を第一のコミュニケーションの形とする一つの利点は、性別や
543 民族の差別がないことです。Linux カーネルの職場環境は女性や少数民族を受
544 容します。なぜなら、email アドレスによってのみあなたが認識されるからで
545 す。
546 国際的な側面からも活動領域を均等にするようにします。なぜならば、あなた
547 は人の名前で性別を想像できないからです。ある男性が アンドレアという名
548 前で、女性の名前は パット かもしれません (訳注 Andrea は米国では女性、
549 それ以外(欧州など)では男性名として使われることが多い。同様に、Pat は
550 Patricia (主に女性名)や Patrick (主に男性名)の略称)。
551 Linux カーネルの活動をして、意見を表明したことがある大部分の女性は、前
552 向きな経験をもっています。
553
554 言葉の壁は英語が得意でない一部の人には問題になります。
555 メーリングリストの中できちんとアイディアを交換するには、相当うまく英語
556 を操れる必要があることもあります。そのため、あなたは自分のメール
557 を送る前に英語で意味が通じているかをチェックすることをお薦めします。
558
559 変更を分割する
560 ---------------------
561
562 Linux カーネルコミュニティは、一度に大量のコードの塊を喜んで受容するこ
563 とはありません。変更は正確に説明される必要があり、議論され、小さい、個
564 別の部分に分割する必要があります。これはこれまで多くの会社がやり慣れて
565 きたことと全く正反対のことです。あなたのプロポーザルは、開発プロセスのと
566 ても早い段階から紹介されるべきです。そうすれば あなたは自分のやってい
567 ることにフィードバックを得られます。これは、コミュニティからみれば、あ
568 なたが彼らと一緒にやっているように感じられ、単にあなたの提案する機能の
569 ゴミ捨て場として使っているのではない、と感じられるでしょう。
570 しかし、一度に 50 もの email をメーリングリストに送りつけるようなことは
571 やってはいけません、あなたのパッチ群はいつもどんな時でもそれよりは小さ
572 くなければなりません。
573
574 パッチを分割する理由は以下です-
575
576 1) 小さいパッチはあなたのパッチが適用される見込みを大きくします、カー
577    ネルの人達はパッチが正しいかどうかを確認する時間や労力をかけないか
578    らです。5行のパッチはメンテナがたった1秒見るだけで適用できます。し
579    かし、500行のパッチは、正しいことをレビューするのに数時間かかるかも
580    しれません(時間はパッチのサイズなどにより指数関数に比例してかかりま
581    す)
582
583    小さいパッチは何かあったときにデバッグもとても簡単になります。パッ
584    チを1個1個取り除くのは、とても大きなパッチを当てた後に(かつ、何かお
585    かしくなった後で)解剖するのに比べればとても簡単です。
586
587 2) 小さいパッチを送るだけでなく、送るまえに、書き直して、シンプルにす
588    る(もしくは、単に順番を変えるだけでも)ことも、とても重要です。
589
590 以下はカーネル開発者の Al Viro のたとえ話しです:
591
592         "生徒の数学の宿題を採点する先生のことを考えてみてください、先
593         生は生徒が解に到達するまでの試行錯誤をみたいとは思わないでしょ
594         う。先生は簡潔な最高の解をみたいのです。良い生徒はこれを知って
595         おり、そして最終解の前の中間作業を提出することは決してないので
596         す"
597
598         カーネル開発でもこれは同じです。メンテナー達とレビューア達は、
599         問題を解決する解の背後になる思考プロセスをみたいとは思いません。
600         彼らは単純であざやかな解決方法をみたいのです。
601
602 あざやかな解を説明するのと、コミュニティと共に仕事をし、未解決の仕事を
603 議論することのバランスをキープするのは難しいかもしれません。
604 ですから、開発プロセスの早期段階で改善のためのフィードバックをもらうよ
605 うにするのもいいですが、変更点を小さい部分に分割して全体ではまだ完成し
606 ていない仕事を(部分的に)取り込んでもらえるようにすることもいいことです。
607
608 また、でき上がっていないものや、"将来直す" ようなパッチを、本流に含め
609 てもらうように送っても、それは受け付けられないことを理解してください。
610
611 あなたの変更を正当化する
612 -------------------
613
614 あなたのパッチを分割するのと同時に、なぜその変更を追加しなければならな
615 いかを Linux コミュニティに知らせることはとても重要です。新機能は必要
616 性と有用性で正当化されなければなりません。
617
618 あなたの変更の説明
619 --------------------
620
621 あなたのパッチを送付する場合には、メールの中のテキストで何を言うかにつ
622 いて、特別に注意を払ってください。この情報はパッチの ChangeLog に使わ
623 れ、いつも皆がみられるように保管されます。これは次のような項目を含め、
624 パッチを完全に記述するべきです-
625
626   - なぜ変更が必要か
627   - パッチ全体の設計アプローチ
628   - 実装の詳細
629   - テスト結果
630
631 これについて全てがどのようにあるべきかについての詳細は、以下のドキュメ
632 ントの ChangeLog セクションをみてください-
633   "The Perfect Patch"
634       http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt
635
636 これらのどれもが、時にはとても困難です。これらの慣例を完璧に実施するに
637 は数年かかるかもしれません。これは継続的な改善のプロセスであり、そのた
638 めには多数の忍耐と決意を必要とするものです。でも、諦めないで、これは可
639 能なことです。多数の人がすでにできていますし、彼らも皆最初はあなたと同
640 じところからスタートしたのですから。
641
642 Paolo Ciarrocchi に感謝、彼は彼の書いた "Development Process"
643 (http://linux.tar.bz/articles/2.6-development_process)セクショ
644 ンをこのテキストの原型にすることを許可してくれました。
645 Rundy Dunlap と Gerrit Huizenga はメーリングリストでやるべきこととやっ
646 てはいけないことのリストを提供してくれました。
647 以下の人々のレビュー、コメント、貢献に感謝。
648 Pat Mochel, Hanna Linder, Randy Dunlap, Kay Sievers,
649 Vojtech Pavlik, Jan Kara, Josh Boyer, Kees Cook, Andrew Morton, Andi
650 Kleen, Vadim Lobanov, Jesper Juhl, Adrian Bunk, Keri Harris, Frans Pop,
651 David A. Wheeler, Junio Hamano, Michael Kerrisk, と Alex Shepard
652 彼らの支援なしでは、このドキュメントはできなかったでしょう。
653
654 Maintainer: Greg Kroah-Hartman <greg@kroah.com>