#========================================================#
# mkkmodule 0.1.2                                        #
#  (C)2005-2006 Keicho Kondo <dgel@users.sourceforge.jp> #
#========================================================#

* 最新ニュース、更新情報
  - NEWS、ChangeLogをご覧ください。

* 機能
  - 現在起動しているLinuxカーネル用のモジュールを作成するためのプログラムです。
  - カーネル全体を再構築する必要はありません。
  - 一般ユーザーでも作成が可能です（インストールにはroot権限が必要です）。

* ライセンス
  - GNU GPL version2を適用します。詳しくはCOPYINGファイルを
    ご覧ください。

* インストール
  - INSTALLファイルをご覧ください。


* 使い方

 A.rpm系ディストリビューションに付属するカーネルを使う場合

  1.ディストリビューションの公式サイトから、現在使用中のカーネルのソースパッケ
    ージ（拡張子が.src.rpmのパッケージ）をダウンロードしてください。例えば
    kernel-w.x.y-z.arch.rpmをご使用の場合は、kernel-w.x.y-z.src.rpmをダウンロー
    ドしてください。

  2.ダウンロードしたソースパッケージを以下のコマンドを用いてrpmパッケージ作成用
    のディレクトリに展開します。
      $ rpm -ivh kernel-w.x.y-z.src.rpm 2>/dev/null
    展開先のディレクトリに書き込み権限が無い場合はエラーが発生して展開ができま
    せん。この場合は書き込み権限のあるディレクトリにrpmパッケージ作成用のディレ
    クトリを作成してください。尚、当パッケージ付属のmkrpmdir.shスクリプトを使え
    ばrpmパッケージ作成用ディレクトリと.rpmmacrosを自動的に作成することができま
    す。次のように作成したい場所を指定してお使いください。
      $ ./mkrpmdir <ディレクトリ>
	
  3.カーネルソースコードにパッチを当てる必要がある場合は、カレントディレクトリ
    に該当するパッチをコピーしておいてください。

  4.mkkmodule.confをカレントディレクトリに作成します。mkkmodule.conf.templateを
    テンプレートとして付属しましたので、リネームしてお使いください。各項目は次
    のように編集します。
       MOD_NAME     :  モジュールの名前
       MOD_COMPOPT  :  モジュールのコンパイルオプション
       MOD_SRCDIR   :  カーネルソースコードのルートディレクトリから見たモジュー
                       ルソースコードへの相対ディレクトリ
       MOD_PATCH    :  3.で用意したパッチファイルの名前（複数ある場合は
                       半角の空白で区切って並べて指定してください。）
    尚、当パッケージのsampleディレクトリにmkkmodule.confのサンプルファイルがあ
    りますので、ご活用ください。

  5.mkkmoduleスクリプトを実行してください。

  6.途中でエラーなどが発生した場合は、rpmパッケージ作成用ディレクトリのSPECS
    ディレクトリへ移動して次のコマンドを実行して、エラー発生時までに作成された
    ファイルなどを削除しておいてください。


 B.再構築したカーネルを使う場合

  *.注意事項
     以前に自作カーネルのソースツリーで以下のコマンドを実行してしまっていた場
     合、当プログラムではモジュールの作成を行うことができません。
       # make mrproper
       # make distclean
     尚、以下の文章ではカーネルソースツリーは/usr/src/linux-x.y.zにあるものとし
     ます。

  1.自作カーネルのソースツリーへのシンボリックリンクを/usr/src/linuxとして作成
    してください（root権限が必要です）。
       # ln -s /usr/src/linux-x.y.z /usr/src/linux
 
  2.作業用のディレクトリを作成して（名前は任意のもので結構です）、そのディレク
    トリへ移動してください。
       $ mkdir build
       $ cd build

  3〜5は上記のrpm系ディストリビューションに付属するカーネルを使う場合と同じで
    す。

  6.途中でエラーなどが発生した場合は、作業用のディレクトリを丸ごと削除しておい
    てください。


* 謝辞
  - 当プログラムは下記の団体によるプログラムを元にして作成いたしました。関係者
    の方々には深くお礼申し上げます。

    Linux-NTFS Project <http://www.linux-ntfs.org/>
        URL   : <http://data.linux-ntfs.org/rpm/build-2.6>
      LICENSE : GNU GPL

