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

* Update Information
  - see NEWS and ChangeLog files.

* Feature
  - This program makes kernel modules with your linux kernel source tree.
  - It is unnecessary to build whole linux kernel.
  - This program lets none root users make modules.

* License
  - GNU GPL version2. see COPYING file for detail information.

* How to Install
  - see INSTALL file.

* Usage
 A. In case that you use the kernel which is installed with rpm package.
  1.Download kernel source rpm package for your booting kernel. For example,
    if you are using kernel-w.x.y-z.arch.rpm, then download
    kernel-w.x.y-z.src.rpm.

  2.Install the downloaded kernel source package.
      $ rpm -ivh kernel-w.x.y-z.src.rpm 2>/dev/null

  3.If you want to apply patch files, copy all patch files to current
    directory.

  4.Make mkkmodule.conf to current directory. Use mkkmodule.conf.template as a
    template. Edit these variables.
      MOD_NAME    : module name
      MOD_COMPOPT : module compile options
      MOD_SRCDIR  : relative path from kernel source code root directory to
                    module source code one
      MOD_PATCH   : patch files

  5.Run mkkmodule script.
      $ mkkmodule

  6.If some error occures and interrupts this script, then run the following
    command in the SPECS directory which is in rpm build directory.
      $ rpmbuild --clean kernel*.spec

 B.In case that you use your recompiled kernel.
  *.Caution
    If you run the following commands, then you cannot make kernel modules with
    this script.
      # make mrproper
      # make distclean

  1.Make symlink to your kernel source code.
      # ln -s /usr/src/linux-x.y.z /usr/src/linux

  2.Make work directory, and move into it.
      $ mkdir build
      $ cd build

  3, 4, 5. is the same as A. process.
  
  6.If some error occures and interrupts this script, then remove work
    directory.


* Acknowledgement
  - This program is based on build-2.6 script made by Linux-NTFS Project. I
    greatly appreciate this project.

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

