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.
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.
14 Last Updated: 2011/06/09
16 ==================================
18 linux-2.6.39/Documentation/process/submitting-patches.rst の和訳
20 翻訳団体: JF プロジェクト < http://www.linux.or.jp/JF/ >
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 ==================================
28 Linux カーネルに変更を加えるための Howto
30 かの Linus Torvalds の取り扱い説明書
32 Linux カーネルに変更を加えたいと思っている個人又は会社にとって、パッ
33 チの投稿に関連した仕組みに慣れていなければ、その過程は時々みなさんを
34 おじけづかせることもあります。この文章はあなたの変更を大いに受け入れ
37 コードを投稿する前に、Documentation/process/submit-checklist.rst の項目リストに目
38 を通してチェックしてください。もしあなたがドライバーを投稿しようとし
39 ているなら、Documentation/process/submitting-drivers.rst にも目を通してください。
41 --------------------------------------------
43 --------------------------------------------
48 パッチの作成には「 diff -up 」又は「 diff -uprN 」を使ってください。
50 Linux カーネルに対する全ての変更は diff(1) コマンドによるパッチの形式で
51 生成してください。パッチを作成するときには、diff(1) コマンドに「 -u 」引
52 数を指定して、unified 形式のパッチを作成することを確認してください。また、
53 変更がどの C 関数で行われたのかを表示する「 -p 」引数を使ってください。
54 この引数は生成した差分をずっと読みやすくしてくれます。パッチは Linux
55 カーネルソースの中のサブディレクトリではなく Linux カーネルソースのルート
58 1個のファイルについてのパッチを作成するためには、ほとんどの場合、
62 MYFILE=drivers/net/mydriver.c
65 cp $MYFILE $MYFILE.orig
66 vi $MYFILE # make your change
68 diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
70 複数のファイルについてのパッチを作成するためには、素の( vanilla )、す
71 なわち変更を加えてない Linux カーネルを展開し、自分の Linux カーネル
72 ソースとの差分を生成しないといけません。例えば、
74 MYSRC=/devel/linux-2.6
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
81 dontdiff ファイルには Linux カーネルのビルドプロセスの過程で生成された
82 ファイルの一覧がのっています。そして、それらはパッチを生成する diff(1)
83 コマンドで無視されるべきです。dontdiff ファイルは 2.6.12 以後のバージョ
84 ンの Linux カーネルソースツリーに含まれています。
86 投稿するパッチの中に関係のない余分なファイルが含まれていないことを確
87 認してください。diff(1) コマンドで生成したパッチがあなたの意図したとお
90 もしあなたのパッチが多くの差分を生み出すのであれば、あなたはパッチ
91 を意味のあるひとまとまりごとに分けたいと思うかもしれません。
92 これは他のカーネル開発者にとってレビューしやすくなるので、あなたの
93 パッチを受け入れてもらうためにはとても重要なことです。これを補助でき
97 http://savannah.nongnu.org/projects/quilt
101 パッチの中の変更点に対する技術的な詳細について説明してください。
103 説明はできる限り具体的に。もっとも悪い説明は「ドライバー X を更新」、
104 「ドライバー X に対するバグフィックス」あるいは「このパッチはサブシス
105 テム X に対する更新を含んでいます。どうか取り入れてください。」などです。
107 パッチの説明を Linux カーネルのソースコードマネジメントシステム「 git 」の
108 コミットログとして簡単に引用できる形で書けば、メンテナから感謝されるでしょう。
111 説明が長くなりだしたのであれば、おそらくそれはパッチを分ける必要がある
112 という兆候です。次の #3 を見てください。
114 パッチ(シリーズ)を(再)投稿する時、十分なパッチの説明とそのパッチが必要な理由を
115 パッチに含めてください。ただ「これはパッチ(シリーズ)のバージョン N」とだけ
116 書かないでください。そして、パッチをマージする人にパッチの説明を探させそれを
117 パッチに追記させるため、過去のバージョンのパッチやそのパッチの URL を参照する
119 つまり、パッチシリーズとその説明は一緒にあるべきです。これはパッチをマージする
120 人、レビューする人、どちらのためにもなります。レビューする人の中には、おそらく
121 過去のバージョンのパッチを受け取ってもいない人がいます。
123 登録済みのバグエントリを修正するパッチであれば、そのバグエントリを示すバグ ID
126 特定のコミットを参照したい場合は、その SHA-1 ID だけでなく、一行サマリ
127 も含めてください。それにより、それが何に関するコミットなのかがレビューする
131 Commit e21d2170f36602ae2708 ("video: remove unnecessary
132 platform_set_drvdata()") removed the unnecessary
133 platform_set_drvdata(), but left the variable "dev" unused,
139 意味のあるひとまとまりごとに変更を個々のパッチファイルに分けてください。
141 例えば、もし1つのドライバーに対するバグフィックスとパフォーマンス強
142 化の両方の変更を含んでいるのであれば、その変更を2つ以上のパッチに分
143 けてください。もし変更箇所に API の更新と、その新しい API を使う新たな
144 ドライバーが含まれているなら、2つのパッチに分けてください。
146 一方で、もしあなたが多数のファイルに対して意味的に同じ1つの変更を加え
147 るのであれば、その変更を1つのパッチにまとめてください。言いかえると、
148 意味的に同じ1つの変更は1つのパッチの中に含まれます。
150 あるパッチが変更を完結させるために他のパッチに依存していたとしても、
151 それは問題ありません。パッチの説明の中で「このパッチはパッチ X に依存
152 している」と簡単に注意書きをつけてください。
154 もしパッチをより小さなパッチの集合に凝縮することができないなら、まずは
155 15かそこらのパッチを送り、そのレビューと統合を待って下さい。
159 あなたのパッチが基本的な( Linux カーネルの)コーディングスタイルに違反し
160 ていないかをチェックして下さい。その詳細を Documentation/process/coding-style.rst で
161 見つけることができます。コーディングスタイルの違反はレビューする人の
162 時間を無駄にするだけなので、恐らくあなたのパッチは読まれることすらなく
165 あなたはパッチを投稿する前に最低限パッチスタイルチェッカー
166 ( scripts/checkpatch.pl )を利用してパッチをチェックすべきです。
167 もしパッチに違反がのこっているならば、それらの全てについてあなたは正当な
168 理由を示せるようにしておく必要があります。
172 MAINTAINERS ファイルとソースコードに目を通してください。そして、その変
173 更がメンテナのいる特定のサブシステムに加えられるものであることが分か
174 れば、その人に電子メールを送ってください。その際
175 ./scripts/get_maintainers.pl のスクリプトが有用です。
177 もし、メンテナが載っていなかったり、メンテナからの応答がないなら、
178 LKML ( linux-kernel@vger.kernel.org )へパッチを送ってください。ほとんど
179 のカーネル開発者はこのメーリングリストに目を通しており、変更に対して
182 15個より多くのパッチを同時に vger.kernel.org のメーリングリストへ送らな
185 Linus Torvalds は Linux カーネルに入る全ての変更に対する最終的な意思決定者
186 です。電子メールアドレスは torvalds@linux-foundation.org になります。彼は
187 多くの電子メールを受け取っているため、できる限り彼に電子メールを送るのは
190 バグフィックスであったり、自明な変更であったり、話し合いをほとんど
191 必要としないパッチは Linus へ電子メールを送るか CC しなければなりません。
192 話し合いを必要としたり、明確なアドバンテージがないパッチは、通常まず
193 は LKML へ送られるべきです。パッチが議論された後にだけ、そのパッチを
198 特に理由がないなら、LKML にも CC してください。
200 Linus 以外のカーネル開発者は変更に気づく必要があり、その結果、彼らはそ
201 の変更に対してコメントをくれたり、コードに対してレビューや提案をくれ
202 るかもしれません。LKML とは Linux カーネル開発者にとって一番中心的なメー
203 リングリストです。USB やフレームバッファデバイスや VFS や SCSI サブシステ
204 ムなどの特定のサブシステムに関するメーリングリストもあります。あなた
205 の変更に、はっきりと関連のあるメーリングリストについて知りたければ
206 MAINTAINERS ファイルを参照してください。
208 VGER.KERNEL.ORG でホスティングされているメーリングリストの一覧が下記の
210 <http://vger.kernel.org/vger-lists.html>
212 もし、変更がユーザランドのカーネルインタフェースに影響を与え
213 るのであれば、MAN-PAGES のメンテナ( MAINTAINERS ファイルに一覧
214 があります)に man ページのパッチを送ってください。少なくとも
215 情報がマニュアルページの中に入ってくるように、変更が起きたという
218 たとえ、メンテナが #5 で反応がなかったとしても、メンテナのコードに変更を
219 加えたときには、いつもメンテナに CC するのを忘れないようにしてください。
222 7) MIME やリンクや圧縮ファイルや添付ファイルではなくプレインテキストのみ
224 Linus や他のカーネル開発者はあなたが投稿した変更を読んで、コメントでき
225 る必要があります。カーネル開発者にとって、あなたが書いたコードの特定の
226 部分にコメントをするために、標準的な電子メールクライアントで変更が引用
229 上記の理由で、すべてのパッチは文中に含める形式の電子メールで投稿さ
230 れるべきです。警告:あなたがパッチをコピー&ペーストする際には、パッ
231 チを改悪するエディターの折り返し機能に注意してください。
233 パッチを圧縮の有無に関わらず MIME 形式で添付しないでください。多くのポ
234 ピュラーな電子メールクライアントは MIME 形式の添付ファイルをプレーンテ
235 キストとして送信するとは限らないでしょう。そうなると、電子メールクラ
236 イアントがコードに対するコメントを付けることをできなくします。また、
237 MIME 形式の添付ファイルは Linus に手間を取らせることになり、その変更を
238 受け入れてもらう可能性が低くなってしまいます。
240 例外:お使いの電子メールクライアントがパッチをめちゃくちゃにするので
241 あれば、誰かが MIME 形式のパッチを再送するよう求めるかもしれません。
243 余計な変更を加えずにあなたのパッチを送信するための電子メールクライアントの設定
244 のヒントについては Documentation/process/email-clients.rst を参照してください。
248 パッチを Linus へ送るときは常に #7 の手順に従ってください。
250 大きなパッチはメーリングリストやメンテナにとって不親切です。パッチが
251 未圧縮で 300KB を超えるようであるなら、インターネット上のアクセス可能な
252 サーバに保存し、保存場所を示す URL を伝えるほうが適切です。
256 パッチが対象とするカーネルのバージョンをパッチの概要か電子メールの
259 パッチが最新バージョンのカーネルに正しく適用できなければ、Linus は
264 パッチを投稿した後は、辛抱強く待っていてください。Linus があなたのパッ
265 チを気に入って採用すれば、Linus がリリースする次のバージョンのカーネル
268 しかし、パッチが次のバージョンのカーネルに入っていないなら、いくつもの
269 理由があるのでしょう。その原因を絞り込み、間違っているものを正し、更新
270 したパッチを投稿するのはあなたの仕事です。
272 Linus があなたのパッチに対して何のコメントもなく不採用にすることは極め
273 て普通のことです。それは自然な姿です。もし、Linus があなたのパッチを受
274 け取っていないのであれば、以下の理由が考えられます。
275 * パッチが最新バージョンの Linux カーネルにきちんと適用できなかった
276 * パッチが LKML で十分に議論されていなかった
278 * 電子メールフォーマットの問題(このセクションを参照)
280 * Linus はたくさんの電子メールを受け取っているので、どさくさに紛れて見
284 判断できない場合は、LKML にコメントを頼んでください。
288 Linus や LKML への大量の電子メールのために、サブジェクトのプレフィックスに
289 「 [PATCH] 」を付けることが慣習となっています。これによって Linus や他の
290 カーネル開発者がパッチであるのか、又は、他の議論に関する電子メールであるの
295 誰が何をしたのかを追いかけやすくするために (特に、パッチが何人かの
296 メンテナを経て最終的に Linux カーネルに取り込まれる場合のために)、電子
297 メールでやり取りされるパッチに対して「 sign-off 」という手続きを導入し
300 「 sign-off 」とは、パッチがあなたの書いたものであるか、あるいは、
301 あなたがそのパッチをオープンソースとして提供する権利を保持している、
302 という証明をパッチの説明の末尾に一行記載するというものです。
303 ルールはとても単純です。以下の項目を確認して下さい。
307 このプロジェクトに寄与するものとして、以下のことを証明する。
309 (a) 本寄与は私が全体又は一部作成したものであり、私がそのファイ
310 ル中に明示されたオープンソースライセンスの下で公開する権利
313 (b) 本寄与は、私が知る限り、適切なオープンソースライセンスでカバ
314 ーされている既存の作品を元にしている。同時に、私はそのライセ
315 ンスの下で、私が全体又は一部作成した修正物を、ファイル中で示
316 される同一のオープンソースライセンスで(異なるライセンスの下で
317 投稿することが許可されている場合を除いて)投稿する権利を持って
320 (c) 本寄与は(a)、(b)、(c)を証明する第3者から私へ直接提供された
321 ものであり、私はそれに変更を加えていない。
323 (d) 私はこのプロジェクトと本寄与が公のものであることに理解及び同意す
324 る。同時に、関与した記録(投稿の際の全ての個人情報と sign-off を
325 含む)が無期限に保全されることと、当該プロジェクト又は関連する
326 オープンソースライセンスに沿った形で再配布されることに理解及び
329 もしこれに同意できるなら、以下のような1行を追加してください。
331 Signed-off-by: Random J Developer <random@developer.example.org>
333 実名を使ってください。(残念ですが、偽名や匿名による寄与はできません。)
335 人によっては sign-off の近くに追加のタグを付加しています。それらは今のところ
336 無視されますが、あなたはそのタグを社内の手続きに利用したり、sign-off に特別
339 あなたがサブシステムまたはブランチのメンテナであれば、受け取ったパッチを自身の
340 ツリーにマージするために、わずかに変更が必要となる場合があります。なぜなら
341 あなたのツリーの中のコードと投稿者のツリーの中のコードは同一ではないためです。
342 もし、あなたが厳密に上記ルール(c)にこだわるのであれば、投稿者に再度差分を
343 とるよう依頼すべきです。しかし、これは時間とエネルギーを非生産的に浪費する
344 ことになります。ルール(b)はあなたにコードを修正する権利を与えてくれます。
345 しかし、投稿者のコードを修正し、その修正によるバグを投稿者に押し付けてしまう
346 ことはとても失礼なことです。この問題を解決するために、末尾の投稿者の
347 Signed-off-by とあなたがその末尾に追加する Signed-off-by の間に、修正を
348 加えたことを示す1行を追加することが推奨されています。
349 (その1行の書き方に)決まりはありませんが、大括弧の中に電子メールアドレスや氏名
350 と修正内容を記載するやり方は目につきやすく、最終段階での変更の責任があなたに
351 あることを明確にするのに十分な方法のようです。例えば、
353 Signed-off-by: Random J Developer <random@developer.example.org>
354 [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h]
355 Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org>
357 あなたが安定版のブランチを管理しており、作成者のクレジット、変更の追跡、
358 修正のマージ、と同時に苦情からの投稿者の保護を行いたい場合、この慣習は特に
359 有用となります。いかなる事情があってもチェンジログに出てくる作成者の
360 アイデンティティ情報(From ヘッダ)は変更できないことに注意してください。
362 バックポートする人のための特別な注意事項。追跡を容易に行うために、コミット
363 メッセージのトップ(サブジェクト行のすぐ後)にパッチの起源を示す情報を記述する
364 ことは一般的で有用な慣習です。例えば、これは 2.6-stable ツリーでの一例です。
366 Date: Tue May 13 19:10:30 2008 +0000
368 SCSI: libiscsi regression in 2.6.25: fix nop timer handling
370 commit 4cf1043593db6a337f10e006c23c69e5fc93e722 upstream
372 そして、これは 2.4 ツリーでの一例です。
374 Date: Tue May 13 22:12:27 2008 +0200
376 wireless, airo: waitbusy() won't delay
378 [backport of 2.6 commit b7acbdfbd1f277c1eb23f344f899cfa4cd0bf36a]
380 どんな形式であれ、この情報はあなたのツリーを追跡する人やあなたのツリーのバグを
381 解決しようとしている人にとって価値のある支援となります。
383 13) いつ Acked-by: と Cc: を使うのか
385 「 Signed-off-by: 」タグはその署名者がパッチの開発に関わっていたことやパッチ
388 ある人が直接パッチの準備や作成に関わっていないけれど、その人のパッチに対す
389 る承認を記録し、示したいとします。その場合、その人を示すのに Acked-by: が使
390 えます。Acked-by: はパッチのチェンジログにも追加されます。
392 パッチの影響を受けるコードのメンテナがパッチに関わっていなかったり、パッチ
393 の伝播パスにいなかった時にも、メンテナは Acked-by: をしばしば利用します。
395 Acked-by: は Signed-off-by: のように公式なタグではありません。それはメンテナが
396 少なくともパッチをレビューし、同意を示しているという記録です。そのような
397 ことからパッチをマージする人がメンテナの「うん、良いと思うよ」という発言を
398 Acked-by: へ置き換えることがあります。
400 Acked-by: が必ずしもパッチ全体の承認を示しているわけではありません。例えば、
401 あるパッチが複数のサブシステムへ影響を与えており、その中の1つのサブシステム
402 のメンテナからの Acked-by: を持っているとします。その場合、Acked-by: は通常
403 そのメンテナのコードに影響を与える一部分だけに対する承認を示しています。
404 この点は、ご自分で判断してください。(その Acked-by: が)疑わしい場合は、
405 メーリングリストアーカイブの中の大元の議論を参照すべきです。
407 パッチにコメントする機会を持っていたが、その時にコメントしなかった人がいれば、
408 その人を指す「Cc:」タグを任意で追加してもかまいません。これは指定された人からの
409 明確なアクションなしに付与できる唯一のタグです。
410 このタグはパッチに関心があると思われる人達がそのパッチの議論に含まれていたこと
413 14) Reported-by:, Tested-by:, Reviewed-by: および Suggested-by: の利用
415 他の誰かによって報告された問題を修正するパッチであれば、問題報告者という寄与を
416 クレジットするために、Reported-by: タグを追加することを検討してください。
417 こまめにバグ報告者をクレジットしていくことで、うまくいけばその人たちが将来再び
419 ただし、報告者の許可無くこのタグを追加しないように注意してください。特に、
420 問題が公の場で報告されていなかったのであれば。
422 Tested-by: タグはタグで指定された人によって(ある環境下で)パッチのテストに成功
423 していることを示します。このタグはメンテナにテストが実施済みであることを
424 知らせ、将来の関連パッチのテスト協力者を見つける方法を提供し、テスト実施者に
427 Reviewed-by: タグは、それとは異なり、下記のレビューア宣言の下にレビューされ、
428 受け入れ可能とみなされたパッチであることを示します。
432 私は Reviewed-by: タグを提示することによって、以下のことを明言する。
434 (a) 私はメインラインカーネルへの統合に向け、その妥当性及び「即応性
435 (訳注)」を検証し、技術的側面からパッチをレビュー済みである。
438 「即応性」の原文は "readiness"。
439 パッチが十分な品質を持っており、メインラインカーネルへの統合を即座に
440 行うことができる状態であるかどうかを "readiness" という単語で表現
443 (b) パッチに関するあらゆる問題、懸念、あるいは、疑問は投稿者へ伝達済み
444 である。私はそれらのコメントに対する投稿者の返答に満足している。
446 (c) 投稿に伴い改良されるコードがある一方で、現時点で、私は(1)それが
447 カーネルにとって価値のある変更であること、そして、(2)統合に際して
448 議論になり得るような問題はないものと確信している。
450 (d) 私はパッチをレビューし適切であると確信している一方で、あらゆる
451 状況においてその宣言した目的や機能が正しく実現することに関して、
452 いかなる保証もしない(特にどこかで明示しない限り)。
454 Reviewd-by タグはそのパッチがカーネルに対して適切な修正であって、深刻な技術的
455 問題を残していないという意見の宣言です。興味のあるレビューアは誰でも(レビュー
456 作業を終えたら)パッチに対して Reviewed-by タグを提示できます。このタグは
457 レビューアの寄与をクレジットする働き、レビューの進捗の度合いをメンテナに
458 知らせる働きを持ちます。そのパッチの領域に詳しく、そして、しっかりとした
459 レビューを実施したレビューアによって提供される時、Reviewed-by: タグがあなたの
460 パッチをカーネルにマージする可能性を高めるでしょう。
462 Suggested-by: タグは、パッチのアイデアがその人からの提案に基づくものである
463 ことを示し、アイデアの提供をクレジットするものです。提案者の明示的な許可が
464 ない場合、特にそのアイデアが公開のフォーラムで示されていない場合には、この
465 タグをつけないように注意してください。とはいえ、アイデアの提供者をこつこつ
466 クレジットしていけば、望むらくはその人たちが将来別の機会に再度力を貸す気に
471 標準的なパッチのサブジェクトは以下のとおりです。
473 Subject: [PATCH 001/123] subsystem: summary phrase
475 標準的なパッチの、電子メールのボディは以下の項目を含んでいます。
477 - パッチの作成者を明記する「 from 」行
481 - 説明本体。これはこのパッチを説明するために無期限のチェンジログ
484 - 上述した「 Signed-off-by: 」行。これも説明本体と同じくチェン
487 - マーカー行は単純に「 --- 」です。
489 - 余計なコメントは、チェンジログには不適切です。
493 サブジェクト行のフォーマットは、アルファベット順で電子メールをとても
494 ソートしやすいものになっています。(ほとんどの電子メールクライアント
495 はソートをサポートしています)パッチのサブジェクトの連番は0詰めであ
496 るため、数字でのソートとアルファベットでのソートは同じ結果になります。
498 電子メールのサブジェクト内のサブシステム表記は、パッチが適用される
499 分野またはサブシステムを識別できるようにすべきです。
501 電子メールのサブジェクトの「summary phrase」はそのパッチの概要を正確
502 に表現しなければなりません。「summary phrase」をファイル名にしてはい
503 けません。パッチシリーズ中でそれぞれのパッチは同じ「summary phrase」を
504 使ってはいけません(「パッチシリーズ」とは順序付けられた関連のある複数の
507 あなたの電子メールの「summary phrase」がそのパッチにとって世界で唯一の識別子に
508 なるように心がけてください。「summary phrase」は git のチェンジログの中へ
509 ずっと伝播していきます。「summary phrase」は、開発者が後でパッチを参照する
511 人々はそのパッチに関連した議論を読むために「summary phrase」を使って google で
512 検索したがるでしょう。それはまた2、3ヶ月あとで、人々が「gitk」や
513 「git log --oneline」のようなツールを使用して何千ものパッチに目を通す時、
516 これらの理由のため、「summary phrase」はなぜパッチが必要であるか、パッチが何を
517 変更するかの2つの情報をせいぜい70〜75文字で表現していなければなりません。
518 「summary phrase」は簡潔であり説明的である表現を目指しつつ、うまく
521 「summary phrase」は「Subject: [PATCH tag] <summary phrase>」のように、
522 大括弧で閉じられたタグを接頭辞として付加してもかまいません。このタグは
523 「summary phrase」の一部とは考えませんが、パッチをどのように取り扱うべきかを
525 一般的には「v1, v2, v3」のようなバージョン情報を表すタグ(過去のパッチに対する
526 コメントを反映するために複数のバージョンのパッチが投稿されているのであれば)、
527 「RFC」のようなコメントを要求するタグが挙げられます。パッチシリーズとして4つの
528 パッチがあれば、個々のパッチに「1/4, 2/4, 3/4, 4/4」のように番号を付けても
529 かまいません。これは開発者がパッチを適用する順番を確実に把握するためです。
530 そして、開発者がパッチシリーズの中のすべてのパッチをもらさずレビュー或いは
535 Subject: [patch 2/5] ext2: improve scalability of bitmap searching
536 Subject: [PATCHv2 001/207] x86: fix eflags tracking
538 「 from 」行は電子メールのボディの一番最初の行でなければなりません。
541 From: Original Author <author@example.com>
543 「 from 」行はチェンジログの中で、そのパッチの作成者としてクレジットされ
544 ている人を特定するものです。「 from 」行がかけていると、電子メールのヘッ
545 ダーの「 From: 」が、チェンジログの中でパッチの作成者を決定するために使わ
548 説明本体は無期限のソースのチェンジログにコミットされます。なので、説明
549 本体はそのパッチに至った議論の詳細を忘れているある程度の技量を持っている人
550 がその詳細を思い出すことができるものでなければなりません。パッチが対処する
551 障害の症状(カーネルログメッセージや oops メッセージ等)を記載することは問題に
552 対処可能なパッチを求めてコミットログを検索する人々にとって特に有用です。
553 パッチがコンパイル問題を解決するのであれば、そのパッチを探している人が見つける
554 ことができる情報だけで十分であり、コンパイル時の全てのエラーを含める必要は
555 ありません。「summary phrase」と同様に、簡潔であり説明的であることが重要です。
557 「 --- 」マーカー行はパッチ処理ツールに対して、チェンジログメッセージの終端
558 部分を認識させるという重要な役目を果たします。
560 「 --- 」マーカー行の後の追加コメントの良い使用方法の1つに diffstat コマンド
561 があります。diffstat コマンドとは何のファイルが変更され、1ファイル当たり何行
562 追加され何行消されたかを示すものです。diffstat コマンドは特に大きなパッチに
563 おいて役立ちます。その時点でだけ又はメンテナにとってのみ関係のあるコメント
564 は無期限に保存されるチェンジログにとって適切ではありません。そのため、この
565 ようなコメントもマーカー行の後に書かれるべきです。
566 このようなコメントの良い例として、v1 と v2 のバージョン間で何が変更されたかを
569 「 --- 」マーカー行の後に diffstat コマンドの結果を含めるのであれば、ファイル
570 名はカーネルソースツリーのトップディレクトリからの表記で列記されるため、横方向
571 のスペースをとり過ぎないように、diffstat コマンドにオプション「 -p 1 -w 70 」
572 を指定してください(インデントを含めてちょうど80列に合うでしょう)。
574 適切なパッチのフォーマットの詳細についてはセクション3の参考文献を参照して
577 16) 「git pull」要求の送り方(Linus の電子メールから)
579 間違ったブランチから引っ張るのを防ぐために、git リポジトリのアドレスと
580 ブランチ名を同じ行に1行で記載してください。そうすることで、3回の連続クリック
587 git://jdelvare.pck.nerim.net/jdelvare-2.6 i2c-for-linus
589 to get these changes:"
591 その結果、アドレスを自分自身でタイピングして間違えることはなくなります(実際に、
592 何度か間違ったブランチから引っ張ってきてしまい、その時に diffstat の結果を
593 検証して間違っていることに気づいたことがあります。どこから何を引っ張るべきかを
594 「探したり」、正しいブランチ名かどうかを重ねてチェックしたりする必要が
597 diffstat の結果を生成するために「 git diff -M --stat --summary 」を使って
598 ください。-M オプションはファイル名の変更を検知でき、--summary オプションは
599 新規ファイル、削除されたファイル、名前が変更されたファイルの概要を生成します。
601 -M オプション(ファイル名の変更検知)を指定すると、diffstat の結果はかなり
602 異なってきます。git は大規模な変更(追加と削除のペア)をファイル名の変更と
605 ------------------------------------
607 ------------------------------------
609 このセクションは Linux カーネルに変更を適用することに関係のある一般的な
610 「お約束」の多くを載せています。物事には例外というものがあります。しか
611 し例外を適用するには、本当に妥当な理由が不可欠です。あなたは恐らくこの
612 セクションを Linus のコンピュータ・サイエンス101と呼ぶでしょう。
614 1) Documentation/process/coding-style.rstを参照
616 言うまでもなく、あなたのコードがこのコーディングスタイルからあまりに
617 も逸脱していると、レビューやコメントなしに受け取ってもらえないかもし
620 特筆すべき例外は、コードをあるファイルから別のファイルに移動
621 するときです。この場合、コードを移動するパッチでは、移動されるコード
622 に関して移動以外の変更を一切加えるべきではありません。これにより、
623 コードの移動とあなたが行ったコードの修正を明確に区別できるようにな
624 ります。これは実際に何が変更されたかをレビューする際の大きな助けに
625 なるとともに、ツールにコードの履歴を追跡させることも容易になります。
627 投稿するより前にパッチのスタイルチェッカー( scripts/checkpatch.pl )で
628 あなたのパッチをチェックしてください。このスタイルチェッカーは最終結
629 論としてではなく、指標としてみるべきです。もし、あなたのコードが違反
630 はしているが修正するより良く見えるのであれば、おそらくそのままにする
633 スタイルチェッカーによる3段階のレポート:
638 あなたはパッチに残っている全ての違反について、それがなぜ必要なのか正当な
639 理由を示せるようにしておく必要があります。
643 ifdef が散乱したコードは、読むのもメンテナンスするのも面倒です。コードの中
644 で ifdef を使わないでください。代わりに、ヘッダファイルの中に ifdef を入れて、
645 条件付きで、コードの中で使われる関数を「 static inline 」関数かマクロで定義し
646 てください。後はコンパイラが、何もしない箇所を最適化して取り去ってくれるで
651 dev = alloc_etherdev (sizeof(struct funky_private));
654 #ifdef CONFIG_NET_FUNKINESS
661 #ifndef CONFIG_NET_FUNKINESS
662 static inline void init_funky_net (struct net_device *d) {}
666 dev = alloc_etherdev (sizeof(struct funky_private));
671 3) マクロより「 static inline 」を推奨
673 「 static inline 」関数はマクロよりもずっと推奨されています。それらは、
674 型安全性があり、長さにも制限が無く、フォーマットの制限もありません。
675 gcc においては、マクロと同じくらい軽いです。
677 マクロは「 static inline 」が明らかに不適切であると分かる場所(高速化パスの
678 いくつかの特定のケース)や「 static inline 」関数を使うことができないような
679 場所(マクロの引数の文字列連結のような)にだけ使われるべきです。
681 「 static inline 」は「 static __inline__ 」や「 extern inline 」や
682 「 extern __inline__ 」よりも適切です。
686 それが有用になるかどうか分からないような不明瞭な将来を見越した設計
687 をしないでください。「できる限り簡単に、そして、それ以上簡単になら
690 ----------------------
692 ----------------------
694 Andrew Morton, "The perfect patch" (tpp).
695 <http://www.ozlabs.org/~akpm/stuff/tpp.txt>
697 Jeff Garzik, "Linux kernel patch submission format".
698 <https://web.archive.org/web/20180829112450/http://linux.yyz.us/patch-format.html>
700 Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
701 <http://www.kroah.com/log/linux/maintainer.html>
702 <http://www.kroah.com/log/linux/maintainer-02.html>
703 <http://www.kroah.com/log/linux/maintainer-03.html>
704 <http://www.kroah.com/log/linux/maintainer-04.html>
705 <http://www.kroah.com/log/linux/maintainer-05.html>
707 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
708 <https://lore.kernel.org/r/20050711.125305.08322243.davem@davemloft.net>
710 Kernel Documentation/process/coding-style.rst:
711 <http://users.sosdg.org/~qiyong/lxr/source/Documentation/process/coding-style.rst>
713 Linus Torvalds's mail on the canonical patch format:
714 <https://lore.kernel.org/r/Pine.LNX.4.58.0504071023190.28951@ppc970.osdl.org>
716 Andi Kleen, "On submitting kernel patches"
717 Some strategies to get difficult or controversial changes in.
718 http://halobates.de/on-submitting-patches.pdf