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