1 .. raw:: latex 2 3 \kerneldocCJKoff 4 5 NOTE: 6 This is a version of Documentation/process/howto.rst translated into Japanese. 7 This document is maintained by Tsugikazu Shibata <tshibata@ab.jp.nec.com> 8 If you find any difference between this document and the original file or 9 a problem with the translation, please contact the maintainer of this file. 10 11 Please also note that the purpose of this file is to be easier to 12 read for non English (read: Japanese) speakers and is not intended as 13 a fork. So if you have any comments or updates for this file, please 14 try to update the original English file first. 15 16 ---------------------------------- 17 18 .. raw:: latex 19 20 \kerneldocCJKon 21 22 この文書は、 23 Documentation/process/howto.rst 24 の和訳です。 25 26 翻訳者： Tsugikazu Shibata <tshibata@ab.jp.nec.com> 27 28 ---------------------------------- 29 30 Linux カーネル開発のやり方 31 ========================== 32 33 これは上のトピック( Linux カーネル開発のやり方)の重要な事柄を網羅した 34 ドキュメントです。ここには Linux カーネル開発者になるための方法とLinux 35 カーネル開発コミュニティと共に活動するやり方を学ぶ方法が含まれています。 36 カーネルプログラミングに関する技術的な項目に関することは何も含めないよ 37 うにしていますが、カーネル開発者となるための正しい方向に向かう手助けに 38 なります。 39 40 もし、このドキュメントのどこかが古くなっていた場合には、このドキュメント 41 の最後にリストしたメンテナにパッチを送ってください。 42 43 はじめに 44 --------- 45 46 あなたは Linux カーネルの開発者になる方法を学びたいのでしょうか？ そ 47 れとも上司から「このデバイスの Linux ドライバを書くように」と言われた 48 のかもしれません。この文書の目的は、あなたが踏むべき手順と、コミュニティ 49 と一緒にうまく働くヒントを書き下すことで、あなたが知るべき全てのことを 50 教えることです。また、このコミュニティがなぜ今うまくまわっているのかと 51 いう理由も説明しようと試みています。 52 53 カーネルは少量のアーキテクチャ依存部分がアセンブリ言語で書かれている以 54 外の大部分は C 言語で書かれています。C言語をよく理解していることはカー 55 ネル開発に必要です。低レベルのアーキテクチャ開発をするのでなければ、 56 (どんなアーキテクチャでも)アセンブリ(訳注: 言語)は必要ありません。以下 57 の本は、C 言語の十分な知識や何年もの経験に取って代わるものではありませ 58 んが、少なくともリファレンスとしては良い本です。 59 60 - "The C Programming Language" by Kernighan and Ritchie [Prentice Hall] 61 - 『プログラミング言語Ｃ第2版』(B.W. カーニハン/D.M. リッチー著 石田晴久訳) [共立出版] 62 - "Practical C Programming" by Steve Oualline [O'Reilly] 63 - 『C実践プログラミング第3版』(Steve Oualline著 望月康司監訳 谷口功訳) [オライリージャパン] 64 - "C: A Reference Manual" by Harbison and Steele [Prentice Hall] 65 - 『新・詳説 C 言語 H&S リファレンス』 (サミュエル P ハービソン/ガイ L スティール共著 斉藤 信男監訳)[ソフトバンク] 66 67 カーネルは GNU C と GNU ツールチェインを使って書かれています。カーネル 68 は ISO C11 仕様に準拠して書く一方で、標準には無い言語拡張を多く使って 69 います。カーネルは標準 C ライブラリに依存しない、C 言語非依存環境です。 70 そのため、C の標準の中で使えないものもあります。特に任意の long long 71 の除算や浮動小数点は使えません。カーネルがツールチェインや C 言語拡張 72 に置いている前提がどうなっているのかわかりにくいことが時々あり、また、 73 残念なことに決定的なリファレンスは存在しません。情報を得るには、gcc の 74 info ページ( info gcc )を見てください。 75 76 あなたは既存の開発コミュニティと一緒に作業する方法を学ぼうとしているこ 77 とに思い出してください。そのコミュニティは、コーディング、スタイル、開 78 発手順について高度な標準を持つ、多様な人の集まりです。地理的に分散した 79 大規模なチームに対してもっともうまくいくとわかったことをベースにしなが 80 ら、これらの標準は長い時間をかけて築かれてきました。これらはきちんと文 81 書化されていますから、事前にこれらの標準について事前にできるだけたくさ 82 ん学んでください。また皆があなたやあなたの会社のやり方に合わせてくれる 83 と思わないでください。 84 85 法的問題 86 -------- 87 88 Linux カーネルのソースコードは GPL ライセンスの下でリリースされていま 89 す。ソースツリーのメインディレクトリにある COPYING のファイルを見てく 90 ださい。Linux カーネルのライセンスルールとソースコード内の 91 `SPDX <https://spdx.org/>`_ 識別子の使い方は 92 :ref:`Documentation/process/license-rules.rst <kernel_licensing>` 93 に説明されています。 94 95 もしライセンスについてさらに質問があれば、 96 Linux Kernel メーリングリストに質問するのではなく、どうぞ 97 法律家に相談してください。メーリングリストの人達は法律家ではなく、法的 98 問題については彼らの声明はあてにするべきではありません。 99 100 GPL に関する共通の質問や回答については、以下を参照してください- 101 102 https://www.gnu.org/licenses/gpl-faq.html 103 104 ドキュメント 105 ------------ 106 107 Linux カーネルソースツリーは幅広い範囲のドキュメントを含んでおり、それ 108 らはカーネルコミュニティと会話する方法を学ぶのに非常に貴重なものです。 109 新しい機能がカーネルに追加される場合、その機能の使い方について説明した 110 新しいドキュメントファイルも追加することを勧めます。 111 カーネルの変更が、カーネルがユーザ空間に公開しているインターフェイスの 112 変更を引き起こす場合、その変更を説明するマニュアルページのパッチや情報 113 をマニュアルページのメンテナ alx@kernel.org に送り、CC を 114 linux-api@vger.kernel.org に送ることを勧めます。 115 116 以下はカーネルソースツリーに含まれている読んでおくべきファイルの一覧で 117 す- 118 119 :ref:`Documentation/admin-guide/README.rst <readme>` 120 このファイルは Linuxカーネルの簡単な背景とカーネルを設定(訳注 121 configure )し、生成(訳注 build )するために必要なことは何かが書かれ 122 ています。 カーネルに関して初めての人はここからスタートすると良い 123 でしょう。 124 125 :ref:`Documentation/process/changes.rst <changes>` 126 このファイルはカーネルをうまく生成(訳注 build )し、走らせるのに最 127 小限のレベルで必要な数々のソフトウェアパッケージの一覧を示してい 128 ます。 129 130 :ref:`Documentation/process/coding-style.rst <codingstyle>` 131 これは Linux カーネルのコーディングスタイルと背景にある理由を記述 132 しています。全ての新しいコードはこのドキュメントにあるガイドライン 133 に従っていることを期待されています。大部分のメンテナはこれらのルー 134 ルに従っているものだけを受け付け、多くの人は正しいスタイルのコード 135 だけをレビューします。 136 137 :ref:`Documentation/process/submitting-patches.rst <codingstyle>` 138 このファイルには、どうやってうまくパッチを作って投稿するかにつ 139 いて非常に詳しく書かれており、以下を含みます (これだけに限らない 140 けれども) 141 142 - Email に含むこと 143 - Email の形式 144 - だれに送るか 145 146 これらのルールに従えばうまくいくことを保証することではありません 147 が (すべてのパッチは内容とスタイルについて精査を受けるので)、 148 ルールに従わなければ間違いなくうまくいかないでしょう。 149 150 この他にパッチを作る方法についてのよくできた記述は- 151 152 "The Perfect Patch" 153 https://www.ozlabs.org/~akpm/stuff/tpp.txt 154 155 "Linux kernel patch submission format" 156 https://web.archive.org/web/20180829112450/http://linux.yyz.us/patch-format.html 157 158 :ref:`Documentation/process/stable-api-nonsense.rst <stable_api_nonsense>` 159 このファイルはカーネルの中に不変の API を持たないことにした意識的 160 な決断の背景にある理由について書かれています。以下のようなことを含 161 んでいます- 162 163 - サブシステムとの間に層を作ること(コンパチビリティのため?) 164 - オペレーティングシステム間のドライバの移植性 165 - カーネルソースツリーの素早い変更を遅らせる(もしくは素早い変更を妨げる) 166 167 このドキュメントは Linux 開発の思想を理解するのに非常に重要です。 168 そして、他のOSでの開発者が Linux に移る時にとても重要です。 169 170 :ref:`Documentation/process/security-bugs.rst <securitybugs>` 171 もし Linux カーネルでセキュリティ問題を発見したように思ったら、こ 172 のドキュメントのステップに従ってカーネル開発者に連絡し、問題解決を 173 支援してください。 174 175 :ref:`Documentation/process/management-style.rst <managementstyle>` 176 このドキュメントは Linux カーネルのメンテナ達がどう行動するか、 177 彼らの手法の背景にある共有されている精神について記述しています。こ 178 れはカーネル開発の初心者なら（もしくは、単に興味があるだけの人でも） 179 重要です。なぜならこのドキュメントは、カーネルメンテナ達の独特な 180 行動についての多くの誤解や混乱を解消するからです。 181 182 :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>` 183 このファイルはどのように stable カーネルのリリースが行われるかのルー 184 ルが記述されています。そしてこれらのリリースの中のどこかで変更を取 185 り入れてもらいたい場合に何をすれば良いかが示されています。 186 187 :Ref:`Documentation/process/kernel-docs.rst <kernel_docs>` 188 カーネル開発に付随する外部ドキュメントのリストです。もしあなたが探 189 しているものがカーネル内のドキュメントでみつからなかった場合、この 190 リストをあたってみてください。 191 192 :ref:`Documentation/process/applying-patches.rst <applying_patches>` 193 パッチとはなにか、パッチをどうやって様々なカーネルの開発ブランチに 194 適用するのかについて正確に記述した良い入門書です。 195 196 カーネルはソースコードそのものや、このファイルのようなリストラクチャー 197 ドテキストマークアップ(ReST)から自動的に生成可能な多数のドキュメントを 198 もっています。これにはカーネル内APIの完全な記述や、正しくロックをかけ 199 るための規則などが含まれます。 200 201 これら全てのドキュメントを PDF や HTML で生成するには以下を実行します - :: 202 203 make pdfdocs 204 make htmldocs 205 206 それぞれメインカーネルのソースディレクトリから実行します。 207 208 ReSTマークアップを使ったドキュメントは Documentation/outputに生成され 209 ます。Latex とePub 形式で生成するには - :: 210 211 make latexdocs 212 make epubdocs 213 214 カーネル開発者になるには 215 ------------------------ 216 217 もしあなたが、Linux カーネル開発について何も知らないのならば、 218 KernelNewbies プロジェクトを見るべきです 219 220 https://kernelnewbies.org 221 222 このサイトには役に立つメーリングリストがあり、基本的なカーネル開発に関 223 するほとんどどんな種類の質問もできます (既に回答されているようなことを 224 聞く前にまずはアーカイブを調べてください)。またここには、リアルタイム 225 で質問を聞くことができる IRC チャネルや、Linuxカーネルの開発に関して学 226 ぶのに便利なたくさんの役に立つドキュメントがあります。 227 228 Web サイトには、コードの構成、サブシステム、現在存在するプロジェクト 229 (ツリーにあるもの無いものの両方)の基本的な管理情報があります。ここには、 230 また、カーネルのコンパイルのやり方やパッチの当て方などの間接的な基本情 231 報も記述されています。 232 233 あなたがどこからスタートして良いかわからないが、Linux カーネル開発コミュ 234 ニティに参加して何かすることをさがしているのであれば、Linux kernel 235 Janitor's プロジェクトにいけば良いでしょう - 236 237 https://kernelnewbies.org/KernelJanitors 238 239 ここはそのようなスタートをするのにうってつけの場所です。ここには、 240 Linux カーネルソースツリーの中に含まれる、きれいにし、修正しなければな 241 らない、単純な問題のリストが記述されています。このプロジェクトに関わる 242 開発者と一緒に作業することで、あなたのパッチを Linuxカーネルツリーに入 243 れるための基礎を学ぶことができ、そしてもしあなたがまだアイディアを持っ 244 ていない場合には、次にやる仕事の方向性が見えてくるかもしれません。 245 246 実際に Linux カーネルのコードについて修正を加える前に、どうやってその 247 コードが動作するのかを理解することが必要です。そのためには、特別なツー 248 ルの助けを借りてでも、それを直接よく読むことが最良の方法です(ほとんど 249 のトリッキーな部分は十分にコメントしてありますから)。そういうツールで 250 特におすすめなのは、Linux クロスリファレンスプロジェクトです。これは、 251 自己参照方式で、索引がついた web 形式で、ソースコードを参照することが 252 できます。この最新の素晴しいカーネルコードのリポジトリは以下で見つかり 253 ます - 254 255 https://elixir.bootlin.com/ 256 257 開発プロセス 258 ------------ 259 260 Linux カーネルの開発プロセスは現在幾つかの異なるメインカーネル「ブラン 261 チ」と多数のサブシステム毎のカーネルブランチから構成されます。これらの 262 ブランチとは - 263 264 - Linus のメインラインツリー 265 - メジャー番号をまたぐ数本の安定版ツリー 266 - サブシステム毎のカーネルツリー 267 - 統合テストのための linux-next カーネルツリー 268 269 メインラインツリー 270 ~~~~~~~~~~~~~~~~~~ 271 272 メインラインツリーは Linus Torvalds によってメンテナンスされ、 273 https://kernel.org のリポジトリに存在します。 274 この開発プロセスは以下のとおり - 275 276 - 新しいカーネルがリリースされた直後に、2週間の特別期間が設けられ、 277 この期間中に、メンテナ達は Linus に大きな差分を送ることができます。 278 このような差分は通常 linux-next カーネルに数週間含まれてきたパッチです。 279 大きな変更は git(カーネルのソース管理ツール、詳細は 280 http://git-scm.com/ 参照) を使って送るのが好ましいやり方ですが、パッ 281 チファイルの形式のまま送るのでも十分です。 282 - 2週間後 -rc1 カーネルがリリースされ、新しいカーネルを可能な限り堅牢に 283 することに焦点が移ります。この期間のパッチのほとんどは退行を修正する 284 ものとなります。以前から存在していたバグは退行には当たらないため、 285 送るのは重要な修正だけにしてください。 286 新しいドライバ (もしくはファイルシステム) のパッチは 287 -rc1 の後で受け付けられることもあることを覚えておいてください。な 288 ぜなら、変更が独立していて、追加されたコードの外の領域に影響を与え 289 ない限り、退行のリスクは無いからです。-rc1 がリリースされた後、 290 Linus へパッチを送付するのに git を使うこともできますが、パッチは 291 レビューのために、パブリックなメーリングリストへも同時に送る必要が 292 あります。 293 - 新しい -rc は Linus が、最新の git ツリーがテスト目的であれば十分 294 に安定した状態にあると判断したときにリリースされます。目標は毎週新 295 しい -rc カーネルをリリースすることです。 296 - このプロセスはカーネルが 「準備ができた」と考えられるまで継続しま 297 す。このプロセスはだいたい 6週間継続します。 298 299 Andrew Morton が Linux-kernel メーリングリストにカーネルリリースについ 300 て書いたことをここで言っておくことは価値があります - 301 302 *「カーネルがいつリリースされるかは誰も知りません。なぜなら、 303 これは現実に認識されたバグの状況によりリリースされるのであり、 304 前もって決められた計画によってリリースされるものではないから 305 です。」* 306 307 メジャー番号をまたぐ数本の安定版ツリー 308 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 309 310 バージョン番号が3つの数字に分かれているカーネルは -stable カーネルです。 311 これには最初の2つのバージョン番号の数字に対応した、 312 メジャーメインラインリリースで見つかったセキュリティ問題や 313 重大な後戻りに対する比較的小さい重要な修正が含まれます。 314 315 メジャー安定版シリーズのそれぞれのリリースは 316 バージョン番号の3番目を増加させ、最初の2つの番号は同じ値を保ちます。 317 318 これは、開発/実験的バージョンのテストに協力することに興味が無く、最新 319 の安定したカーネルを使いたいユーザに推奨するブランチです。 320 321 安定版ツリーは"stable" チーム <stable@vger.kernel.org> でメンテされており、 322 必要に応じてリリースされます。通常のリリース期間は 2週間毎ですが、差 323 し迫った問題がなければもう少し長くなることもあります。セキュリティ関 324 連の問題の場合はこれに対してだいたいの場合、すぐにリリースがされます。 325 326 カーネルツリーに入っている、 327 Documentation/process/stable-kernel-rules.rst ファイルにはどのような種 328 類の変更が -stable ツリーに受け入れ可能か、またリリースプロセスがどう 329 動くかが記述されています。 330 331 サブシステム毎のカーネルツリー 332 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 333 334 それぞれのカーネルサブシステムのメンテナ達は --- そして多くのカーネル 335 サブシステムの開発者達も --- 各自の最新の開発状況をソースリポジトリに 336 公開しています。そのため、自分とは異なる領域のカーネルで何が起きている 337 かを他の人が見られるようになっています。開発が早く進んでいる領域では、 338 開発者は自身の投稿がどのサブシステムカーネルツリーを元にしているか質問 339 されるので、その投稿とすでに進行中の他の作業との衝突が避けられます。 340 341 大部分のこれらのリポジトリは git ツリーです。しかしその他の SCM や 342 quilt シリーズとして公開されているパッチキューも使われています。これら 343 のサブシステムリポジトリのアドレスは MAINTAINERS ファイルにリストされ 344 ています。これらの多くは https://git.kernel.org/ で参照することができま 345 す。 346 347 提案されたパッチがこのようなサブシステムツリーにコミットされる前に、メー 348 リングリストで事前にレビューにかけられます（以下の対応するセクションを 349 参照）。いくつかのカーネルサブシステムでは、このレビューは patchworkと 350 いうツールによって追跡されます。Patchwork は web インターフェイスによっ 351 てパッチ投稿の表示、パッチへのコメント付けや改訂などができ、そしてメン 352 テナはパッチに対して、レビュー中、受付済み、拒否というようなマークをつ 353 けることができます。大部分のこれらの patchwork のサイトは 354 https://patchwork.kernel.org/ でリストされています。 355 356 統合テストのための linux-next カーネルツリー 357 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 358 359 サブシステムツリーの更新内容がメインラインツリーにマージされる 360 前に、それらは統合テストされる必要があります。この目的のため、実質的に 361 全サブシステムツリーからほぼ毎日プルされてできる特別なテスト用のリポジ 362 トリが存在します- 363 364 https://git.kernel.org/?p=linux/kernel/git/next/linux-next.git 365 366 このやり方によって、linux-next は次のマージ機会でどんなものがメイン 367 ラインにマージされるか、おおまかな展望を提供します。 368 linux-next の実行テストを行う冒険好きなテスターは大いに歓迎されます。 369 370 バグレポート 371 ------------- 372 373 メインカーネルソースディレクトリにあるファイル 374 'Documentation/admin-guide/reporting-issues.rst' 375 は、カーネルバグらしきものの報告の仕方、および、カーネル開発者が問題を 376 追跡する際の手がかりとなる情報についての詳細を説明しています。 377 378 バグレポートの管理 379 ------------------- 380 381 あなたのハッキングのスキルを訓練する最高の方法のひとつに、他人がレポー 382 トしたバグを修正することがあります。あなたがカーネルをより安定化させる 383 こに寄与するということだけでなく、あなたは 現実の問題を修正することを 384 学び、自分のスキルも強化でき、また他の開発者があなたの存在に気がつきま 385 す。バグを修正することは、多くの開発者の中から自分が功績をあげる最善の 386 道です、なぜなら多くの人は他人のバグの修正に時間を浪費することを好まな 387 いからです。 388 389 すでにレポートされたバグの作業をするためには、興味のあるサブシステムを 390 見つけ、そのサブシステムのバグの報告先 (多くの場合メーリングリスト、 391 稀にバグトラッカー) を MAINTAINERS ファイルで調べてください。 392 そのアーカイブで最近の報告を検索し、できそうなものに力を貸してください。 393 https://bugzilla.kernel.org でバグ報告を調べようとする人もいるでしょう。 394 これは限られた一部のサブシステムのバグ報告と追跡に利用されるとともに、 395 とりわけ、カーネル全体に対するバグの登録先となっています。 396 397 メーリングリスト 398 ---------------- 399 400 上のいくつかのドキュメントで述べていますが、コアカーネル開発者の大部分 401 は Linux kernel メーリングリストに参加しています。このリストの登録/脱 402 退の方法については以下を参照してください- 403 404 http://vger.kernel.org/vger-lists.html#linux-kernel 405 406 このメーリングリストのアーカイブは web 上の多数の場所に存在します。こ 407 れらのアーカイブを探すにはサーチエンジンを使いましょう。例えば- 408 409 https://lore.kernel.org/lkml/ 410 411 リストに投稿する前にすでにその話題がアーカイブに存在するかどうかを検索 412 することを是非やってください。多数の事がすでに詳細に渡って議論されてお 413 り、アーカイブにのみ記録されています。 414 415 大部分のカーネルサブシステムも自分の個別の開発を実施するメーリングリス 416 トを持っています。個々のグループがどんなリストを持っているかは、 417 MAINTAINERS ファイルにリストがありますので参照してください。 418 419 多くのリストは kernel.org でホストされています。これらの情報は以下にあ 420 ります - 421 422 http://vger.kernel.org/vger-lists.html 423 424 メーリングリストを使う場合、良い行動習慣に従うようにしましょう。少し安っ 425 ぽいが、以下の URL は上のリスト(や他のリスト)で会話する場合のシンプル 426 なガイドラインを示しています - 427 428 http://www.albion.com/netiquette/ 429 430 もし複数の人があなたのメールに返事をした場合、CC: で受ける人のリストは 431 だいぶ多くなるでしょう。正当な理由がない限り、CC: リストから誰かを削除 432 をしないように、また、メーリングリストのアドレスだけにリプライすること 433 のないようにしましょう。1つは送信者から、もう1つはリストからのように、 434 メールを2回受けることになってもそれに慣れ、しゃれたメールヘッダーを追 435 加してこの状態を変えようとしないように。人々はそのようなことは好みませ 436 ん。 437 438 今までのメールでのやりとりとその間のあなたの発言はそのまま残し、 439 "John Kernelhacker wrote ...:" の行をあなたのリプライの先頭行にして、 440 メールの先頭でなく、各引用行の間にあなたの言いたいことを追加するべきで 441 す。 442 443 もしパッチをメールに付ける場合は、 444 Documentation/process/submitting-patches.rst に提示されているように、そ 445 れは プレーンな可読テキストにすることを忘れないようにしましょう。カー 446 ネル開発者は 添付や圧縮したパッチを扱いたがりません。彼らはあなたのパッ 447 チの行毎にコメントを入れたいので、そうするしかありません。あなたのメー 448 ルプログラムが空白やタブを圧縮しないように確認しましょう。最初の良いテ 449 ストとしては、自分にメールを送ってみて、そのパッチを自分で当ててみるこ 450 とです。もしそれがうまく行かないなら、あなたのメールプログラムを直して 451 もらうか、正しく動くように変えるべきです。 452 453 何をおいても、他の購読者に対する敬意を表すことを忘れないでください。 454 455 コミュニティと共に働くこと 456 -------------------------- 457 458 カーネルコミュニティのゴールは可能なかぎり最高のカーネルを提供すること 459 です。あなたがパッチを受け入れてもらうために投稿した場合、それは、技術 460 的メリットだけがレビューされます。その際、あなたは何を予想すべきでしょ 461 うか? 462 463 - 批判 464 - コメント 465 - 変更の要求 466 - パッチの正当性の証明要求 467 - 沈黙 468 469 思い出してください、これはあなたのパッチをカーネルに入れる話です。あな 470 たは、あなたのパッチに対する批判とコメントを受け入れるべきで、それらを 471 技術的レベルで評価して、パッチを再作成するか、なぜそれらの変更をすべき 472 でないかを明確で簡潔な理由の説明を提供してください。もし、あなたのパッ 473 チに何も反応がない場合、たまにはメールの山に埋もれて見逃され、あなたの 474 投稿が忘れられてしまうこともあるので、数日待って再度投稿してください。 475 476 あなたがやるべきでないことは? 477 478 - 質問なしにあなたのパッチが受け入れられると想像すること 479 - 守りに入ること 480 - コメントを無視すること 481 - 要求された変更を何もしないでパッチを出し直すこと 482 483 可能な限り最高の技術的解決を求めているコミュニティでは、パッチがどのく 484 らい有益なのかについては常に異なる意見があります。あなたは協調的である 485 べきですし、また、あなたのアイディアをカーネルに対してうまく合わせるよ 486 うにすることが望まれています。もしくは、最低限あなたのアイディアがそれ 487 だけの価値があるとすすんで証明するようにしなければなりません。 488 正しい解決に向かって進もうという意志がある限り、間違うことがあっても許 489 容されることを忘れないでください。 490 491 あなたの最初のパッチに単に 1ダースもの修正を求めるリストの返答になるこ 492 とも普通のことです。これはあなたのパッチが受け入れられないということで 493 は **ありません**、そしてあなた自身に反対することを意味するのでも **あ 494 りません**。単に自分のパッチに対して指摘された問題を全て修正して再送す 495 れば良いのです。 496 497 498 カーネルコミュニティと企業組織のちがい 499 ----------------------------------------------------------------- 500 501 カーネルコミュニティは大部分の伝統的な会社の開発環境とは異ったやり方で 502 動いています。以下は問題を避けるためにできると良いことのリストです。 503 504 あなたの提案する変更について言うときのうまい言い方 - 505 506 - "これは複数の問題を解決します" 507 - "これは2000行のコードを削除します" 508 - "以下のパッチは、私が言おうとしていることを説明するものです" 509 - "私はこれを5つの異なるアーキテクチャでテストしたのですが..." 510 - "以下は一連の小さなパッチ群ですが..." 511 - "これは典型的なマシンでの性能を向上させます..." 512 513 やめた方が良い悪い言い方 - 514 515 - "このやり方で AIX/ptx/Solaris ではできたので、できるはずだ..." 516 - "私はこれを20年もの間やってきた、だから..." 517 - "これは私の会社が金儲けをするために必要だ" 518 - "これは我々のエンタープライズ向け商品ラインのためである" 519 - "これは私が自分のアイディアを記述した、1000ページの設計資料である" 520 - "私はこれについて、6ケ月作業している..." 521 - "以下は ... に関する5000行のパッチです" 522 - "私は現在のぐちゃぐちゃを全部書き直した、それが以下です..." 523 - "私は〆切がある、そのためこのパッチは今すぐ適用される必要がある" 524 525 カーネルコミュニティが大部分の伝統的なソフトウェアエンジニアリングの労 526 働環境と異なるもう一つの点は、やりとりに顔を合わせないということです。 527 email と irc を第一のコミュニケーションの形とする一つの利点は、性別や 528 民族の差別がないことです。Linux カーネルの職場環境は女性や少数民族を受 529 容します。なぜなら、email アドレスによってのみあなたが認識されるからで 530 す。 531 国際的な側面からも活動領域を均等にするようにします。なぜならば、あなた 532 は人の名前で性別を想像できないからです。ある男性が アンドレアという名 533 前で、女性の名前は パット かもしれません (訳注 Andrea は米国では女性、 534 それ以外(欧州など)では男性名として使われることが多い。同様に、Pat は 535 Patricia (主に女性名)や Patrick (主に男性名)の略称)。 536 Linux カーネルの活動をして、意見を表明したことがある大部分の女性は、前 537 向きな経験をもっています。 538 539 言葉の壁は英語が得意でない一部の人には問題になります。メーリングリスト 540 の中で、きちんとアイディアを交換するには、相当うまく英語を操れる必要が 541 あることもあります。そのため、自分のメールを送る前に英語で意味が通じて 542 いるかをチェックすることをお薦めします。 543 544 変更を分割する 545 -------------- 546 547 Linux カーネルコミュニティは、一度に大量のコードの塊を喜んで受容するこ 548 とはありません。変更は正確に説明される必要があり、議論され、小さい、個 549 別の部分に分割する必要があります。これはこれまで多くの会社がやり慣れて 550 きたことと全く正反対のことです。あなたのプロポーザルは、開発プロセスのと 551 ても早い段階から紹介されるべきです。そうすれば あなたは自分のやってい 552 ることにフィードバックを得られます。これは、コミュニティからみれば、あ 553 なたが彼らと一緒にやっているように感じられ、単にあなたの提案する機能の 554 ゴミ捨て場として使っているのではない、と感じられるでしょう。 555 しかし、一度に 50 もの email をメーリングリストに送りつけるようなことは 556 やってはいけません、あなたのパッチ群はいつもどんな時でもそれよりは小さ 557 くなければなりません。 558 559 パッチを分割する理由は以下 - 560 561 1) 小さいパッチはあなたのパッチが適用される見込みを大きくします、カー 562 ネルの人達はパッチが正しいかどうかを確認する時間や労力をかけないか 563 らです。5行のパッチはメンテナがたった1秒見るだけで適用できます。 564 しかし、500行のパッチは、正しいことをレビューするのに数時間かかるか 565 もしれません(時間はパッチのサイズなどにより指数関数に比例してかかり 566 ます) 567 568 小さいパッチは何かあったときにデバッグもとても簡単になります。パッ 569 チを1個1個取り除くのは、とても大きなパッチを当てた後に(かつ、何かお 570 かしくなった後で)解剖するのに比べればとても簡単です。 571 572 2) 小さいパッチを送るだけでなく、送るまえに、書き直して、シンプルにす 573 る(もしくは、単に順番を変えるだけでも)ことも、とても重要です。 574 575 以下はカーネル開発者の Al Viro のたとえ話です - 576 577 *"生徒の数学の宿題を採点する先生のことを考えてみてください、 578 先生は生徒が解に到達するまでの試行錯誤を見たいとは思わないでし 579 ょう。先生は簡潔な最高の解を見たいのです。良い生徒はこれを知っ 580 ており、そして最終解の前の中間作業を提出することは決してないの 581 です* 582 583 *カーネル開発でもこれは同じです。メンテナ達とレビューア達は、 584 問題を解決する解の背後になる思考プロセスを見たいとは思いません。 585 彼らは単純であざやかな解決方法を見たいのです。"* 586 587 あざやかな解を説明するのと、コミュニティと共に仕事をし、未解決の仕事を 588 議論することのバランスをキープするのは難しいかもしれません。ですから、 589 開発プロセスの早期段階で改善のためのフィードバックをもらうようにするの 590 も良いですが、変更点を小さい部分に分割して全体ではまだ完成していない仕 591 事を(部分的に)取り込んでもらえるようにすることも良いことです。 592 593 また、でき上がっていないものや、"将来直す" ようなパッチを、本流に含め 594 てもらうように送っても、それは受け付けられないことを理解してください。 595 596 あなたの変更を正当化する 597 ------------------------ 598 599 あなたのパッチを分割するのと同時に、なぜその変更を追加しなければならな 600 いかを Linux コミュニティに知らせることはとても重要です。新機能は必要 601 性と有用性で正当化されなければなりません。 602 603 あなたの変更を説明する 604 ---------------------- 605 606 あなたのパッチを送付する場合には、メールの中のテキストで何を言うかにつ 607 いて、特別に注意を払ってください。この情報はパッチの ChangeLog に使わ 608 れ、いつも皆がみられるように保管されます。これは次のような項目を含め、 609 パッチを完全に記述するべきです - 610 611 - なぜ変更が必要か 612 - パッチ全体の設計アプローチ 613 - 実装の詳細 614 - テスト結果 615 616 これについて全てがどのようにあるべきかについての詳細は、以下のドキュメ 617 ントの ChangeLog セクションを見てください - 618 619 "The Perfect Patch" 620 https://www.ozlabs.org/~akpm/stuff/tpp.txt 621 622 これらはどれも、実行することが時にはとても困難です。これらの例を完璧に 623 実施するには数年かかるかもしれません。これは継続的な改善のプロセスであ 624 り、多くの忍耐と決意を必要とするものです。でも諦めないで、実現は可能で 625 す。多数の人がすでにできていますし、彼らも最初はあなたと同じところから 626 スタートしたのですから。 627 628 629 630 631 ---------- 632 633 Paolo Ciarrocchi に感謝、彼は彼の書いた "Development Process" 634 (https://lwn.net/Articles/94386/) セクションをこのテキストの原型にする 635 ことを許可してくれました。Rundy Dunlap と Gerrit Huizenga はメーリング 636 リストでやるべきこととやってはいけないことのリストを提供してくれました。 637 以下の人々のレビュー、コメント、貢献に感謝。 638 Pat Mochel, Hanna Linder, Randy Dunlap, Kay Sievers, 639 Vojtech Pavlik, Jan Kara, Josh Boyer, Kees Cook, Andrew Morton, Andi 640 Kleen, Vadim Lobanov, Jesper Juhl, Adrian Bunk, Keri Harris, Frans Pop, 641 David A. Wheeler, Junio Hamano, Michael Kerrisk, と Alex Shepard 642 彼らの支援なしでは、このドキュメントはできなかったでしょう。 643 644 645 646 Maintainer: Greg Kroah-Hartman <greg@kroah.com>
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.