About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / ja_JP / SubmittingPatches




Custom Search

Based on kernel version 3.15.4. Page generated on 2014-07-07 09:03 EST.

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

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.