summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-11 12:26:41 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-13 16:29:53 +0000
commitcf1a1b9a0848dde7f1816cb7bb8abb7a6292cc07 (patch)
tree7ebdda4ddaa21125cf2d2176b0ee1f59e6af18f8
parent7cea11f64d819cc02965a8e13251911861b7da7f (diff)
downloadpoky-cf1a1b9a0848dde7f1816cb7bb8abb7a6292cc07.tar.gz
poky-cf1a1b9a0848dde7f1816cb7bb8abb7a6292cc07.tar.bz2
poky-cf1a1b9a0848dde7f1816cb7bb8abb7a6292cc07.zip
ref-manual: Added module and module-base classes.
(From yocto-docs rev: be1e564483299a018e28f1971dbe85f8485c9b83) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml38
1 files changed, 37 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 1dad284762..aae306224f 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1546,7 +1546,6 @@
Various other classes are used by the <filename>kernel</filename>
and <filename>module</filename> classes internally including the
<link linkend='ref-classes-kernel-arch'><filename>kernel-arch</filename></link>,
- <link linkend='ref-classes-module_strip'><filename>module_strip</filename></link>,
<link linkend='ref-classes-module-base'><filename>module-base</filename></link>,
and
<link linkend='ref-classes-linux-kernel-base'><filename>linux-kernel-base</filename></link>
@@ -1698,6 +1697,43 @@
</para>
</section>
+<section id='ref-classes-module'>
+ <title><filename>module.bbclass</filename></title>
+
+ <para>
+ The <filename>module</filename> class provides support for building
+ out-of-tree Linux kernel modules.
+ The class inherits the
+ <link linkend='ref-classes-module-base'><filename>module-base</filename></link>
+ and
+ <link linkend='ref-classes-kernel-module-split'><filename>kernel-module-split</filename></link>
+ classes, and implements <filename>do_compile</filename> and
+ <filename>do_install</filename> functions.
+ The class provides everything needed to build and package a kernel
+ module.
+ </para>
+
+ <para>
+ For general information on out-of-tree Linux kernel modules, see the
+ "<ulink url='&YOCTO_DOCS_KERNEL_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
+ section in the Yocto Project Linux Kernel Development Manual.
+ </para>
+</section>
+
+<section id='ref-classes-module-base'>
+ <title><filename>module-base.bbclass</filename></title>
+
+ <para>
+ The <filename>module-base</filename> class provides the base
+ functionality for building Linux kernel modules.
+ Typically, a recipe that builds software that includes one or
+ more kernel modules and has its own means of building
+ the module inherits this class as opposed to inheriting the
+ <link linkend='ref-classes-module'><filename>module</filename></link>
+ class.
+ </para>
+</section>
+
<section id='ref-classes-multilib*'>
<title><filename>multilib*.bbclass</filename></title>