0001 NOTE:
0002 This is a version of Documentation/process/submitting-patches.rst into Japanese.
0003 This document is maintained by Keiichi KII <k-keiichi@bx.jp.nec.com>
0004 and the JF Project team <http://www.linux.or.jp/JF/>.
0005 If you find any difference between this document and the original file
0006 or a problem with the translation,
0007 please contact the maintainer of this file or JF project.
0008
0009 Please also note that the purpose of this file is to be easier to read
0010 for non English (read: Japanese) speakers and is not intended as a
0011 fork. So if you have any comments or updates of this file, please try
0012 to update the original English file first.
0013
0014 Last Updated: 2011/06/09
0015
0016 ==================================
0017 これは、
0018 linux-2.6.39/Documentation/process/submitting-patches.rst の和訳
0019 です。
0020 翻訳団体： JF プロジェクト < http://www.linux.or.jp/JF/ >
0021 翻訳日： 2011/06/09
0022 翻訳者： Keiichi Kii <k-keiichi at bx dot jp dot nec dot com>
0023 校正者： Masanari Kobayashi さん <zap03216 at nifty dot ne dot jp>
0024 Matsukura さん <nbh--mats at nifty dot com>
0025 Takeshi Hamasaki さん <hmatrjp at users dot sourceforge dot jp>
0026 ==================================
0027
0028 Linux カーネルに変更を加えるための Howto
0029 又は
0030 かの Linus Torvalds の取り扱い説明書
0031
0032 Linux カーネルに変更を加えたいと思っている個人又は会社にとって、パッ
0033 チの投稿に関連した仕組みに慣れていなければ、その過程は時々みなさんを
0034 おじけづかせることもあります。この文章はあなたの変更を大いに受け入れ
0035 てもらえやすくする提案を集めたものです。
0036
0037 コードを投稿する前に、Documentation/process/submit-checklist.rst の項目リストに目
0038 を通してチェックしてください。
0039
0040 --------------------------------------------
0041 セクション1 パッチの作り方と送り方
0042 --------------------------------------------
0043
0044 1) 「 diff -up 」
0045 ------------
0046
0047 パッチの作成には「 diff -up 」又は「 diff -uprN 」を使ってください。
0048
0049 Linux カーネルに対する全ての変更は diff(1) コマンドによるパッチの形式で
0050 生成してください。パッチを作成するときには、diff(1) コマンドに「 -u 」引
0051 数を指定して、unified 形式のパッチを作成することを確認してください。また、
0052 変更がどの C 関数で行われたのかを表示する「 -p 」引数を使ってください。
0053 この引数は生成した差分をずっと読みやすくしてくれます。パッチは Linux
0054 カーネルソースの中のサブディレクトリではなく Linux カーネルソースのルート
0055 ディレクトリを基準にしないといけません。
0056
0057 1個のファイルについてのパッチを作成するためには、ほとんどの場合、
0058 以下の作業を行えば十分です。
0059
0060 SRCTREE=linux-2.6
0061 MYFILE=drivers/net/mydriver.c
0062
0063 cd $SRCTREE
0064 cp $MYFILE $MYFILE.orig
0065 vi $MYFILE # make your change
0066 cd ..
0067 diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
0068
0069 複数のファイルについてのパッチを作成するためには、素の( vanilla )、す
0070 なわち変更を加えてない Linux カーネルを展開し、自分の Linux カーネル
0071 ソースとの差分を生成しないといけません。例えば、
0072
0073 MYSRC=/devel/linux-2.6
0074
0075 tar xvfz linux-2.6.12.tar.gz
0076 mv linux-2.6.12 linux-2.6.12-vanilla
0077 diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \
0078 linux-2.6.12-vanilla $MYSRC > /tmp/patch
0079
0080 dontdiff ファイルには Linux カーネルのビルドプロセスの過程で生成された
0081 ファイルの一覧がのっています。そして、それらはパッチを生成する diff(1)
0082 コマンドで無視されるべきです。dontdiff ファイルは 2.6.12 以後のバージョ
0083 ンの Linux カーネルソースツリーに含まれています。
0084
0085 投稿するパッチの中に関係のない余分なファイルが含まれていないことを確
0086 認してください。diff(1) コマンドで生成したパッチがあなたの意図したとお
0087 りのものであることを確認してください。
0088
0089 もしあなたのパッチが多くの差分を生み出すのであれば、あなたはパッチ
0090 を意味のあるひとまとまりごとに分けたいと思うかもしれません。
0091 これは他のカーネル開発者にとってレビューしやすくなるので、あなたの
0092 パッチを受け入れてもらうためにはとても重要なことです。これを補助でき
0093 る多くのスクリプトがあります。
0094
0095 Quilt:
0096 http://savannah.nongnu.org/projects/quilt
0097
0098 2) パッチに対する説明
0099
0100 パッチの中の変更点に対する技術的な詳細について説明してください。
0101
0102 説明はできる限り具体的に。もっとも悪い説明は「ドライバー X を更新」、
0103 「ドライバー X に対するバグフィックス」あるいは「このパッチはサブシス
0104 テム X に対する更新を含んでいます。どうか取り入れてください。」などです。
0105
0106 パッチの説明を Linux カーネルのソースコードマネジメントシステム「 git 」の
0107 コミットログとして簡単に引用できる形で書けば、メンテナから感謝されるでしょう。
0108 以下の #15 を見てください。
0109
0110 説明が長くなりだしたのであれば、おそらくそれはパッチを分ける必要がある
0111 という兆候です。次の #3 を見てください。
0112
0113 パッチ(シリーズ)を(再)投稿する時、十分なパッチの説明とそのパッチが必要な理由を
0114 パッチに含めてください。ただ「これはパッチ(シリーズ)のバージョン N」とだけ
0115 書かないでください。そして、パッチをマージする人にパッチの説明を探させそれを
0116 パッチに追記させるため、過去のバージョンのパッチやそのパッチの URL を参照する
0117 手間をかけさせないでください。
0118 つまり、パッチシリーズとその説明は一緒にあるべきです。これはパッチをマージする
0119 人、レビューする人、どちらのためにもなります。レビューする人の中には、おそらく
0120 過去のバージョンのパッチを受け取ってもいない人がいます。
0121
0122 登録済みのバグエントリを修正するパッチであれば、そのバグエントリを示すバグ ID
0123 や URL を明記してください。
0124
0125 特定のコミットを参照したい場合は、その SHA-1 ID だけでなく、一行サマリ
0126 も含めてください。それにより、それが何に関するコミットなのかがレビューする
0127 人にわかりやすくなります。
0128 例 (英文のママ):
0129
0130 Commit e21d2170f36602ae2708 ("video: remove unnecessary
0131 platform_set_drvdata()") removed the unnecessary
0132 platform_set_drvdata(), but left the variable "dev" unused,
0133 delete it.
0134
0135
0136 3) パッチの分割
0137
0138 意味のあるひとまとまりごとに変更を個々のパッチファイルに分けてください。
0139
0140 例えば、もし1つのドライバーに対するバグフィックスとパフォーマンス強
0141 化の両方の変更を含んでいるのであれば、その変更を2つ以上のパッチに分
0142 けてください。もし変更箇所に API の更新と、その新しい API を使う新たな
0143 ドライバーが含まれているなら、2つのパッチに分けてください。
0144
0145 一方で、もしあなたが多数のファイルに対して意味的に同じ1つの変更を加え
0146 るのであれば、その変更を1つのパッチにまとめてください。言いかえると、
0147 意味的に同じ1つの変更は1つのパッチの中に含まれます。
0148
0149 あるパッチが変更を完結させるために他のパッチに依存していたとしても、
0150 それは問題ありません。パッチの説明の中で「このパッチはパッチ X に依存
0151 している」と簡単に注意書きをつけてください。
0152
0153 もしパッチをより小さなパッチの集合に凝縮することができないなら、まずは
0154 15かそこらのパッチを送り、そのレビューと統合を待って下さい。
0155
0156 4) パッチのスタイルチェック
0157
0158 あなたのパッチが基本的な( Linux カーネルの)コーディングスタイルに違反し
0159 ていないかをチェックして下さい。その詳細を Documentation/process/coding-style.rst で
0160 見つけることができます。コーディングスタイルの違反はレビューする人の
0161 時間を無駄にするだけなので、恐らくあなたのパッチは読まれることすらなく
0162 拒否されるでしょう。
0163
0164 あなたはパッチを投稿する前に最低限パッチスタイルチェッカー
0165 ( scripts/checkpatch.pl )を利用してパッチをチェックすべきです。
0166 もしパッチに違反がのこっているならば、それらの全てについてあなたは正当な
0167 理由を示せるようにしておく必要があります。
0168
0169 5) 電子メールの宛先の選び方
0170
0171 MAINTAINERS ファイルとソースコードに目を通してください。そして、その変
0172 更がメンテナのいる特定のサブシステムに加えられるものであることが分か
0173 れば、その人に電子メールを送ってください。その際
0174 ./scripts/get_maintainers.pl のスクリプトが有用です。
0175
0176 もし、メンテナが載っていなかったり、メンテナからの応答がないなら、
0177 LKML ( linux-kernel@vger.kernel.org )へパッチを送ってください。ほとんど
0178 のカーネル開発者はこのメーリングリストに目を通しており、変更に対して
0179 コメントを得ることができます。
0180
0181 15個より多くのパッチを同時に vger.kernel.org のメーリングリストへ送らな
0182 いでください!!!
0183
0184 Linus Torvalds は Linux カーネルに入る全ての変更に対する最終的な意思決定者
0185 です。電子メールアドレスは torvalds@linux-foundation.org になります。彼は
0186 多くの電子メールを受け取っているため、できる限り彼に電子メールを送るのは
0187 避けるべきです。
0188
0189 バグフィックスであったり、自明な変更であったり、話し合いをほとんど
0190 必要としないパッチは Linus へ電子メールを送るか CC しなければなりません。
0191 話し合いを必要としたり、明確なアドバンテージがないパッチは、通常まず
0192 は LKML へ送られるべきです。パッチが議論された後にだけ、そのパッチを
0193 Linus へ送るべきです。
0194
0195 6) CC (カーボンコピー)先の選び方
0196
0197 特に理由がないなら、LKML にも CC してください。
0198
0199 Linus 以外のカーネル開発者は変更に気づく必要があり、その結果、彼らはそ
0200 の変更に対してコメントをくれたり、コードに対してレビューや提案をくれ
0201 るかもしれません。LKML とは Linux カーネル開発者にとって一番中心的なメー
0202 リングリストです。USB やフレームバッファデバイスや VFS や SCSI サブシステ
0203 ムなどの特定のサブシステムに関するメーリングリストもあります。あなた
0204 の変更に、はっきりと関連のあるメーリングリストについて知りたければ
0205 MAINTAINERS ファイルを参照してください。
0206
0207 VGER.KERNEL.ORG でホスティングされているメーリングリストの一覧が下記の
0208 サイトに載っています。
0209 <http://vger.kernel.org/vger-lists.html>
0210
0211 もし、変更がユーザランドのカーネルインタフェースに影響を与え
0212 るのであれば、MAN-PAGES のメンテナ( MAINTAINERS ファイルに一覧
0213 があります)に man ページのパッチを送ってください。少なくとも
0214 情報がマニュアルページの中に入ってくるように、変更が起きたという
0215 通知を送ってください。
0216
0217 たとえ、メンテナが #5 で反応がなかったとしても、メンテナのコードに変更を
0218 加えたときには、いつもメンテナに CC するのを忘れないようにしてください。
0219
0220
0221 7) MIME やリンクや圧縮ファイルや添付ファイルではなくプレインテキストのみ
0222
0223 Linus や他のカーネル開発者はあなたが投稿した変更を読んで、コメントでき
0224 る必要があります。カーネル開発者にとって、あなたが書いたコードの特定の
0225 部分にコメントをするために、標準的な電子メールクライアントで変更が引用
0226 できることは重要です。
0227
0228 上記の理由で、すべてのパッチは文中に含める形式の電子メールで投稿さ
0229 れるべきです。警告：あなたがパッチをコピー&ペーストする際には、パッ
0230 チを改悪するエディターの折り返し機能に注意してください。
0231
0232 パッチを圧縮の有無に関わらず MIME 形式で添付しないでください。多くのポ
0233 ピュラーな電子メールクライアントは MIME 形式の添付ファイルをプレーンテ
0234 キストとして送信するとは限らないでしょう。そうなると、電子メールクラ
0235 イアントがコードに対するコメントを付けることをできなくします。また、
0236 MIME 形式の添付ファイルは Linus に手間を取らせることになり、その変更を
0237 受け入れてもらう可能性が低くなってしまいます。
0238
0239 例外：お使いの電子メールクライアントがパッチをめちゃくちゃにするので
0240 あれば、誰かが MIME 形式のパッチを再送するよう求めるかもしれません。
0241
0242 余計な変更を加えずにあなたのパッチを送信するための電子メールクライアントの設定
0243 のヒントについては Documentation/process/email-clients.rst を参照してください。
0244
0245 8) 電子メールのサイズ
0246
0247 パッチを Linus へ送るときは常に #7 の手順に従ってください。
0248
0249 大きなパッチはメーリングリストやメンテナにとって不親切です。パッチが
0250 未圧縮で 300KB を超えるようであるなら、インターネット上のアクセス可能な
0251 サーバに保存し、保存場所を示す URL を伝えるほうが適切です。
0252
0253 9) カーネルバージョンの明記
0254
0255 パッチが対象とするカーネルのバージョンをパッチの概要か電子メールの
0256 サブジェクトに付けることが重要です。
0257
0258 パッチが最新バージョンのカーネルに正しく適用できなければ、Linus は
0259 そのパッチを採用しないでしょう。
0260
0261 10) がっかりせず再投稿
0262
0263 パッチを投稿した後は、辛抱強く待っていてください。Linus があなたのパッ
0264 チを気に入って採用すれば、Linus がリリースする次のバージョンのカーネル
0265 の中で姿を見せるでしょう。
0266
0267 しかし、パッチが次のバージョンのカーネルに入っていないなら、いくつもの
0268 理由があるのでしょう。その原因を絞り込み、間違っているものを正し、更新
0269 したパッチを投稿するのはあなたの仕事です。
0270
0271 Linus があなたのパッチに対して何のコメントもなく不採用にすることは極め
0272 て普通のことです。それは自然な姿です。もし、Linus があなたのパッチを受
0273 け取っていないのであれば、以下の理由が考えられます。
0274 * パッチが最新バージョンの Linux カーネルにきちんと適用できなかった
0275 * パッチが LKML で十分に議論されていなかった
0276 * スタイルの問題(セクション2を参照)
0277 * 電子メールフォーマットの問題(このセクションを参照)
0278 * パッチに対する技術的な問題
0279 * Linus はたくさんの電子メールを受け取っているので、どさくさに紛れて見
0280 失った
0281 * 不愉快にさせている
0282
0283 判断できない場合は、LKML にコメントを頼んでください。
0284
0285 11) サブジェクトに「 PATCH 」
0286
0287 Linus や LKML への大量の電子メールのために、サブジェクトのプレフィックスに
0288 「 [PATCH] 」を付けることが慣習となっています。これによって Linus や他の
0289 カーネル開発者がパッチであるのか、又は、他の議論に関する電子メールであるの
0290 かをより簡単に識別できます。
0291
0292 12) パッチへの署名
0293
0294 誰が何をしたのかを追いかけやすくするために (特に、パッチが何人かの
0295 メンテナを経て最終的に Linux カーネルに取り込まれる場合のために)、電子
0296 メールでやり取りされるパッチに対して「 sign-off 」という手続きを導入し
0297 ました。
0298
0299 「 sign-off 」とは、パッチがあなたの書いたものであるか、あるいは、
0300 あなたがそのパッチをオープンソースとして提供する権利を保持している、
0301 という証明をパッチの説明の末尾に一行記載するというものです。
0302 ルールはとても単純です。以下の項目を確認して下さい。
0303
0304 原作者の証明書( DCO ) 1.1
0305
0306 このプロジェクトに寄与するものとして、以下のことを証明する。
0307
0308 (a) 本寄与は私が全体又は一部作成したものであり、私がそのファイ
0309 ル中に明示されたオープンソースライセンスの下で公開する権利
0310 を持っている。もしくは、
0311
0312 (b) 本寄与は、私が知る限り、適切なオープンソースライセンスでカバ
0313 ーされている既存の作品を元にしている。同時に、私はそのライセ
0314 ンスの下で、私が全体又は一部作成した修正物を、ファイル中で示
0315 される同一のオープンソースライセンスで(異なるライセンスの下で
0316 投稿することが許可されている場合を除いて)投稿する権利を持って
0317 いる。もしくは、
0318
0319 (c) 本寄与は(a)、(b)、(c)を証明する第3者から私へ直接提供された
0320 ものであり、私はそれに変更を加えていない。
0321
0322 (d) 私はこのプロジェクトと本寄与が公のものであることに理解及び同意す
0323 る。同時に、関与した記録(投稿の際の全ての個人情報と sign-off を
0324 含む)が無期限に保全されることと、当該プロジェクト又は関連する
0325 オープンソースライセンスに沿った形で再配布されることに理解及び
0326 同意する。
0327
0328 もしこれに同意できるなら、以下のような1行を追加してください。
0329
0330 Signed-off-by: Random J Developer <random@developer.example.org>
0331
0332 実名を使ってください。(残念ですが、偽名や匿名による寄与はできません。)
0333
0334 人によっては sign-off の近くに追加のタグを付加しています。それらは今のところ
0335 無視されますが、あなたはそのタグを社内の手続きに利用したり、sign-off に特別
0336 な情報を示したりすることができます。
0337
0338 あなたがサブシステムまたはブランチのメンテナであれば、受け取ったパッチを自身の
0339 ツリーにマージするために、わずかに変更が必要となる場合があります。なぜなら
0340 あなたのツリーの中のコードと投稿者のツリーの中のコードは同一ではないためです。
0341 もし、あなたが厳密に上記ルール(c)にこだわるのであれば、投稿者に再度差分を
0342 とるよう依頼すべきです。しかし、これは時間とエネルギーを非生産的に浪費する
0343 ことになります。ルール(b)はあなたにコードを修正する権利を与えてくれます。
0344 しかし、投稿者のコードを修正し、その修正によるバグを投稿者に押し付けてしまう
0345 ことはとても失礼なことです。この問題を解決するために、末尾の投稿者の
0346 Signed-off-by とあなたがその末尾に追加する Signed-off-by の間に、修正を
0347 加えたことを示す1行を追加することが推奨されています。
0348 (その1行の書き方に)決まりはありませんが、大括弧の中に電子メールアドレスや氏名
0349 と修正内容を記載するやり方は目につきやすく、最終段階での変更の責任があなたに
0350 あることを明確にするのに十分な方法のようです。例えば、
0351
0352 Signed-off-by: Random J Developer <random@developer.example.org>
0353 [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h]
0354 Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org>
0355
0356 あなたが安定版のブランチを管理しており、作成者のクレジット、変更の追跡、
0357 修正のマージ、と同時に苦情からの投稿者の保護を行いたい場合、この慣習は特に
0358 有用となります。いかなる事情があってもチェンジログに出てくる作成者の
0359 アイデンティティ情報(From ヘッダ)は変更できないことに注意してください。
0360
0361 バックポートする人のための特別な注意事項。追跡を容易に行うために、コミット
0362 メッセージのトップ(サブジェクト行のすぐ後)にパッチの起源を示す情報を記述する
0363 ことは一般的で有用な慣習です。例えば、これは 2.6-stable ツリーでの一例です。
0364
0365 Date: Tue May 13 19:10:30 2008 +0000
0366
0367 SCSI: libiscsi regression in 2.6.25: fix nop timer handling
0368
0369 commit 4cf1043593db6a337f10e006c23c69e5fc93e722 upstream
0370
0371 そして、これは 2.4 ツリーでの一例です。
0372
0373 Date: Tue May 13 22:12:27 2008 +0200
0374
0375 wireless, airo: waitbusy() won't delay
0376
0377 [backport of 2.6 commit b7acbdfbd1f277c1eb23f344f899cfa4cd0bf36a]
0378
0379 どんな形式であれ、この情報はあなたのツリーを追跡する人やあなたのツリーのバグを
0380 解決しようとしている人にとって価値のある支援となります。
0381
0382 13) いつ Acked-by: と Cc: を使うのか
0383
0384 「 Signed-off-by: 」タグはその署名者がパッチの開発に関わっていたことやパッチ
0385 の伝播パスにいたことを示しています。
0386
0387 ある人が直接パッチの準備や作成に関わっていないけれど、その人のパッチに対す
0388 る承認を記録し、示したいとします。その場合、その人を示すのに Acked-by: が使
0389 えます。Acked-by: はパッチのチェンジログにも追加されます。
0390
0391 パッチの影響を受けるコードのメンテナがパッチに関わっていなかったり、パッチ
0392 の伝播パスにいなかった時にも、メンテナは Acked-by: をしばしば利用します。
0393
0394 Acked-by: は Signed-off-by: のように公式なタグではありません。それはメンテナが
0395 少なくともパッチをレビューし、同意を示しているという記録です。そのような
0396 ことからパッチをマージする人がメンテナの「うん、良いと思うよ」という発言を
0397 Acked-by: へ置き換えることがあります。
0398
0399 Acked-by: が必ずしもパッチ全体の承認を示しているわけではありません。例えば、
0400 あるパッチが複数のサブシステムへ影響を与えており、その中の1つのサブシステム
0401 のメンテナからの Acked-by: を持っているとします。その場合、Acked-by: は通常
0402 そのメンテナのコードに影響を与える一部分だけに対する承認を示しています。
0403 この点は、ご自分で判断してください。(その Acked-by: が)疑わしい場合は、
0404 メーリングリストアーカイブの中の大元の議論を参照すべきです。
0405
0406 パッチにコメントする機会を持っていたが、その時にコメントしなかった人がいれば、
0407 その人を指す「Cc:」タグを任意で追加してもかまいません。これは指定された人からの
0408 明確なアクションなしに付与できる唯一のタグです。
0409 このタグはパッチに関心があると思われる人達がそのパッチの議論に含まれていたこと
0410 を明文化します。
0411
0412 14) Reported-by:, Tested-by:, Reviewed-by: および Suggested-by: の利用
0413
0414 他の誰かによって報告された問題を修正するパッチであれば、問題報告者という寄与を
0415 クレジットするために、Reported-by: タグを追加することを検討してください。
0416 こまめにバグ報告者をクレジットしていくことで、うまくいけばその人たちが将来再び
0417 コミュニティの力となってくれるでしょう。
0418 ただし、報告者の許可無くこのタグを追加しないように注意してください。特に、
0419 問題が公の場で報告されていなかったのであれば。
0420
0421 Tested-by: タグはタグで指定された人によって(ある環境下で)パッチのテストに成功
0422 していることを示します。このタグはメンテナにテストが実施済みであることを
0423 知らせ、将来の関連パッチのテスト協力者を見つける方法を提供し、テスト実施者に
0424 対するクレジットを保証します。
0425
0426 Reviewed-by: タグは、それとは異なり、下記のレビューア宣言の下にレビューされ、
0427 受け入れ可能とみなされたパッチであることを示します。
0428
0429 レビューアによる監督宣言
0430
0431 私は Reviewed-by: タグを提示することによって、以下のことを明言する。
0432
0433 (a) 私はメインラインカーネルへの統合に向け、その妥当性及び「即応性
0434 (訳注)」を検証し、技術的側面からパッチをレビュー済みである。
0435
0436 訳注:
0437 「即応性」の原文は "readiness"。
0438 パッチが十分な品質を持っており、メインラインカーネルへの統合を即座に
0439 行うことができる状態であるかどうかを "readiness" という単語で表現
0440 している。
0441
0442 (b) パッチに関するあらゆる問題、懸念、あるいは、疑問は投稿者へ伝達済み
0443 である。私はそれらのコメントに対する投稿者の返答に満足している。
0444
0445 (c) 投稿に伴い改良されるコードがある一方で、現時点で、私は(1)それが
0446 カーネルにとって価値のある変更であること、そして、(2)統合に際して
0447 議論になり得るような問題はないものと確信している。
0448
0449 (d) 私はパッチをレビューし適切であると確信している一方で、あらゆる
0450 状況においてその宣言した目的や機能が正しく実現することに関して、
0451 いかなる保証もしない(特にどこかで明示しない限り)。
0452
0453 Reviewd-by タグはそのパッチがカーネルに対して適切な修正であって、深刻な技術的
0454 問題を残していないという意見の宣言です。興味のあるレビューアは誰でも(レビュー
0455 作業を終えたら)パッチに対して Reviewed-by タグを提示できます。このタグは
0456 レビューアの寄与をクレジットする働き、レビューの進捗の度合いをメンテナに
0457 知らせる働きを持ちます。そのパッチの領域に詳しく、そして、しっかりとした
0458 レビューを実施したレビューアによって提供される時、Reviewed-by: タグがあなたの
0459 パッチをカーネルにマージする可能性を高めるでしょう。
0460
0461 Suggested-by: タグは、パッチのアイデアがその人からの提案に基づくものである
0462 ことを示し、アイデアの提供をクレジットするものです。提案者の明示的な許可が
0463 ない場合、特にそのアイデアが公開のフォーラムで示されていない場合には、この
0464 タグをつけないように注意してください。とはいえ、アイデアの提供者をこつこつ
0465 クレジットしていけば、望むらくはその人たちが将来別の機会に再度力を貸す気に
0466 なってくれるかもしれません。
0467
0468 15) 標準的なパッチのフォーマット
0469
0470 標準的なパッチのサブジェクトは以下のとおりです。
0471
0472 Subject: [PATCH 001/123] subsystem: summary phrase
0473
0474 標準的なパッチの、電子メールのボディは以下の項目を含んでいます。
0475
0476 - パッチの作成者を明記する「 from 」行
0477
0478 - 空行
0479
0480 - 説明本体。これはこのパッチを説明するために無期限のチェンジログ
0481 (変更履歴)にコピーされます。
0482
0483 - 上述した「 Signed-off-by: 」行。これも説明本体と同じくチェン
0484 ジログ内にコピーされます。
0485
0486 - マーカー行は単純に「 --- 」です。
0487
0488 - 余計なコメントは、チェンジログには不適切です。
0489
0490 - 実際のパッチ(差分出力)
0491
0492 サブジェクト行のフォーマットは、アルファベット順で電子メールをとても
0493 ソートしやすいものになっています。(ほとんどの電子メールクライアント
0494 はソートをサポートしています)パッチのサブジェクトの連番は0詰めであ
0495 るため、数字でのソートとアルファベットでのソートは同じ結果になります。
0496
0497 電子メールのサブジェクト内のサブシステム表記は、パッチが適用される
0498 分野またはサブシステムを識別できるようにすべきです。
0499
0500 電子メールのサブジェクトの「summary phrase」はそのパッチの概要を正確
0501 に表現しなければなりません。「summary phrase」をファイル名にしてはい
0502 けません。パッチシリーズ中でそれぞれのパッチは同じ「summary phrase」を
0503 使ってはいけません(「パッチシリーズ」とは順序付けられた関連のある複数の
0504 パッチ群です)。
0505
0506 あなたの電子メールの「summary phrase」がそのパッチにとって世界で唯一の識別子に
0507 なるように心がけてください。「summary phrase」は git のチェンジログの中へ
0508 ずっと伝播していきます。「summary phrase」は、開発者が後でパッチを参照する
0509 ために議論の中で利用するかもしれません。
0510 人々はそのパッチに関連した議論を読むために「summary phrase」を使って google で
0511 検索したがるでしょう。それはまた2、3ヶ月あとで、人々が「gitk」や
0512 「git log --oneline」のようなツールを使用して何千ものパッチに目を通す時、
0513 唯一目にとまる情報となるでしょう。
0514
0515 これらの理由のため、「summary phrase」はなぜパッチが必要であるか、パッチが何を
0516 変更するかの2つの情報をせいぜい70〜75文字で表現していなければなりません。
0517 「summary phrase」は簡潔であり説明的である表現を目指しつつ、うまく
0518 まとめられている概要となるべきです。
0519
0520 「summary phrase」は「Subject: [PATCH tag] <summary phrase>」のように、
0521 大括弧で閉じられたタグを接頭辞として付加してもかまいません。このタグは
0522 「summary phrase」の一部とは考えませんが、パッチをどのように取り扱うべきかを
0523 表現します。
0524 一般的には「v1, v2, v3」のようなバージョン情報を表すタグ(過去のパッチに対する
0525 コメントを反映するために複数のバージョンのパッチが投稿されているのであれば)、
0526 「RFC」のようなコメントを要求するタグが挙げられます。パッチシリーズとして4つの
0527 パッチがあれば、個々のパッチに「1/4, 2/4, 3/4, 4/4」のように番号を付けても
0528 かまいません。これは開発者がパッチを適用する順番を確実に把握するためです。
0529 そして、開発者がパッチシリーズの中のすべてのパッチをもらさずレビュー或いは
0530 適用するのを保証するためです。
0531
0532 サブジェクトの例を二つ
0533
0534 Subject: [patch 2/5] ext2: improve scalability of bitmap searching
0535 Subject: [PATCHv2 001/207] x86: fix eflags tracking
0536
0537 「 from 」行は電子メールのボディの一番最初の行でなければなりません。
0538 その形式は以下のとおりです。
0539
0540 From: Original Author <author@example.com>
0541
0542 「 from 」行はチェンジログの中で、そのパッチの作成者としてクレジットされ
0543 ている人を特定するものです。「 from 」行がかけていると、電子メールのヘッ
0544 ダーの「 From: 」が、チェンジログの中でパッチの作成者を決定するために使わ
0545 れるでしょう。
0546
0547 説明本体は無期限のソースのチェンジログにコミットされます。なので、説明
0548 本体はそのパッチに至った議論の詳細を忘れているある程度の技量を持っている人
0549 がその詳細を思い出すことができるものでなければなりません。パッチが対処する
0550 障害の症状(カーネルログメッセージや oops メッセージ等)を記載することは問題に
0551 対処可能なパッチを求めてコミットログを検索する人々にとって特に有用です。
0552 パッチがコンパイル問題を解決するのであれば、そのパッチを探している人が見つける
0553 ことができる情報だけで十分であり、コンパイル時の全てのエラーを含める必要は
0554 ありません。「summary phrase」と同様に、簡潔であり説明的であることが重要です。
0555
0556 「 --- 」マーカー行はパッチ処理ツールに対して、チェンジログメッセージの終端
0557 部分を認識させるという重要な役目を果たします。
0558
0559 「 --- 」マーカー行の後の追加コメントの良い使用方法の1つに diffstat コマンド
0560 があります。diffstat コマンドとは何のファイルが変更され、1ファイル当たり何行
0561 追加され何行消されたかを示すものです。diffstat コマンドは特に大きなパッチに
0562 おいて役立ちます。その時点でだけ又はメンテナにとってのみ関係のあるコメント
0563 は無期限に保存されるチェンジログにとって適切ではありません。そのため、この
0564 ようなコメントもマーカー行の後に書かれるべきです。
0565 このようなコメントの良い例として、v1 と v2 のバージョン間で何が変更されたかを
0566 表す「パッチの変更履歴」が挙げられます。
0567
0568 「 --- 」マーカー行の後に diffstat コマンドの結果を含めるのであれば、ファイル
0569 名はカーネルソースツリーのトップディレクトリからの表記で列記されるため、横方向
0570 のスペースをとり過ぎないように、diffstat コマンドにオプション「 -p 1 -w 70 」
0571 を指定してください(インデントを含めてちょうど80列に合うでしょう)。
0572
0573 適切なパッチのフォーマットの詳細についてはセクション3の参考文献を参照して
0574 ください。
0575
0576 16) 「git pull」要求の送り方(Linus の電子メールから)
0577
0578 間違ったブランチから引っ張るのを防ぐために、git リポジトリのアドレスと
0579 ブランチ名を同じ行に1行で記載してください。そうすることで、3回の連続クリック
0580 で全て選択できます。
0581
0582 正しい形式は下記の通りです。
0583
0584 "Please pull from
0585
0586 git://jdelvare.pck.nerim.net/jdelvare-2.6 i2c-for-linus
0587
0588 to get these changes:"
0589
0590 その結果、アドレスを自分自身でタイピングして間違えることはなくなります(実際に、
0591 何度か間違ったブランチから引っ張ってきてしまい、その時に diffstat の結果を
0592 検証して間違っていることに気づいたことがあります。どこから何を引っ張るべきかを
0593 「探したり」、正しいブランチ名かどうかを重ねてチェックしたりする必要が
0594 なくなればより快適になるでしょう)。
0595
0596 diffstat の結果を生成するために「 git diff -M --stat --summary 」を使って
0597 ください。-M オプションはファイル名の変更を検知でき、--summary オプションは
0598 新規ファイル、削除されたファイル、名前が変更されたファイルの概要を生成します。
0599
0600 -M オプション(ファイル名の変更検知)を指定すると、diffstat の結果はかなり
0601 異なってきます。git は大規模な変更(追加と削除のペア)をファイル名の変更と
0602 判断するためです。
0603
0604 ------------------------------------
0605 セクション2 - ヒントとTIPSと小技
0606 ------------------------------------
0607
0608 このセクションは Linux カーネルに変更を適用することに関係のある一般的な
0609 「お約束」の多くを載せています。物事には例外というものがあります。しか
0610 し例外を適用するには、本当に妥当な理由が不可欠です。あなたは恐らくこの
0611 セクションを Linus のコンピュータ・サイエンス101と呼ぶでしょう。
0612
0613 1) Documentation/process/coding-style.rstを参照
0614
0615 言うまでもなく、あなたのコードがこのコーディングスタイルからあまりに
0616 も逸脱していると、レビューやコメントなしに受け取ってもらえないかもし
0617 れません。
0618
0619 特筆すべき例外は、コードをあるファイルから別のファイルに移動
0620 するときです。この場合、コードを移動するパッチでは、移動されるコード
0621 に関して移動以外の変更を一切加えるべきではありません。これにより、
0622 コードの移動とあなたが行ったコードの修正を明確に区別できるようにな
0623 ります。これは実際に何が変更されたかをレビューする際の大きな助けに
0624 なるとともに、ツールにコードの履歴を追跡させることも容易になります。
0625
0626 投稿するより前にパッチのスタイルチェッカー( scripts/checkpatch.pl )で
0627 あなたのパッチをチェックしてください。このスタイルチェッカーは最終結
0628 論としてではなく、指標としてみるべきです。もし、あなたのコードが違反
0629 はしているが修正するより良く見えるのであれば、おそらくそのままにする
0630 のがベストです。
0631
0632 スタイルチェッカーによる3段階のレポート:
0633 - エラー: 間違っている可能性が高い
0634 - 警告：注意してレビューする必要がある
0635 - チェック：考慮する必要がある
0636
0637 あなたはパッチに残っている全ての違反について、それがなぜ必要なのか正当な
0638 理由を示せるようにしておく必要があります。
0639
0640 2) #ifdefは見苦しい
0641
0642 ifdef が散乱したコードは、読むのもメンテナンスするのも面倒です。コードの中
0643 で ifdef を使わないでください。代わりに、ヘッダファイルの中に ifdef を入れて、
0644 条件付きで、コードの中で使われる関数を「 static inline 」関数かマクロで定義し
0645 てください。後はコンパイラが、何もしない箇所を最適化して取り去ってくれるで
0646 しょう。
0647
0648 まずいコードの簡単な例
0649
0650 dev = alloc_etherdev (sizeof(struct funky_private));
0651 if (!dev)
0652 return -ENODEV;
0653 #ifdef CONFIG_NET_FUNKINESS
0654 init_funky_net(dev);
0655 #endif
0656
0657 クリーンアップしたコードの例
0658
0659 (in header)
0660 #ifndef CONFIG_NET_FUNKINESS
0661 static inline void init_funky_net (struct net_device *d) {}
0662 #endif
0663
0664 (in the code itself)
0665 dev = alloc_etherdev (sizeof(struct funky_private));
0666 if (!dev)
0667 return -ENODEV;
0668 init_funky_net(dev);
0669
0670 3) マクロより「 static inline 」を推奨
0671
0672 「 static inline 」関数はマクロよりもずっと推奨されています。それらは、
0673 型安全性があり、長さにも制限が無く、フォーマットの制限もありません。
0674 gcc においては、マクロと同じくらい軽いです。
0675
0676 マクロは「 static inline 」が明らかに不適切であると分かる場所(高速化パスの
0677 いくつかの特定のケース)や「 static inline 」関数を使うことができないような
0678 場所(マクロの引数の文字列連結のような)にだけ使われるべきです。
0679
0680 「 static inline 」は「 static __inline__ 」や「 extern inline 」や
0681 「 extern __inline__ 」よりも適切です。
0682
0683 4) 設計に凝りすぎるな
0684
0685 それが有用になるかどうか分からないような不明瞭な将来を見越した設計
0686 をしないでください。「できる限り簡単に、そして、それ以上簡単になら
0687 ないような設計をしてください。」
0688
0689 ----------------------
0690 セクション3 参考文献
0691 ----------------------
0692
0693 Andrew Morton, "The perfect patch" (tpp).
0694 <http://www.ozlabs.org/~akpm/stuff/tpp.txt>
0695
0696 Jeff Garzik, "Linux kernel patch submission format".
0697 <https://web.archive.org/web/20180829112450/http://linux.yyz.us/patch-format.html>
0698
0699 Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
0700 <http://www.kroah.com/log/linux/maintainer.html>
0701 <http://www.kroah.com/log/linux/maintainer-02.html>
0702 <http://www.kroah.com/log/linux/maintainer-03.html>
0703 <http://www.kroah.com/log/linux/maintainer-04.html>
0704 <http://www.kroah.com/log/linux/maintainer-05.html>
0705
0706 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
0707 <https://lore.kernel.org/r/20050711.125305.08322243.davem@davemloft.net>
0708
0709 Kernel Documentation/process/coding-style.rst:
0710 <http://users.sosdg.org/~qiyong/lxr/source/Documentation/process/coding-style.rst>
0711
0712 Linus Torvalds's mail on the canonical patch format:
0713 <https://lore.kernel.org/r/Pine.LNX.4.58.0504071023190.28951@ppc970.osdl.org>
0714
0715 Andi Kleen, "On submitting kernel patches"
0716 Some strategies to get difficult or controversial changes in.
0717 http://halobates.de/on-submitting-patches.pdf
0718
0719 --
0720
0721
