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