Debian Codegraph @

Documentation/translations/ja_JP/SubmittingPatches

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