About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / ja_JP / SubmittingPatches

Based on kernel version 2.6.26. Page generated on 2008-07-16 21:13 EST.

1	NOTE:
2	This is a version of Documentation/SubmittingPatches into Japanese.
3	This document is maintained by Keiichi KII <k-keiichi[AT]bx.jp.nec[DOT]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: 2007/10/24
15	==================================
16	これは、
17	linux-2.6.23/Documentation/SubmittingPatches の和訳
18	です。
19	翻訳団体： JF プロジェクト < http://www.linux.or.jp/JF/ >
20	翻訳日： 2007/10/17
21	翻訳者： Keiichi Kii <k-keiichi at bx dot jp dot nec dot com>
22	校正者： Masanari Kobayashi さん <zap03216 at nifty dot ne dot jp>
23	         Matsukura さん <nbh--mats at nifty dot com>
24	==================================
25	
26	        Linux カーネルに変更を加えるための Howto
27	        又は
28	        かの Linus Torvalds の取り扱い説明書
29	
30	Linux カーネルに変更を加えたいと思っている個人又は会社にとって、パッ
31	チの投稿に関連した仕組みに慣れていなければ、その過程は時々みなさんを
32	おじけづかせることもあります。この文章はあなたの変更を大いに受け入れ
33	てもらえやすくする提案を集めたものです。
34	
35	コードを投稿する前に、Documentation/SubmitChecklist の項目リストに目
36	を通してチェックしてください。もしあなたがドライバーを投稿しようとし
37	ているなら、Documentation/SubmittingDrivers にも目を通してください。
38	
39	--------------------------------------------
40	セクション1 パッチの作り方と送り方
41	--------------------------------------------
42	
43	1) 「 diff -up 」
44	------------
45	
46	パッチの作成には「 diff -up 」又は「 diff -uprN 」を使ってください。
47	
48	Linux カーネルに対する全ての変更は diff(1) コマンドによるパッチの形式で
49	生成してください。パッチを作成するときには、diff(1) コマンドに「 -u 」引
50	数を指定して、unified 形式のパッチを作成することを確認してください。また、
51	変更がどの C 関数で行われたのかを表示する「 -p 」引数を使ってください。
52	この引数は生成した差分をずっと読みやすくしてくれます。パッチは Linux
53	カーネルソースの中のサブディレクトリではなく Linux カーネルソースのルート
54	ディレクトリを基準にしないといけません。
55	
56	1個のファイルについてのパッチを作成するためには、ほとんどの場合、
57	以下の作業を行えば十分です。
58	
59		SRCTREE= linux-2.6
60		MYFILE=  drivers/net/mydriver.c
61	
62		cd $SRCTREE
63		cp $MYFILE $MYFILE.orig
64		vi $MYFILE	# make your change
65		cd ..
66		diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
67	
68	複数のファイルについてのパッチを作成するためには、素の( vanilla )、す
69	なわち変更を加えてない Linux カーネルを展開し、自分の Linux カーネル
70	ソースとの差分を生成しないといけません。例えば、
71	
72		MYSRC= /devel/linux-2.6
73	
74		tar xvfz linux-2.6.12.tar.gz
75		mv linux-2.6.12 linux-2.6.12-vanilla
76		diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \
77			linux-2.6.12-vanilla $MYSRC > /tmp/patch
78	
79	dontdiff ファイルには Linux カーネルのビルドプロセスの過程で生成された
80	ファイルの一覧がのっています。そして、それらはパッチを生成する diff(1)
81	コマンドで無視されるべきです。dontdiff ファイルは 2.6.12 以後のバージョ
82	ンの Linux カーネルソースツリーに含まれています。それより前のバージョン
83	の Linux カーネルソースツリーに対する dontdiff ファイルは、
84	<http://www.xenotime.net/linux/doc/dontdiff>から取得することができます。
85	
86	投稿するパッチの中に関係のない余分なファイルが含まれていないことを確
87	認してください。diff(1) コマンドで生成したパッチがあなたの意図したとお
88	りのものであることを確認してください。
89	
90	もしあなたのパッチが多くの差分を生み出すのであれば、あなたはパッチ
91	を意味のあるひとまとまりごとに分けたいと思うかもしれません。
92	これは他のカーネル開発者にとってレビューしやすくなるので、あなたの
93	パッチを受け入れてもらうためにはとても重要なことです。これを補助でき
94	る多くのスクリプトがあります。
95	
96	Quilt:
97	http://savannah.nongnu.org/projects/quilt
98	
99	Andrew Morton's patch scripts:
100	http://www.zip.com.au/~akpm/linux/patches/
101	このリンクの先のスクリプトの代わりとして、quilt がパッチマネジメント
102	ツールとして推奨されています(上のリンクを見てください)。
103	
104	2) パッチに対する説明
105	
106	パッチの中の変更点に対する技術的な詳細について説明してください。
107	
108	説明はできる限り具体的に。もっとも悪い説明は「ドライバー X を更新」、
109	「ドライバー X に対するバグフィックス」あるいは「このパッチはサブシス
110	テム X に対する更新を含んでいます。どうか取り入れてください。」などです。
111	
112	説明が長くなりだしたのであれば、おそらくそれはパッチを分ける必要がある
113	という兆候です。次の #3 を見てください。
114	
115	3) パッチの分割
116	
117	意味のあるひとまとまりごとに変更を個々のパッチファイルに分けてください。
118	
119	例えば、もし1つのドライバーに対するバグフィックスとパフォーマンス強
120	化の両方の変更を含んでいるのであれば、その変更を2つ以上のパッチに分
121	けてください。もし変更箇所に API の更新と、その新しい API を使う新たな
122	ドライバーが含まれているなら、2つのパッチに分けてください。
123	
124	一方で、もしあなたが多数のファイルに対して意味的に同じ1つの変更を加え
125	るのであれば、その変更を1つのパッチにまとめてください。言いかえると、
126	意味的に同じ1つの変更は1つのパッチの中に含まれます。
127	
128	あるパッチが変更を完結させるために他のパッチに依存していたとしても、
129	それは問題ありません。パッチの説明の中で「このパッチはパッチ X に依存
130	している」と簡単に注意書きをつけてください。
131	
132	もしパッチをより小さなパッチの集合に凝縮することができないなら、まずは
133	15かそこらのパッチを送り、そのレビューと統合を待って下さい。
134	
135	4) パッチのスタイルチェック
136	
137	あなたのパッチが基本的な( Linux カーネルの)コーディングスタイルに違反し
138	ていないかをチェックして下さい。その詳細を Documentation/CodingStyle で
139	見つけることができます。コーディングスタイルの違反はレビューする人の
140	時間を無駄にするだけなので、恐らくあなたのパッチは読まれることすらなく
141	拒否されるでしょう。
142	
143	あなたはパッチを投稿する前に最低限パッチスタイルチェッカー
144	( scripts/patchcheck.pl )を利用してパッチをチェックすべきです。
145	もしパッチに違反がのこっているならば、それらの全てについてあなたは正当な
146	理由を示せるようにしておく必要があります。
147	
148	5) 電子メールの宛先の選び方
149	
150	MAINTAINERS ファイルとソースコードに目を通してください。そして、その変
151	更がメンテナのいる特定のサブシステムに加えられるものであることが分か
152	れば、その人に電子メールを送ってください。
153	
154	もし、メンテナが載っていなかったり、メンテナからの応答がないなら、
155	LKML ( linux-kernel[AT]vger.kernel[DOT]org )へパッチを送ってください。ほとんど
156	のカーネル開発者はこのメーリングリストに目を通しており、変更に対して
157	コメントを得ることができます。
158	
159	15個より多くのパッチを同時に vger.kernel.org のメーリングリストへ送らな
160	いでください!!!
161	
162	Linus Torvalds は Linux カーネルに入る全ての変更に対する最終的な意思決定者
163	です。電子メールアドレスは torvalds[AT]linux-foundation[DOT]org になります。彼は
164	多くの電子メールを受け取っているため、できる限り彼に電子メールを送るのは
165	避けるべきです。
166	
167	バグフィックスであったり、自明な変更であったり、話し合いをほとんど
168	必要としないパッチは Linus へ電子メールを送るか CC しなければなりません。
169	話し合いを必要としたり、明確なアドバンテージがないパッチは、通常まず
170	は LKML へ送られるべきです。パッチが議論された後にだけ、そのパッチを
171	Linus へ送るべきです。
172	
173	6) CC (カーボンコピー)先の選び方
174	
175	特に理由がないなら、LKML にも CC してください。
176	
177	Linus 以外のカーネル開発者は変更に気づく必要があり、その結果、彼らはそ
178	の変更に対してコメントをくれたり、コードに対してレビューや提案をくれ
179	るかもしれません。LKML とは Linux カーネル開発者にとって一番中心的なメー
180	リングリストです。USB やフレームバッファデバイスや VFS や SCSI サブシステ
181	ムなどの特定のサブシステムに関するメーリングリストもあります。あなた
182	の変更に、はっきりと関連のあるメーリングリストについて知りたければ
183	MAINTAINERS ファイルを参照してください。
184	
185	VGER.KERNEL.ORG でホスティングされているメーリングリストの一覧が下記の
186	サイトに載っています。
187	<http://vger.kernel.org/vger-lists.html>
188	
189	もし、変更がユーザランドのカーネルインタフェースに影響を与え
190	るのであれば、MAN-PAGES のメンテナ( MAINTAINERS ファイルに一覧
191	があります)に man ページのパッチを送ってください。少なくとも
192	情報がマニュアルページの中に入ってくるように、変更が起きたという
193	通知を送ってください。
194	
195	たとえ、メンテナが #4 で反応がなかったとしても、メンテナのコードに変更を
196	加えたときには、いつもメンテナに CC するのを忘れないようにしてください。
197	
198	小さなパッチであれば、Adrian Bunk が管理している Trivial Patch Monkey
199	(ちょっとしたパッチを集めている)<trivial[AT]kernel[DOT]org>に CC してもいい
200	です。ちょっとしたパッチとは以下のルールのどれか1つを満たしていなけ
201	ればなりません。
202	 ・ドキュメントのスペルミスの修正
203	 ・grep(1) コマンドによる検索を困難にしているスペルの修正
204	 ・コンパイル時の警告の修正(無駄な警告が散乱することは好ましくないた
205	   めです)
206	 ・コンパイル問題の修正(それらの修正が本当に正しい場合に限る)
207	 ・実行時の問題の修正(それらの修正が本当に問題を修正している場合に限る)
208	 ・廃止予定の関数やマクロを使用しているコードの除去(例 check_region )
209	 ・問い合わせ先やドキュメントの修正
210	 ・移植性のないコードから移植性のあるコードへの置き換え(小さい範囲で
211	   あればアーキテクチャ特有のことでも他の人がコピーできます)
212	 ・作者やメンテナによる修正(すなわち patch monkey の再転送モード)
213	URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/>
214	
215	7) MIME やリンクや圧縮ファイルや添付ファイルではなくプレインテキストのみ
216	
217	Linus や他のカーネル開発者はあなたが投稿した変更を読んで、コメントでき
218	る必要があります。カーネル開発者にとって、あなたが書いたコードの特定の
219	部分にコメントをするために、標準的な電子メールクライアントで変更が引用
220	できることは重要です。
221	
222	上記の理由で、すべてのパッチは文中に含める形式の電子メールで投稿さ
223	れるべきです。警告：あなたがパッチをコピー&ペーストする際には、パッ
224	チを改悪するエディターの折り返し機能に注意してください。
225	
226	パッチを圧縮の有無に関わらず MIME 形式で添付しないでください。多くのポ
227	ピュラーな電子メールクライアントは MIME 形式の添付ファイルをプレーンテ
228	キストとして送信するとは限らないでしょう。そうなると、電子メールクラ
229	イアントがコードに対するコメントを付けることをできなくします。また、
230	MIME 形式の添付ファイルは Linus に手間を取らせることになり、その変更を
231	受け入れてもらう可能性が低くなってしまいます。
232	
233	例外：お使いの電子メールクライアントがパッチをめちゃくちゃにするので
234	あれば、誰かが MIME 形式のパッチを再送するよう求めるかもしれません。
235	
236	警告： Mozilla のような特定の電子メールクライアントは電子メールの
237	ヘッダに以下のものを付加して送ります。
238	---- message header ----
239	Content-Type: text/plain; charset=us-ascii; format=flowed
240	---- message header ----
241	問題は、「 format=flowed 」が付いた電子メールを特定の受信側の電子メール
242	クライアントがタブをスペースに置き換えるというような変更をすることです。
243	したがって送られてきたパッチは壊れているように見えるでしょう。
244	
245	これを修正するには、mozilla の defaults/pref/mailnews.js ファイルを
246	以下のように修正します。
247	pref("mailnews.send_plaintext_flowed", false); // RFC 2646=======
248	pref("mailnews.display.disable_format_flowed_support", true);
249	
250	8) 電子メールのサイズ
251	
252	パッチを Linus へ送るときは常に #7 の手順に従ってください。
253	
254	大きなパッチはメーリングリストやメンテナにとって不親切です。パッチが
255	未圧縮で 40KB を超えるようであるなら、インターネット上のアクセス可能な
256	サーバに保存し、保存場所を示す URL を伝えるほうが適切です。
257	
258	9) カーネルバージョンの明記
259	
260	パッチが対象とするカーネルのバージョンをパッチの概要か電子メールの
261	サブジェクトに付けることが重要です。
262	
263	パッチが最新バージョンのカーネルに正しく適用できなければ、Linus は
264	そのパッチを採用しないでしょう。
265	
266	10) がっかりせず再投稿
267	
268	パッチを投稿した後は、辛抱強く待っていてください。Linus があなたのパッ
269	チを気に入って採用すれば、Linus がリリースする次のバージョンのカーネル
270	の中で姿を見せるでしょう。
271	
272	しかし、パッチが次のバージョンのカーネルに入っていないなら、いくつもの
273	理由があるのでしょう。その原因を絞り込み、間違っているものを正し、更新
274	したパッチを投稿するのはあなたの仕事です。
275	
276	Linus があなたのパッチに対して何のコメントもなく不採用にすることは極め
277	て普通のことです。それは自然な姿です。もし、Linus があなたのパッチを受
278	け取っていないのであれば、以下の理由が考えられます。
279	* パッチが最新バージョンの Linux カーネルにきちんと適用できなかった
280	* パッチが LKML で十分に議論されていなかった
281	* スタイルの問題(セクション2を参照)
282	* 電子メールフォーマットの問題(このセクションを参照)
283	* パッチに対する技術的な問題
284	* Linus はたくさんの電子メールを受け取っているので、どさくさに紛れて見
285	  失った
286	* 不愉快にさせている
287	
288	判断できない場合は、LKML にコメントを頼んでください。
289	
290	11) サブジェクトに「 PATCH 」
291	
292	Linus や LKML への大量の電子メールのために、サブジェクトのプレフィックスに
293	「 [PATCH] 」を付けることが慣習となっています。これによって Linus や他の
294	カーネル開発者がパッチであるのか、又は、他の議論に関する電子メールであるの
295	かをより簡単に識別できます。
296	
297	12) パッチへの署名
298	
299	誰が何をしたのかを追いかけやすくするために (特に、パッチが何人かの
300	メンテナを経て最終的に Linux カーネルに取り込まれる場合のために)、電子
301	メールでやり取りされるパッチに対して「 sign-off 」という手続きを導入し
302	ました。
303	
304	「 sign-off 」とは、パッチがあなたの書いたものであるか、あるいは、
305	あなたがそのパッチをオープンソースとして提供する権利を保持している、
306	という証明をパッチの説明の末尾に一行記載するというものです。
307	ルールはとても単純です。以下の項目を確認して下さい。
308	
309	        原作者の証明書( DCO ) 1.1
310	
311	        このプロジェクトに寄与するものとして、以下のことを証明する。
312	
313	        (a) 本寄与は私が全体又は一部作成したものであり、私がそのファイ
314	            ル中に明示されたオープンソースライセンスの下で公開する権利
315	            を持っている。もしくは、
316	
317	        (b) 本寄与は、私が知る限り、適切なオープンソースライセンスでカバ
318	            ーされている既存の作品を元にしている。同時に、私はそのライセ
319	            ンスの下で、私が全体又は一部作成した修正物を、ファイル中で示
320	            される同一のオープンソースライセンスで(異なるライセンスの下で
321	            投稿することが許可されている場合を除いて)投稿する権利を持って
322	            いる。もしくは、
323	
324	        (c) 本寄与は(a)、(b)、(c)を証明する第3者から私へ直接提供された
325	            ものであり、私はそれに変更を加えていない。
326	
327		(d) 私はこのプロジェクトと本寄与が公のものであることに理解及び同意す
328	            る。同時に、関与した記録(投稿の際の全ての個人情報と sign-off を
329	            含む)が無期限に保全されることと、当該プロジェクト又は関連する
330	            オープンソースライセンスに沿った形で再配布されることに理解及び
331	            同意する。
332	
333	もしこれに同意できるなら、以下のような1行を追加してください。
334	
335		Signed-off-by: Random J Developer <random[AT]developer.example[DOT]org>
336	
337	実名を使ってください。(残念ですが、偽名や匿名による寄与はできません。)
338	
339	人によっては sign-off の近くに追加のタグを付加しています。それらは今のところ
340	無視されますが、あなたはそのタグを社内の手続きに利用したり、sign-off に特別
341	な情報を示したりすることができます。
342	
343	13) いつ Acked-by: を使うのか
344	
345	「 Signed-off-by: 」タグはその署名者がパッチの開発に関わっていたことやパッチ
346	の伝播パスにいたことを示しています。
347	
348	ある人が直接パッチの準備や作成に関わっていないけれど、その人のパッチに対す
349	る承認を記録し、示したいとします。その場合、その人を示すのに Acked-by: が使
350	えます。Acked-by: はパッチのチェンジログにも追加されます。
351	
352	パッチの影響を受けるコードのメンテナがパッチに関わっていなかったり、パッチ
353	の伝播パスにいなかった時にも、メンテナは Acked-by: をしばしば利用します。
354	
355	Acked-by: は Signed-off-by: のように公式なタグではありません。それはメンテナが
356	少なくともパッチをレビューし、同意を示しているという記録です。そのような
357	ことからパッチの統合者がメンテナの「うん、良いと思うよ」という発言を
358	Acked-by: へ置き換えることがあります。
359	
360	Acked-by: が必ずしもパッチ全体の承認を示しているわけではありません。例えば、
361	あるパッチが複数のサブシステムへ影響を与えており、その中の1つのサブシステム
362	のメンテナからの Acked-by: を持っているとします。その場合、Acked-by: は通常
363	そのメンテナのコードに影響を与える一部分だけに対する承認を示しています。
364	この点は、ご自分で判断してください。(その Acked-by: が)疑わしい場合は、
365	メーリングリストアーカイブの中の大元の議論を参照すべきです。
366	
367	14) 標準的なパッチのフォーマット
368	
369	標準的なパッチのサブジェクトは以下のとおりです。
370	
371	    Subject: [PATCH 001/123] subsystem: summary phrase
372	
373	標準的なパッチの、電子メールのボディは以下の項目を含んでいます。
374	
375	  - パッチの作成者を明記する「 from 」行
376	
377	  - 空行
378	
379	  - 説明本体。これはこのパッチを説明するために無期限のチェンジログ
380	    (変更履歴)にコピーされます。
381	
382	  - 上述した「 Signed-off-by: 」行。これも説明本体と同じくチェン
383	    ジログ内にコピーされます。
384	
385	  - マーカー行は単純に「 --- 」です。
386	
387	  - 余計なコメントは、チェンジログには不適切です。
388	
389	  - 実際のパッチ(差分出力)
390	
391	サブジェクト行のフォーマットは、アルファベット順で電子メールをとても
392	ソートしやすいものになっています。(ほとんどの電子メールクライアント
393	はソートをサポートしています)パッチのサブジェクトの連番は0詰めであ
394	るため、数字でのソートとアルファベットでのソートは同じ結果になります。
395	
396	電子メールのサブジェクト内のサブシステム表記は、パッチが適用される
397	分野またはサブシステムを識別できるようにすべきです。
398	
399	電子メールのサブジェクトの「概要の言い回し」はそのパッチの概要を正確
400	に表現しなければなりません。「概要の言い回し」をファイル名にしてはい
401	けません。一連のパッチ中でそれぞれのパッチは同じ「概要の言い回し」を
402	使ってはいけません(「一連のパッチ」とは順序付けられた関連のある複数の
403	パッチ群です)。
404	
405	あなたの電子メールの「概要の言い回し」がそのパッチにとって世界で唯
406	一の識別子になるように心がけてください。「概要の言い回し」は git の
407	チェンジログの中へずっと伝播していきます。「概要の言い回し」は、開
408	発者が後でパッチを参照するために議論の中で利用するかもしれません。
409	人々はそのパッチに関連した議論を読むために「概要の言い回し」を使って
410	google で検索したがるでしょう。
411	
412	サブジェクトの例を二つ
413	
414	    Subject: [patch 2/5] ext2: improve scalability of bitmap searching
415	    Subject: [PATCHv2 001/207] x86: fix eflags tracking
416	
417	「 from 」行は電子メールのボディの一番最初の行でなければなりません。
418	その形式は以下のとおりです。
419	
420	        From: Original Author <author[AT]example[DOT]com>
421	
422	「 from 」行はチェンジログの中で、そのパッチの作成者としてクレジットされ
423	ている人を特定するものです。「 from 」行がかけていると、電子メールのヘッ
424	ダーの「 From: 」が、チェンジログの中でパッチの作成者を決定するために使わ
425	れるでしょう。
426	
427	説明本体は無期限のソースのチェンジログにコミットされます。なので、説明
428	本体はそのパッチに至った議論の詳細を忘れているある程度の技量を持っている人
429	がその詳細を思い出すことができるものでなければなりません。
430	
431	「 --- 」マーカー行はパッチ処理ツールに対して、チェンジログメッセージの終端
432	部分を認識させるという重要な役目を果たします。
433	
434	「 --- 」マーカー行の後の追加コメントの良い使用方法の1つに diffstat コマンド
435	があります。diffstat コマンドとは何のファイルが変更され、1ファイル当たり何行
436	追加され何行消されたかを示すものです。diffstat コマンドは特に大きなパッチに
437	おいて役立ちます。その時点でだけ又はメンテナにとってのみ関係のあるコメント
438	は無期限に保存されるチェンジログにとって適切ではありません。そのため、この
439	ようなコメントもマーカー行の後に書かれるべきです。ファイル名はカーネルソー
440	スツリーのトップディレクトリからの表記でリストされるため、横方向のスペース
441	をとり過ぎないように、diffstat コマンドにオプション「  -p 1 -w 70 」を指定し
442	てください(インデントを含めてちょうど80列に合うでしょう)。
443	
444	適切なパッチのフォーマットの詳細についてはセクション3の参考文献を参照して
445	ください。
446	
447	------------------------------------
448	セクション2 - ヒントとTIPSと小技
449	------------------------------------
450	
451	このセクションは Linux カーネルに変更を適用することに関係のある一般的な
452	「お約束」の多くを載せています。物事には例外というものがあります。しか
453	し例外を適用するには、本当に妥当な理由が不可欠です。あなたは恐らくこの
454	セクションを Linus のコンピュータ・サイエンス101と呼ぶでしょう。
455	
456	1) Documentation/CodingStyleを参照
457	
458	言うまでもなく、あなたのコードがこ&at