From 4fe3b214a13873d491421c77cf7176d744e42d61 Mon Sep 17 00:00:00 2001 From: Daniel Drake Date: Fri, 31 Oct 2008 21:25:56 +0000 Subject: add some documentation, patch from Eric Brown in bug #190934 --- eclass/linux-mod.eclass | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'eclass') diff --git a/eclass/linux-mod.eclass b/eclass/linux-mod.eclass index 2a562283a245..8a085e197473 100644 --- a/eclass/linux-mod.eclass +++ b/eclass/linux-mod.eclass @@ -1,6 +1,6 @@ # Copyright 1999-2004 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 -# $Header: /var/cvsroot/gentoo-x86/eclass/linux-mod.eclass,v 1.84 2008/10/27 05:22:13 vapier Exp $ +# $Header: /var/cvsroot/gentoo-x86/eclass/linux-mod.eclass,v 1.85 2008/10/31 21:25:56 dsd Exp $ # Description: This eclass is used to interface with linux-info in such a way # to provide the functionality required and initial functions @@ -37,6 +37,20 @@ # # The structure of each MODULE_NAMES entry is as follows: # modulename(libdir:srcdir:objdir) +# +# modulename = name of the module file excluding the .ko +# libdir = place in system modules directory where module is installed: +# srcdir = place for ebuild to cd to before running make +# objdir = place the .ko and objects are located after make runs +# +# To get an idea of how these variables are used, here's a few lines +# of code from around line 540 in this eclass: +# +# einfo "Installing ${modulename} module" +# cd ${objdir} || die "${objdir} does not exist" +# insinto /lib/modules/${KV_FULL}/${libdir} +# doins ${modulename}.${KV_OBJ} || die "doins ${modulename}.${KV_OBJ} failed" +# # for example: # MODULE_NAMES="module_pci(pci:${S}/pci:${S}) module_usb(usb:${S}/usb:${S})" # -- cgit v1.2.3-65-gdbad