← Back to branch summary

~ubuntu-branches/ubuntu/precise/linux-lowlatency/precise

« back to all changes in this revision

Viewing changes to Documentation/ja_JP/SubmittingPatches

  • Committer: Package Import Robot
  • Author(s): Alessio Igor Bogani
  • Date: 2011-10-26 11:13:05 UTC
  • Revision ID: package-import@ubuntu.com-20111026111305-tz023xykf0i6eosh
Tags: upstream-3.2.0
Import upstream version 3.2.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/ja_JP/SubmittingPatches
 
1
NOTE:
 
2
This is a version of Documentation/SubmittingPatches into Japanese.
 
3
This document is maintained by Keiichi KII <k-keiichi@bx.jp.nec.com>
 
4
and the JF Project team <http://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 of this file, please try
 
12
to update the original English file first.
 
13
 
 
14
Last Updated: 2011/06/09
 
15
 
 
16
==================================
 
17
これは、
 
18
linux-2.6.39/Documentation/SubmittingPatches の和訳
 
19
です。
 
20
翻訳団体： JF プロジェクト < http://www.linux.or.jp/JF/ >
 
21
翻訳日： 2011/06/09
 
22
翻訳者： Keiichi Kii <k-keiichi at bx dot jp dot nec dot com>
 
23
校正者： Masanari Kobayashi さん <zap03216 at nifty dot ne dot jp>
 
24
         Matsukura さん <nbh--mats at nifty dot com>
 
25
         Takeshi Hamasaki さん <hmatrjp at users dot sourceforge dot jp>
 
26
==================================
 
27
 
 
28
        Linux カーネルに変更を加えるための Howto
 
29
        又は
 
30
        かの Linus Torvalds の取り扱い説明書
 
31
 
 
32
Linux カーネルに変更を加えたいと思っている個人又は会社にとって、パッ
 
33
チの投稿に関連した仕組みに慣れていなければ、その過程は時々みなさんを
 
34
おじけづかせることもあります。この文章はあなたの変更を大いに受け入れ
 
35
てもらえやすくする提案を集めたものです。
 
36
 
 
37
コードを投稿する前に、Documentation/SubmitChecklist の項目リストに目
 
38
を通してチェックしてください。もしあなたがドライバーを投稿しようとし
 
39
ているなら、Documentation/SubmittingDrivers にも目を通してください。
 
40
 
 
41
--------------------------------------------
 
42
セクション1 パッチの作り方と送り方
 
43
--------------------------------------------
 
44
 
 
45
1) 「 diff -up 」
 
46
------------
 
47
 
 
48
パッチの作成には「 diff -up 」又は「 diff -uprN 」を使ってください。
 
49
 
 
50
Linux カーネルに対する全ての変更は diff(1) コマンドによるパッチの形式で
 
51
生成してください。パッチを作成するときには、diff(1) コマンドに「 -u 」引
 
52
数を指定して、unified 形式のパッチを作成することを確認してください。また、
 
53
変更がどの C 関数で行われたのかを表示する「 -p 」引数を使ってください。
 
54
この引数は生成した差分をずっと読みやすくしてくれます。パッチは Linux
 
55
カーネルソースの中のサブディレクトリではなく Linux カーネルソースのルート
 
56
ディレクトリを基準にしないといけません。
 
57
 
 
58
1個のファイルについてのパッチを作成するためには、ほとんどの場合、
 
59
以下の作業を行えば十分です。
 
60
 
 
61
        SRCTREE= linux-2.6
 
62
        MYFILE=  drivers/net/mydriver.c
 
63
 
 
64
        cd $SRCTREE
 
65
        cp $MYFILE $MYFILE.orig
 
66
        vi $MYFILE      # make your change
 
67
        cd ..
 
68
        diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
 
69
 
 
70
複数のファイルについてのパッチを作成するためには、素の( vanilla )、す
 
71
なわち変更を加えてない Linux カーネルを展開し、自分の Linux カーネル
 
72
ソースとの差分を生成しないといけません。例えば、
 
73
 
 
74
        MYSRC= /devel/linux-2.6
 
75
 
 
76
        tar xvfz linux-2.6.12.tar.gz
 
77
        mv linux-2.6.12 linux-2.6.12-vanilla
 
78
        diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \
 
79
                linux-2.6.12-vanilla $MYSRC > /tmp/patch
 
80
 
 
81
dontdiff ファイルには Linux カーネルのビルドプロセスの過程で生成された
 
82
ファイルの一覧がのっています。そして、それらはパッチを生成する diff(1)
 
83
コマンドで無視されるべきです。dontdiff ファイルは 2.6.12 以後のバージョ
 
84
ンの Linux カーネルソースツリーに含まれています。それより前のバージョン
 
85
の Linux カーネルソースツリーに対する dontdiff ファイルは、
 
86
<http://www.xenotime.net/linux/doc/dontdiff>から取得することができます。
 
87
 
 
88
投稿するパッチの中に関係のない余分なファイルが含まれていないことを確
 
89
認してください。diff(1) コマンドで生成したパッチがあなたの意図したとお
 
90
りのものであることを確認してください。
 
91
 
 
92
もしあなたのパッチが多くの差分を生み出すのであれば、あなたはパッチ
 
93
を意味のあるひとまとまりごとに分けたいと思うかもしれません。
 
94
これは他のカーネル開発者にとってレビューしやすくなるので、あなたの
 
95
パッチを受け入れてもらうためにはとても重要なことです。これを補助でき
 
96
る多くのスクリプトがあります。
 
97
 
 
98
Quilt:
 
99
http://savannah.nongnu.org/projects/quilt
 
100
 
 
101
Andrew Morton's patch scripts:
 
102
http://userweb.kernel.org/~akpm/stuff/patch-scripts.tar.gz
 
103
このリンクの先のスクリプトの代わりとして、quilt がパッチマネジメント
 
104
ツールとして推奨されています(上のリンクを見てください)。
 
105
 
 
106
2) パッチに対する説明
 
107
 
 
108
パッチの中の変更点に対する技術的な詳細について説明してください。
 
109
 
 
110
説明はできる限り具体的に。もっとも悪い説明は「ドライバー X を更新」、
 
111
「ドライバー X に対するバグフィックス」あるいは「このパッチはサブシス
 
112
テム X に対する更新を含んでいます。どうか取り入れてください。」などです。
 
113
 
 
114
パッチの説明を Linux カーネルのソースコードマネジメントシステム「 git 」の
 
115
コミットログとして簡単に引用できる形で書けば、メンテナから感謝されるでしょう。
 
116
以下の #15 を見てください。
 
117
 
 
118
説明が長くなりだしたのであれば、おそらくそれはパッチを分ける必要がある
 
119
という兆候です。次の #3 を見てください。
 
120
 
 
121
パッチ(シリーズ)を(再)投稿する時、十分なパッチの説明とそのパッチが必要な理由を
 
122
パッチに含めてください。ただ「これはパッチ(シリーズ)のバージョン N」とだけ
 
123
書かないでください。そして、パッチをマージする人にパッチの説明を探させそれを
 
124
パッチに追記させるため、過去のバージョンのパッチやそのパッチの URL を参照する
 
125
手間をかけさせないでください。
 
126
つまり、パッチシリーズとその説明は一緒にあるべきです。これはパッチをマージする
 
127
人、レビューする人、どちらのためにもなります。レビューする人の中には、おそらく
 
128
過去のバージョンのパッチを受け取ってもいない人がいます。
 
129
 
 
130
登録済みのバグエントリを修正するパッチであれば、そのバグエントリを示すバグ ID
 
131
や URL を明記してください。
 
132
 
 
133
3) パッチの分割
 
134
 
 
135
意味のあるひとまとまりごとに変更を個々のパッチファイルに分けてください。
 
136
 
 
137
例えば、もし1つのドライバーに対するバグフィックスとパフォーマンス強
 
138
化の両方の変更を含んでいるのであれば、その変更を2つ以上のパッチに分
 
139
けてください。もし変更箇所に API の更新と、その新しい API を使う新たな
 
140
ドライバーが含まれているなら、2つのパッチに分けてください。
 
141
 
 
142
一方で、もしあなたが多数のファイルに対して意味的に同じ1つの変更を加え
 
143
るのであれば、その変更を1つのパッチにまとめてください。言いかえると、
 
144
意味的に同じ1つの変更は1つのパッチの中に含まれます。
 
145
 
 
146
あるパッチが変更を完結させるために他のパッチに依存していたとしても、
 
147
それは問題ありません。パッチの説明の中で「このパッチはパッチ X に依存
 
148
している」と簡単に注意書きをつけてください。
 
149
 
 
150
もしパッチをより小さなパッチの集合に凝縮することができないなら、まずは
 
151
15かそこらのパッチを送り、そのレビューと統合を待って下さい。
 
152
 
 
153
4) パッチのスタイルチェック
 
154
 
 
155
あなたのパッチが基本的な( Linux カーネルの)コーディングスタイルに違反し
 
156
ていないかをチェックして下さい。その詳細を Documentation/CodingStyle で
 
157
見つけることができます。コーディングスタイルの違反はレビューする人の
 
158
時間を無駄にするだけなので、恐らくあなたのパッチは読まれることすらなく
 
159
拒否されるでしょう。
 
160
 
 
161
あなたはパッチを投稿する前に最低限パッチスタイルチェッカー
 
162
( scripts/checkpatch.pl )を利用してパッチをチェックすべきです。
 
163
もしパッチに違反がのこっているならば、それらの全てについてあなたは正当な
 
164
理由を示せるようにしておく必要があります。
 
165
 
 
166
5) 電子メールの宛先の選び方
 
167
 
 
168
MAINTAINERS ファイルとソースコードに目を通してください。そして、その変
 
169
更がメンテナのいる特定のサブシステムに加えられるものであることが分か
 
170
れば、その人に電子メールを送ってください。
 
171
 
 
172
もし、メンテナが載っていなかったり、メンテナからの応答がないなら、
 
173
LKML ( linux-kernel@vger.kernel.org )へパッチを送ってください。ほとんど
 
174
のカーネル開発者はこのメーリングリストに目を通しており、変更に対して
 
175
コメントを得ることができます。
 
176
 
 
177
15個より多くのパッチを同時に vger.kernel.org のメーリングリストへ送らな
 
178
いでください!!!
 
179
 
 
180
Linus Torvalds は Linux カーネルに入る全ての変更に対する最終的な意思決定者
 
181
です。電子メールアドレスは torvalds@linux-foundation.org になります。彼は
 
182
多くの電子メールを受け取っているため、できる限り彼に電子メールを送るのは
 
183
避けるべきです。
 
184
 
 
185
バグフィックスであったり、自明な変更であったり、話し合いをほとんど
 
186
必要としないパッチは Linus へ電子メールを送るか CC しなければなりません。
 
187
話し合いを必要としたり、明確なアドバンテージがないパッチは、通常まず
 
188
は LKML へ送られるべきです。パッチが議論された後にだけ、そのパッチを
 
189
Linus へ送るべきです。
 
190
 
 
191
6) CC (カーボンコピー)先の選び方
 
192
 
 
193
特に理由がないなら、LKML にも CC してください。
 
194
 
 
195
Linus 以外のカーネル開発者は変更に気づく必要があり、その結果、彼らはそ
 
196
の変更に対してコメントをくれたり、コードに対してレビューや提案をくれ
 
197
るかもしれません。LKML とは Linux カーネル開発者にとって一番中心的なメー
 
198
リングリストです。USB やフレームバッファデバイスや VFS や SCSI サブシステ
 
199
ムなどの特定のサブシステムに関するメーリングリストもあります。あなた
 
200
の変更に、はっきりと関連のあるメーリングリストについて知りたければ
 
201
MAINTAINERS ファイルを参照してください。
 
202
 
 
203
VGER.KERNEL.ORG でホスティングされているメーリングリストの一覧が下記の
 
204
サイトに載っています。
 
205
<http://vger.kernel.org/vger-lists.html>
 
206
 
 
207
もし、変更がユーザランドのカーネルインタフェースに影響を与え
 
208
るのであれば、MAN-PAGES のメンテナ( MAINTAINERS ファイルに一覧
 
209
があります)に man ページのパッチを送ってください。少なくとも
 
210
情報がマニュアルページの中に入ってくるように、変更が起きたという
 
211
通知を送ってください。
 
212
 
 
213
たとえ、メンテナが #5 で反応がなかったとしても、メンテナのコードに変更を
 
214
加えたときには、いつもメンテナに CC するのを忘れないようにしてください。
 
215
 
 
216
小さなパッチであれば、Trivial Patch Monkey(ちょっとしたパッチを集めている)
 
217
<trivial@kernel.org>に CC してもいいです。その現管理者については MAINTAINERS
 
218
ファイルを見てください。ちょっとしたパッチとは以下のルールのどれか1つを満たして
 
219
いなければなりません。
 
220
 ・ドキュメントのスペルミスの修正
 
221
 ・grep(1) コマンドによる検索を困難にしているスペルの修正
 
222
 ・コンパイル時の警告の修正(無駄な警告が散乱することは好ましくないた
 
223
   めです)
 
224
 ・コンパイル問題の修正(それらの修正が本当に正しい場合に限る)
 
225
 ・実行時の問題の修正(それらの修正が本当に問題を修正している場合に限る)
 
226
 ・廃止予定の関数やマクロを使用しているコードの除去(例 check_region )
 
227
 ・問い合わせ先やドキュメントの修正
 
228
 ・移植性のないコードから移植性のあるコードへの置き換え(小さい範囲で
 
229
   あればアーキテクチャ特有のことでも他の人がコピーできます)
 
230
 ・作者やメンテナによる修正(すなわち patch monkey の再転送モード)
 
231
 
 
232
7) MIME やリンクや圧縮ファイルや添付ファイルではなくプレインテキストのみ
 
233
 
 
234
Linus や他のカーネル開発者はあなたが投稿した変更を読んで、コメントでき
 
235
る必要があります。カーネル開発者にとって、あなたが書いたコードの特定の
 
236
部分にコメントをするために、標準的な電子メールクライアントで変更が引用
 
237
できることは重要です。
 
238
 
 
239
上記の理由で、すべてのパッチは文中に含める形式の電子メールで投稿さ
 
240
れるべきです。警告：あなたがパッチをコピー&ペーストする際には、パッ
 
241
チを改悪するエディターの折り返し機能に注意してください。
 
242
 
 
243
パッチを圧縮の有無に関わらず MIME 形式で添付しないでください。多くのポ
 
244
ピュラーな電子メールクライアントは MIME 形式の添付ファイルをプレーンテ
 
245
キストとして送信するとは限らないでしょう。そうなると、電子メールクラ
 
246
イアントがコードに対するコメントを付けることをできなくします。また、
 
247
MIME 形式の添付ファイルは Linus に手間を取らせることになり、その変更を
 
248
受け入れてもらう可能性が低くなってしまいます。
 
249
 
 
250
例外：お使いの電子メールクライアントがパッチをめちゃくちゃにするので
 
251
あれば、誰かが MIME 形式のパッチを再送するよう求めるかもしれません。
 
252
 
 
253
余計な変更を加えずにあなたのパッチを送信するための電子メールクライアントの設定
 
254
のヒントについては Documentation/email-clients.txt を参照してください。
 
255
 
 
256
8) 電子メールのサイズ
 
257
 
 
258
パッチを Linus へ送るときは常に #7 の手順に従ってください。
 
259
 
 
260
大きなパッチはメーリングリストやメンテナにとって不親切です。パッチが
 
261
未圧縮で 300KB を超えるようであるなら、インターネット上のアクセス可能な
 
262
サーバに保存し、保存場所を示す URL を伝えるほうが適切です。
 
263
 
 
264
9) カーネルバージョンの明記
 
265
 
 
266
パッチが対象とするカーネルのバージョンをパッチの概要か電子メールの
 
267
サブジェクトに付けることが重要です。
 
268
 
 
269
パッチが最新バージョンのカーネルに正しく適用できなければ、Linus は
 
270
そのパッチを採用しないでしょう。
 
271
 
 
272
10) がっかりせず再投稿
 
273
 
 
274
パッチを投稿した後は、辛抱強く待っていてください。Linus があなたのパッ
 
275
チを気に入って採用すれば、Linus がリリースする次のバージョンのカーネル
 
276
の中で姿を見せるでしょう。
 
277
 
 
278
しかし、パッチが次のバージョンのカーネルに入っていないなら、いくつもの
 
279
理由があるのでしょう。その原因を絞り込み、間違っているものを正し、更新
 
280
したパッチを投稿するのはあなたの仕事です。
 
281
 
 
282
Linus があなたのパッチに対して何のコメントもなく不採用にすることは極め
 
283
て普通のことです。それは自然な姿です。もし、Linus があなたのパッチを受
 
284
け取っていないのであれば、以下の理由が考えられます。
 
285
* パッチが最新バージョンの Linux カーネルにきちんと適用できなかった
 
286
* パッチが LKML で十分に議論されていなかった
 
287
* スタイルの問題(セクション2を参照)
 
288
* 電子メールフォーマットの問題(このセクションを参照)
 
289
* パッチに対する技術的な問題
 
290
* Linus はたくさんの電子メールを受け取っているので、どさくさに紛れて見
 
291
  失った
 
292
* 不愉快にさせている
 
293
 
 
294
判断できない場合は、LKML にコメントを頼んでください。
 
295
 
 
296
11) サブジェクトに「 PATCH 」
 
297
 
 
298
Linus や LKML への大量の電子メールのために、サブジェクトのプレフィックスに
 
299
「 [PATCH] 」を付けることが慣習となっています。これによって Linus や他の
 
300
カーネル開発者がパッチであるのか、又は、他の議論に関する電子メールであるの
 
301
かをより簡単に識別できます。
 
302
 
 
303
12) パッチへの署名
 
304
 
 
305
誰が何をしたのかを追いかけやすくするために (特に、パッチが何人かの
 
306
メンテナを経て最終的に Linux カーネルに取り込まれる場合のために)、電子
 
307
メールでやり取りされるパッチに対して「 sign-off 」という手続きを導入し
 
308
ました。
 
309
 
 
310
「 sign-off 」とは、パッチがあなたの書いたものであるか、あるいは、
 
311
あなたがそのパッチをオープンソースとして提供する権利を保持している、
 
312
という証明をパッチの説明の末尾に一行記載するというものです。
 
313
ルールはとても単純です。以下の項目を確認して下さい。
 
314
 
 
315
        原作者の証明書( DCO ) 1.1
 
316
 
 
317
        このプロジェクトに寄与するものとして、以下のことを証明する。
 
318
 
 
319
        (a) 本寄与は私が全体又は一部作成したものであり、私がそのファイ
 
320
            ル中に明示されたオープンソースライセンスの下で公開する権利
 
321
            を持っている。もしくは、
 
322
 
 
323
        (b) 本寄与は、私が知る限り、適切なオープンソースライセンスでカバ
 
324
            ーされている既存の作品を元にしている。同時に、私はそのライセ
 
325
            ンスの下で、私が全体又は一部作成した修正物を、ファイル中で示
 
326
            される同一のオープンソースライセンスで(異なるライセンスの下で
 
327
            投稿することが許可されている場合を除いて)投稿する権利を持って
 
328
            いる。もしくは、
 
329
 
 
330
        (c) 本寄与は(a)、(b)、(c)を証明する第3者から私へ直接提供された
 
331
            ものであり、私はそれに変更を加えていない。
 
332
 
 
333
        (d) 私はこのプロジェクトと本寄与が公のものであることに理解及び同意す
 
334
            る。同時に、関与した記録(投稿の際の全ての個人情報と sign-off を
 
335
            含む)が無期限に保全されることと、当該プロジェクト又は関連する
 
336
            オープンソースライセンスに沿った形で再配布されることに理解及び
 
337
            同意する。
 
338
 
 
339
もしこれに同意できるなら、以下のような1行を追加してください。
 
340
 
 
341
        Signed-off-by: Random J Developer <random@developer.example.org>
 
342
 
 
343
実名を使ってください。(残念ですが、偽名や匿名による寄与はできません。)
 
344
 
 
345
人によっては sign-off の近くに追加のタグを付加しています。それらは今のところ
 
346
無視されますが、あなたはそのタグを社内の手続きに利用したり、sign-off に特別
 
347
な情報を示したりすることができます。
 
348
 
 
349
あなたがサブシステムまたはブランチのメンテナであれば、受け取ったパッチを自身の
 
350
ツリーにマージするために、わずかに変更が必要となる場合があります。なぜなら
 
351
あなたのツリーの中のコードと投稿者のツリーの中のコードは同一ではないためです。
 
352
もし、あなたが厳密に上記ルール(c)にこだわるのであれば、投稿者に再度差分を
 
353
とるよう依頼すべきです。しかし、これは時間とエネルギーを非生産的に浪費する
 
354
ことになります。ルール(b)はあなたにコードを修正する権利を与えてくれます。
 
355
しかし、投稿者のコードを修正し、その修正によるバグを投稿者に押し付けてしまう
 
356
ことはとても失礼なことです。この問題を解決するために、末尾の投稿者の
 
357
Signed-off-by とあなたがその末尾に追加する Signed-off-by の間に、修正を
 
358
加えたことを示す1行を追加することが推奨されています。
 
359
(その1行の書き方に)決まりはありませんが、大括弧の中に電子メールアドレスや氏名
 
360
と修正内容を記載するやり方は目につきやすく、最終段階での変更の責任があなたに
 
361
あることを明確にするのに十分な方法のようです。例えば、
 
362
 
 
363
        Signed-off-by: Random J Developer <random@developer.example.org>
 
364
        [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h]
 
365
        Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org>
 
366
 
 
367
あなたが安定版のブランチを管理しており、作成者のクレジット、変更の追跡、
 
368
修正のマージ、と同時に苦情からの投稿者の保護を行いたい場合、この慣習は特に
 
369
有用となります。いかなる事情があってもチェンジログに出てくる作成者の
 
370
アイデンティティ情報(From ヘッダ)は変更できないことに注意してください。
 
371
 
 
372
バックポートする人のための特別な注意事項。追跡を容易に行うために、コミット
 
373
メッセージのトップ(サブジェクト行のすぐ後)にパッチの起源を示す情報を記述する
 
374
ことは一般的で有用な慣習です。例えば、これは 2.6-stable ツリーでの一例です。    
 
375
 
 
376
    Date:   Tue May 13 19:10:30 2008 +0000
 
377
 
 
378
        SCSI: libiscsi regression in 2.6.25: fix nop timer handling
 
379
 
 
380
        commit 4cf1043593db6a337f10e006c23c69e5fc93e722 upstream
 
381
 
 
382
そして、これは 2.4 ツリーでの一例です。
 
383
 
 
384
    Date:   Tue May 13 22:12:27 2008 +0200
 
385
 
 
386
        wireless, airo: waitbusy() won't delay
 
387
 
 
388
        [backport of 2.6 commit b7acbdfbd1f277c1eb23f344f899cfa4cd0bf36a]
 
389
 
 
390
どんな形式であれ、この情報はあなたのツリーを追跡する人やあなたのツリーのバグを
 
391
解決しようとしている人にとって価値のある支援となります。
 
392
 
 
393
13) いつ Acked-by: と Cc: を使うのか
 
394
 
 
395
「 Signed-off-by: 」タグはその署名者がパッチの開発に関わっていたことやパッチ
 
396
の伝播パスにいたことを示しています。
 
397
 
 
398
ある人が直接パッチの準備や作成に関わっていないけれど、その人のパッチに対す
 
399
る承認を記録し、示したいとします。その場合、その人を示すのに Acked-by: が使
 
400
えます。Acked-by: はパッチのチェンジログにも追加されます。
 
401
 
 
402
パッチの影響を受けるコードのメンテナがパッチに関わっていなかったり、パッチ
 
403
の伝播パスにいなかった時にも、メンテナは Acked-by: をしばしば利用します。
 
404
 
 
405
Acked-by: は Signed-off-by: のように公式なタグではありません。それはメンテナが
 
406
少なくともパッチをレビューし、同意を示しているという記録です。そのような
 
407
ことからパッチをマージする人がメンテナの「うん、良いと思うよ」という発言を
 
408
Acked-by: へ置き換えることがあります。
 
409
 
 
410
Acked-by: が必ずしもパッチ全体の承認を示しているわけではありません。例えば、
 
411
あるパッチが複数のサブシステムへ影響を与えており、その中の1つのサブシステム
 
412
のメンテナからの Acked-by: を持っているとします。その場合、Acked-by: は通常
 
413
そのメンテナのコードに影響を与える一部分だけに対する承認を示しています。
 
414
この点は、ご自分で判断してください。(その Acked-by: が)疑わしい場合は、
 
415
メーリングリストアーカイブの中の大元の議論を参照すべきです。
 
416
 
 
417
パッチにコメントする機会を持っていたが、その時にコメントしなかった人がいれば、
 
418
その人を指す「Cc:」タグを任意で追加してもかまいません。これは指定された人からの
 
419
明確なアクションなしに付与できる唯一のタグです。
 
420
このタグはパッチに関心があると思われる人達がそのパッチの議論に含まれていたこと
 
421
を明文化します。
 
422
 
 
423
14) Reported-by と Tested-by: と Reviewed-by: の利用
 
424
 
 
425
他の誰かによって報告された問題を修正するパッチであれば、問題報告者という寄与を
 
426
クレジットするために、Reported-by: タグを追加することを検討してください。
 
427
こまめにバグ報告者をクレジットしていくことで、うまくいけばその人たちが将来再び
 
428
コミュニティの力となってくれるでしょう。
 
429
ただし、報告者の許可無くこのタグを追加しないように注意してください。特に、
 
430
問題が公の場で報告されていなかったのであれば。
 
431
 
 
432
Tested-by: タグはタグで指定された人によって(ある環境下で)パッチのテストに成功
 
433
していることを示します。このタグはメンテナにテストが実施済みであることを
 
434
知らせ、将来の関連パッチのテスト協力者を見つける方法を提供し、テスト実施者に
 
435
対するクレジットを保証します。
 
436
 
 
437
Reviewed-by: タグは、それとは異なり、下記のレビューア宣言の下にレビューされ、
 
438
受け入れ可能とみなされたパッチであることを示します。
 
439
 
 
440
        レビューアによる監督宣言
 
441
 
 
442
        私は Reviewed-by: タグを提示することによって、以下のことを明言する。
 
443
 
 
444
        (a) 私はメインラインカーネルへの統合に向け、その妥当性及び「即応性
 
445
            (訳注)」を検証し、技術的側面からパッチをレビュー済みである。
 
446
 
 
447
        訳注:
 
448
        「即応性」の原文は "readiness"。
 
449
        パッチが十分な品質を持っており、メインラインカーネルへの統合を即座に
 
450
        行うことができる状態であるかどうかを "readiness" という単語で表現
 
451
        している。
 
452
 
 
453
        (b) パッチに関するあらゆる問題、懸念、あるいは、疑問は投稿者へ伝達済み
 
454
            である。私はそれらのコメントに対する投稿者の返答に満足している。
 
455
 
 
456
        (c) 投稿に伴い改良されるコードがある一方で、現時点で、私は(1)それが
 
457
            カーネルにとって価値のある変更であること、そして、(2)統合に際して
 
458
            議論になり得るような問題はないものと確信している。
 
459
 
 
460
        (d) 私はパッチをレビューし適切であると確信している一方で、あらゆる
 
461
            状況においてその宣言した目的や機能が正しく実現することに関して、
 
462
            いかなる保証もしない(特にどこかで明示しない限り)。
 
463
 
 
464
Reviewd-by タグはそのパッチがカーネルに対して適切な修正であって、深刻な技術的
 
465
問題を残していないという意見の宣言です。興味のあるレビューアは誰でも(レビュー
 
466
作業を終えたら)パッチに対して Reviewed-by タグを提示できます。このタグは
 
467
レビューアの寄与をクレジットする働き、レビューの進捗の度合いをメンテナに
 
468
知らせる働きを持ちます。そのパッチの領域に詳しく、そして、しっかりとした
 
469
レビューを実施したレビューアによって提供される時、Reviewed-by: タグがあなたの
 
470
パッチをカーネルにマージする可能性を高めるでしょう。
 
471
 
 
472
15) 標準的なパッチのフォーマット
 
473
 
 
474
標準的なパッチのサブジェクトは以下のとおりです。
 
475
 
 
476
    Subject: [PATCH 001/123] subsystem: summary phrase
 
477
 
 
478
標準的なパッチの、電子メールのボディは以下の項目を含んでいます。
 
479
 
 
480
  - パッチの作成者を明記する「 from 」行
 
481
 
 
482
  - 空行
 
483
 
 
484
  - 説明本体。これはこのパッチを説明するために無期限のチェンジログ
 
485
    (変更履歴)にコピーされます。
 
486
 
 
487
  - 上述した「 Signed-off-by: 」行。これも説明本体と同じくチェン
 
488
    ジログ内にコピーされます。
 
489
 
 
490
  - マーカー行は単純に「 --- 」です。
 
491
 
 
492
  - 余計なコメントは、チェンジログには不適切です。
 
493
 
 
494
  - 実際のパッチ(差分出力)
 
495
 
 
496
サブジェクト行のフォーマットは、アルファベット順で電子メールをとても
 
497
ソートしやすいものになっています。(ほとんどの電子メールクライアント
 
498
はソートをサポートしています)パッチのサブジェクトの連番は0詰めであ
 
499
るため、数字でのソートとアルファベットでのソートは同じ結果になります。
 
500
 
 
501
電子メールのサブジェクト内のサブシステム表記は、パッチが適用される
 
502
分野またはサブシステムを識別できるようにすべきです。
 
503
 
 
504
電子メールのサブジェクトの「summary phrase」はそのパッチの概要を正確
 
505
に表現しなければなりません。「summary phrase」をファイル名にしてはい
 
506
けません。パッチシリーズ中でそれぞれのパッチは同じ「summary phrase」を
 
507
使ってはいけません(「パッチシリーズ」とは順序付けられた関連のある複数の
 
508
パッチ群です)。
 
509
 
 
510
あなたの電子メールの「summary phrase」がそのパッチにとって世界で唯一の識別子に
 
511
なるように心がけてください。「summary phrase」は git のチェンジログの中へ
 
512
ずっと伝播していきます。「summary phrase」は、開発者が後でパッチを参照する
 
513
ために議論の中で利用するかもしれません。
 
514
人々はそのパッチに関連した議論を読むために「summary phrase」を使って google で
 
515
検索したがるでしょう。それはまた2、3ヶ月あとで、人々が「gitk」や
 
516
「git log --oneline」のようなツールを使用して何千ものパッチに目を通す時、
 
517
唯一目にとまる情報となるでしょう。
 
518
 
 
519
これらの理由のため、「summary phrase」はなぜパッチが必要であるか、パッチが何を
 
520
変更するかの2つの情報をせいぜい70〜75文字で表現していなければなりません。
 
521
「summary phrase」は簡潔であり説明的である表現を目指しつつ、うまく
 
522
まとめられている概要となるべきです。
 
523
 
 
524
「summary phrase」は「Subject: [PATCH tag] <summary phrase>」のように、
 
525
大括弧で閉じられたタグを接頭辞として付加してもかまいません。このタグは
 
526
「summary phrase」の一部とは考えませんが、パッチをどのように取り扱うべきかを
 
527
表現します。
 
528
一般的には「v1, v2, v3」のようなバージョン情報を表すタグ(過去のパッチに対する
 
529
コメントを反映するために複数のバージョンのパッチが投稿されているのであれば)、
 
530
「RFC」のようなコメントを要求するタグが挙げられます。パッチシリーズとして4つの
 
531
パッチがあれば、個々のパッチに「1/4, 2/4, 3/4, 4/4」のように番号を付けても
 
532
かまいません。これは開発者がパッチを適用する順番を確実に把握するためです。
 
533
そして、開発者がパッチシリーズの中のすべてのパッチをもらさずレビュー或いは
 
534
適用するのを保証するためです。
 
535
 
 
536
サブジェクトの例を二つ
 
537
 
 
538
    Subject: [patch 2/5] ext2: improve scalability of bitmap searching
 
539
    Subject: [PATCHv2 001/207] x86: fix eflags tracking
 
540
 
 
541
「 from 」行は電子メールのボディの一番最初の行でなければなりません。
 
542
その形式は以下のとおりです。
 
543
 
 
544
        From: Original Author <author@example.com>
 
545
 
 
546
「 from 」行はチェンジログの中で、そのパッチの作成者としてクレジットされ
 
547
ている人を特定するものです。「 from 」行がかけていると、電子メールのヘッ
 
548
ダーの「 From: 」が、チェンジログの中でパッチの作成者を決定するために使わ
 
549
れるでしょう。
 
550
 
 
551
説明本体は無期限のソースのチェンジログにコミットされます。なので、説明
 
552
本体はそのパッチに至った議論の詳細を忘れているある程度の技量を持っている人
 
553
がその詳細を思い出すことができるものでなければなりません。パッチが対処する
 
554
障害の症状(カーネルログメッセージや oops メッセージ等)を記載することは問題に
 
555
対処可能なパッチを求めてコミットログを検索する人々にとって特に有用です。
 
556
パッチがコンパイル問題を解決するのであれば、そのパッチを探している人が見つける
 
557
ことができる情報だけで十分であり、コンパイル時の全てのエラーを含める必要は
 
558
ありません。「summary phrase」と同様に、簡潔であり説明的であることが重要です。
 
559
 
 
560
「 --- 」マーカー行はパッチ処理ツールに対して、チェンジログメッセージの終端
 
561
部分を認識させるという重要な役目を果たします。
 
562
 
 
563
「 --- 」マーカー行の後の追加コメントの良い使用方法の1つに diffstat コマンド
 
564
があります。diffstat コマンドとは何のファイルが変更され、1ファイル当たり何行
 
565
追加され何行消されたかを示すものです。diffstat コマンドは特に大きなパッチに
 
566
おいて役立ちます。その時点でだけ又はメンテナにとってのみ関係のあるコメント
 
567
は無期限に保存されるチェンジログにとって適切ではありません。そのため、この
 
568
ようなコメントもマーカー行の後に書かれるべきです。
 
569
このようなコメントの良い例として、v1 と v2 のバージョン間で何が変更されたかを
 
570
表す「パッチの変更履歴」が挙げられます。
 
571
 
 
572
「 --- 」マーカー行の後に diffstat コマンドの結果を含めるのであれば、ファイル
 
573
名はカーネルソースツリーのトップディレクトリからの表記で列記されるため、横方向
 
574
のスペースをとり過ぎないように、diffstat コマンドにオプション「 -p 1 -w 70 」
 
575
を指定してください(インデントを含めてちょうど80列に合うでしょう)。
 
576
 
 
577
適切なパッチのフォーマットの詳細についてはセクション3の参考文献を参照して
 
578
ください。
 
579
 
 
580
16) 「git pull」要求の送り方(Linus の電子メールから)
 
581
 
 
582
間違ったブランチから引っ張るのを防ぐために、git リポジトリのアドレスと
 
583
ブランチ名を同じ行に1行で記載してください。そうすることで、3回の連続クリック
 
584
で全て選択できます。
 
585
 
 
586
正しい形式は下記の通りです。
 
587
 
 
588
        "Please pull from
 
589
 
 
590
                git://jdelvare.pck.nerim.net/jdelvare-2.6 i2c-for-linus
 
591
 
 
592
         to get these changes:"
 
593
 
 
594
その結果、アドレスを自分自身でタイピングして間違えることはなくなります(実際に、
 
595
何度か間違ったブランチから引っ張ってきてしまい、その時に diffstat の結果を
 
596
検証して間違っていることに気づいたことがあります。どこから何を引っ張るべきかを
 
597
「探したり」、正しいブランチ名かどうかを重ねてチェックしたりする必要が
 
598
なくなればより快適になるでしょう)。
 
599
 
 
600
diffstat の結果を生成するために「 git diff -M --stat --summary 」を使って
 
601
ください。-M オプションはファイル名の変更を検知でき、--summary オプションは
 
602
新規ファイル、削除されたファイル、名前が変更されたファイルの概要を生成します。
 
603
 
 
604
-M オプション(ファイル名の変更検知)を指定すると、diffstat の結果はかなり
 
605
異なってきます。git は大規模な変更(追加と削除のペア)をファイル名の変更と
 
606
判断するためです。
 
607
 
 
608
------------------------------------
 
609
セクション2 - ヒントとTIPSと小技
 
610
------------------------------------
 
611
 
 
612
このセクションは Linux カーネルに変更を適用することに関係のある一般的な
 
613
「お約束」の多くを載せています。物事には例外というものがあります。しか
 
614
し例外を適用するには、本当に妥当な理由が不可欠です。あなたは恐らくこの
 
615
セクションを Linus のコンピュータ・サイエンス101と呼ぶでしょう。
 
616
 
 
617
1) Documentation/CodingStyleを参照
 
618
 
 
619
言うまでもなく、あなたのコードがこのコーディングスタイルからあまりに
 
620
も逸脱していると、レビューやコメントなしに受け取ってもらえないかもし
 
621
れません。
 
622
 
 
623
特筆すべき例外は、コードをあるファイルから別のファイルに移動
 
624
するときです。この場合、コードを移動するパッチでは、移動されるコード
 
625
に関して移動以外の変更を一切加えるべきではありません。これにより、
 
626
コードの移動とあなたが行ったコードの修正を明確に区別できるようにな
 
627
ります。これは実際に何が変更されたかをレビューする際の大きな助けに
 
628
なるとともに、ツールにコードの履歴を追跡させることも容易になります。
 
629
 
 
630
投稿するより前にパッチのスタイルチェッカー( scripts/checkpatch.pl )で
 
631
あなたのパッチをチェックしてください。このスタイルチェッカーは最終結
 
632
論としてではなく、指標としてみるべきです。もし、あなたのコードが違反
 
633
はしているが修正するより良く見えるのであれば、おそらくそのままにする
 
634
のがベストです。
 
635
 
 
636
スタイルチェッカーによる3段階のレポート:
 
637
 - エラー: 間違っている可能性が高い
 
638
 - 警告：注意してレビューする必要がある
 
639
 - チェック：考慮する必要がある
 
640
 
 
641
あなたはパッチに残っている全ての違反について、それがなぜ必要なのか正当な
 
642
理由を示せるようにしておく必要があります。
 
643
 
 
644
2) #ifdefは見苦しい
 
645
 
 
646
ifdef が散乱したコードは、読むのもメンテナンスするのも面倒です。コードの中
 
647
で ifdef を使わないでください。代わりに、ヘッダファイルの中に ifdef を入れて、
 
648
条件付きで、コードの中で使われる関数を「 static inline 」関数かマクロで定義し
 
649
てください。後はコンパイラが、何もしない箇所を最適化して取り去ってくれるで
 
650
しょう。
 
651
 
 
652
まずいコードの簡単な例
 
653
 
 
654
        dev = alloc_etherdev (sizeof(struct funky_private));
 
655
        if (!dev)
 
656
                return -ENODEV;
 
657
        #ifdef CONFIG_NET_FUNKINESS
 
658
        init_funky_net(dev);
 
659
        #endif
 
660
 
 
661
クリーンアップしたコードの例
 
662
 
 
663
(in header)
 
664
        #ifndef CONFIG_NET_FUNKINESS
 
665
        static inline void init_funky_net (struct net_device *d) {}
 
666
        #endif
 
667
 
 
668
(in the code itself)
 
669
        dev = alloc_etherdev (sizeof(struct funky_private));
 
670
        if (!dev)
 
671
                return -ENODEV;
 
672
        init_funky_net(dev);
 
673
 
 
674
3) マクロより「 static inline 」を推奨
 
675
 
 
676
「 static inline 」関数はマクロよりもずっと推奨されています。それらは、
 
677
型安全性があり、長さにも制限が無く、フォーマットの制限もありません。
 
678
gcc においては、マクロと同じくらい軽いです。
 
679
 
 
680
マクロは「 static inline 」が明らかに不適切であると分かる場所(高速化パスの
 
681
いくつかの特定のケース)や「 static inline 」関数を使うことができないような
 
682
場所(マクロの引数の文字列連結のような)にだけ使われるべきです。
 
683
 
 
684
「 static inline 」は「 static __inline__ 」や「 extern inline 」や
 
685
「 extern __inline__ 」よりも適切です。
 
686
 
 
687
4) 設計に凝りすぎるな
 
688
 
 
689
それが有用になるかどうか分からないような不明瞭な将来を見越した設計
 
690
をしないでください。「できる限り簡単に、そして、それ以上簡単になら
 
691
ないような設計をしてください。」
 
692
 
 
693
----------------------
 
694
セクション3 参考文献
 
695
----------------------
 
696
 
 
697
Andrew Morton, "The perfect patch" (tpp).
 
698
  <http://userweb.kernel.org/~akpm/stuff/tpp.txt>
 
699
 
 
700
Jeff Garzik, "Linux kernel patch submission format".
 
701
  <http://linux.yyz.us/patch-format.html>
 
702
 
 
703
Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
 
704
  <http://www.kroah.com/log/2005/03/31/>
 
705
  <http://www.kroah.com/log/2005/07/08/>
 
706
  <http://www.kroah.com/log/2005/10/19/>
 
707
  <http://www.kroah.com/log/2006/01/11/>
 
708
 
 
709
NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
 
710
  <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
 
711
 
 
712
Kernel Documentation/CodingStyle:
 
713
  <http://users.sosdg.org/~qiyong/lxr/source/Documentation/CodingStyle>
 
714
 
 
715
Linus Torvalds's mail on the canonical patch format:
 
716
  <http://lkml.org/lkml/2005/4/7/183>
 
717
 
 
718
Andi Kleen, "On submitting kernel patches"
 
719
  Some strategies to get difficult or controversial changes in.
 
720
  http://halobates.de/on-submitting-patches.pdf
 
721
 
 
722
--
 
723
 
 
724