# @ECLASS: linux-mod.eclass

# @MAINTAINER:

# kernel-misc@gentoo.org

# @BLURB: It provides the functionality required to install external modules against a kernel source tree.

# @DESCRIPTION:

# This eclass is used to interface with linux-info.eclass in such a way

# to provide the functionality and initial functions

# required to install external modules against a kernel source

# tree.

# @ECLASS-VARIABLE: MODULESD_<modulename>_ENABLED

# @DESCRIPTION:

# This is used to disable the modprobe.d/modules.d file generation otherwise the file will be

# always generated (unless no MODULESD_<modulename>_* variable is provided). Set to "no" to disable

# the generation of the file and the installation of the documentation.

# @ECLASS-VARIABLE: MODULESD_<modulename>_EXAMPLES

# @DESCRIPTION:

# This is a bash array containing a list of examples which should

# be used. If you want us to try and take a guess set this to "guess".

#

# For each array_component it's added an options line in the modprobe.d/modules.d file

#   options array_component

# @FUNCTION: use_m

# @RETURN: true or false

# @DESCRIPTION:

# It checks if the kernel version is greater than 2.6.5.

# @FUNCTION: convert_to_m

# @USAGE: /path/to/the/file

# @DESCRIPTION:

# It converts a file (e.g. a makefile) to use M= instead of SUBDIRS=

# internal function

#

# FUNCTION: update_depmod

# DESCRIPTION:

# It updates the modules.dep file for the current kernel.

# internal function

#

# FUNCTION: update_modules

# DESCRIPTION:

# It calls the update-modules utility.

# internal function

#

# FUNCTION: move_old_moduledb

# DESCRIPTION:

# It updates the location of the database used by the module-rebuild utility.

# internal function

#

# FUNCTION: update_moduledb

# DESCRIPTION:

# It adds the package to the /var/lib/module-rebuild/moduledb database used by the module-rebuild utility.

# internal function

#

# FUNCTION: remove_moduledb

# DESCRIPTION:

# It removes the package from the /var/lib/module-rebuild/moduledb database used by

# the module-rebuild utility.

# @FUNCTION: set_kvobj

# @DESCRIPTION:

# It sets the KV_OBJ variable.

# internal function

#

# FUNCTION:

# USAGE: /path/to/the/modulename_without_extension

# RETURN: A file in /etc/modules.d/ (kernel < 2.6) or /etc/modprobe.d/ (kernel >= 2.6)

# DESCRIPTION:

# This function will generate and install the neccessary modprobe.d/modules.d file from the

# information contained in the modules exported parms.

# (see the variables MODULESD_<modulename>_ENABLED, MODULESD_<modulename>_EXAMPLES,

# MODULESD_<modulename>_ALIASES, MODULESD_<modulename>_ADDITION and MODULESD_<modulename>_DOCS).

#

# At the end the documentation specified with MODULESD_<modulename>_DOCS is installed.

# internal function

#

# FUNCTION: find_module_params

# USAGE: A string "NAME(LIBDIR:SRCDIR:OBJDIR)"

# RETURN: The string "modulename:NAME libdir:LIBDIR srcdir:SRCDIR objdir:OBJDIR"

# DESCRIPTION:

# Analyze the specification NAME(LIBDIR:SRCDIR:OBJDIR) of one module as described in MODULE_NAMES.

# @FUNCTION: linux-mod_pkg_setup

# @DESCRIPTION:

# It checks the CONFIG_CHECK options (see linux-info.eclass(5)), verifies that the kernel is

# configured, verifies that the sources are prepared, verifies that the modules support is builtin

# in the kernel and sets the object extension KV_OBJ.

# @FUNCTION: linux-mod_src_compile

# @DESCRIPTION:

# It compiles all the modules specified in MODULE_NAMES. For each module the econf command is

# executed only if ECONF_PARAMS is defined, the name of the target is specified by BUILD_TARGETS

# while the options are in BUILD_PARAMS (all the modules share these variables). The compilation

# happens inside ${srcdir}.

#

# Look at the description of these variables for more details.

# @FUNCTION: linux-mod_src_install

# @DESCRIPTION:

# It install the modules specified in MODULES_NAME. The modules should be inside the ${objdir}

# directory and they are installed inside /lib/modules/${KV_FULL}/${libdir}.

#

# The modprobe.d/modules.d configuration file is automatically generated if the

# MODULESD_<modulename>_* variables are defined. The only way to stop this process is by

# setting MODULESD_<modulename>_ENABLED=no. At the end the documentation specified via

# MODULESD_<modulename>_DOCS is also installed.

#

# Look at the description of these variables for more details.

# @FUNCTION: linux-mod_pkg_preinst

# @DESCRIPTION:

# It checks what to do after having merged the package.

# @FUNCTION: linux-mod_pkg_postinst

# @DESCRIPTION:

# It executes /sbin/depmod and adds the package to the /var/lib/module-rebuild/moduledb

# database (if ${D}/lib/modules is created) and it runs /sbin/update-modules

# (if ${D}/etc/modules.d is created).

# @FUNCTION: linux-mod_pkg_postrm

# @DESCRIPTION:

# It removes the package from the /var/lib/module-rebuild/moduledb database but it doens't

# call /sbin/depmod and /sbin/update-modules because the modules are still installed.