/Documentation/ja_JP/SubmitChecklist

https://bitbucket.org/sammyz/iscream_thunderc-2.6.35-rebase · #! · 111 lines · 81 code · 30 blank · 0 comment · 0 complexity · 6ea12d98d2d9d98186d71b9f92801521 MD5 · raw file

  1. NOTE:
  2. This is a version of Documentation/SubmitChecklist into Japanese.
  3. This document is maintained by Takenori Nagano <t-nagano@ah.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. Please also note that the purpose of this file is to be easier to read
  9. for non English (read: Japanese) speakers and is not intended as a
  10. fork. So if you have any comments or updates of this file, please try
  11. to update the original English file first.
  12. Last Updated: 2008/07/14
  13. ==================================
  14. これは
  15. linux-2.6.26/Documentation/SubmitChecklist の和訳です
  16. 翻訳団体 JF プロジェクト < http://www.linux.or.jp/JF/ >
  17. 翻訳日 2008/07/14
  18. 翻訳者 Takenori Nagano <t-nagano at ah dot jp dot nec dot com>
  19. 校正者 Masanori Kobayashi さん <zap03216 at nifty dot ne dot jp>
  20. ==================================
  21. Linux カーネルパッチ投稿者向けチェックリスト
  22. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23. 本書ではパッチをより素早く取り込んでもらいたい開発者が実践すべき基本的な事柄
  24. をいくつか紹介しますここにある全ての事柄はDocumentation/SubmittingPatches
  25. などのLinuxカーネルパッチ投稿に際しての心得を補足するものです
  26. 1: 妥当なCONFIGオプションや変更されたCONFIGオプションつまり =y, =m, =n
  27. 全てで正しくビルドできることを確認してくださいその際gcc及びリンカが
  28. warningやerrorを出していないことも確認してください
  29. 2: allnoconfig, allmodconfig オプションを用いて正しくビルドできることを
  30. 確認してください
  31. 3: 手許のクロスコンパイルツールやOSDLのPLMのようなものを用いて複数の
  32. アーキテクチャにおいても正しくビルドできることを確認してください
  33. 4: 64bit長の'unsigned long'を使用しているppc64はクロスコンパイルでの
  34. チェックに適当なアーキテクチャです
  35. 5: カーネルコーディングスタイルに準拠しているかどうか確認してください(!)
  36. 6: CONFIGオプションの追加変更をした場合にはCONFIGメニューが壊れていない
  37. ことを確認してください
  38. 7: 新しくKconfigのオプションを追加する際には必ずそのhelpも記述してください
  39. 8: 適切なKconfigの依存関係を考えながら慎重にチェックしてください
  40. ただしこの作業はマシンを使ったテストできちんと行うのがとても困難です
  41. うまくやるには自分の頭で考えることです
  42. 9: sparseを利用してちゃんとしたコードチェックをしてください
  43. 10: 'make checkstack' 'make namespacecheck' を利用し問題が発見されたら
  44. 修正してください'make checkstack' は明示的に問題を示しませんがどれか
  45. つの関数が512バイトより大きいスタックを使っていれば修正すべき候補と
  46. なります
  47. 11: グローバルなkernel API を説明する kernel-doc をソースの中に含めてください
  48. ( staticな関数においては必須ではありませんが含めてもらっても結構です )
  49. そして'make htmldocs' もしくは 'make mandocs' を利用して追記した
  50. ドキュメントのチェックを行い問題が見つかった場合には修正を行ってください
  51. 12: CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT, CONFIG_DEBUG_SLAB,
  52. CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES, CONFIG_DEBUG_SPINLOCK,
  53. CONFIG_DEBUG_SPINLOCK_SLEEP これら全てを同時に有効にして動作確認を
  54. 行ってください
  55. 13: CONFIG_SMP, CONFIG_PREEMPT を有効にした場合と無効にした場合の両方で
  56. ビルドした上動作確認を行ってください
  57. 14: もしパッチがディスクのI/O性能などに影響を与えるようであれば
  58. 'CONFIG_LBDAF'オプションを有効にした場合と無効にした場合の両方で
  59. テストを実施してみてください
  60. 15: lockdepの機能を全て有効にした上で全てのコードパスを評価してください
  61. 16: /proc に新しいエントリを追加した場合にはDocumentation/ 配下に
  62. 必ずドキュメントを追加してください
  63. 17: 新しいブートパラメータを追加した場合には
  64. 必ずDocumentation/kernel-parameters.txt に説明を追加してください
  65. 18: 新しくmoduleにパラメータを追加した場合にはMODULE_PARM_DESC()
  66. 利用して必ずその説明を記述してください
  67. 19: 新しいuserspaceインタフェースを作成した場合にはDocumentation/ABI/
  68. Documentation/ABI/README を参考にして必ずドキュメントを追加してください
  69. 20: 'make headers_check'を実行して全く問題がないことを確認してください
  70. 21: 少なくともslabアロケーションとpageアロケーションに失敗した場合の
  71. 挙動についてfault-injectionを利用して確認してください
  72. Documentation/fault-injection/ を参照してください
  73. 追加したコードがかなりの量であったならばサブシステム特有の
  74. fault-injectionを追加したほうが良いかもしれません
  75. 22: 新たに追加したコードは`gcc -W'でコンパイルしてください。
  76. このオプションは大量の不要なメッセージを出力しますが、
  77. "warning: comparison between signed and unsigned" のようなメッセージは、
  78. バグを見つけるのに役に立ちます。
  79. 23: 投稿したパッチが -mm パッチセットにマージされた後、全ての既存のパッチや
  80. VM, VFS およびその他のサブシステムに関する様々な変更と、現時点でも共存
  81. できることを確認するテストを行ってください。