diff options
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 38 |
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 @@ | |||
| 1546 | Various other classes are used by the <filename>kernel</filename> | 1546 | Various other classes are used by the <filename>kernel</filename> |
| 1547 | and <filename>module</filename> classes internally including the | 1547 | and <filename>module</filename> classes internally including the |
| 1548 | <link linkend='ref-classes-kernel-arch'><filename>kernel-arch</filename></link>, | 1548 | <link linkend='ref-classes-kernel-arch'><filename>kernel-arch</filename></link>, |
| 1549 | <link linkend='ref-classes-module_strip'><filename>module_strip</filename></link>, | ||
| 1550 | <link linkend='ref-classes-module-base'><filename>module-base</filename></link>, | 1549 | <link linkend='ref-classes-module-base'><filename>module-base</filename></link>, |
| 1551 | and | 1550 | and |
| 1552 | <link linkend='ref-classes-linux-kernel-base'><filename>linux-kernel-base</filename></link> | 1551 | <link linkend='ref-classes-linux-kernel-base'><filename>linux-kernel-base</filename></link> |
| @@ -1698,6 +1697,43 @@ | |||
| 1698 | </para> | 1697 | </para> |
| 1699 | </section> | 1698 | </section> |
| 1700 | 1699 | ||
| 1700 | <section id='ref-classes-module'> | ||
| 1701 | <title><filename>module.bbclass</filename></title> | ||
| 1702 | |||
| 1703 | <para> | ||
| 1704 | The <filename>module</filename> class provides support for building | ||
| 1705 | out-of-tree Linux kernel modules. | ||
| 1706 | The class inherits the | ||
| 1707 | <link linkend='ref-classes-module-base'><filename>module-base</filename></link> | ||
| 1708 | and | ||
| 1709 | <link linkend='ref-classes-kernel-module-split'><filename>kernel-module-split</filename></link> | ||
| 1710 | classes, and implements <filename>do_compile</filename> and | ||
| 1711 | <filename>do_install</filename> functions. | ||
| 1712 | The class provides everything needed to build and package a kernel | ||
| 1713 | module. | ||
| 1714 | </para> | ||
| 1715 | |||
| 1716 | <para> | ||
| 1717 | For general information on out-of-tree Linux kernel modules, see the | ||
| 1718 | "<ulink url='&YOCTO_DOCS_KERNEL_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" | ||
| 1719 | section in the Yocto Project Linux Kernel Development Manual. | ||
| 1720 | </para> | ||
| 1721 | </section> | ||
| 1722 | |||
| 1723 | <section id='ref-classes-module-base'> | ||
| 1724 | <title><filename>module-base.bbclass</filename></title> | ||
| 1725 | |||
| 1726 | <para> | ||
| 1727 | The <filename>module-base</filename> class provides the base | ||
| 1728 | functionality for building Linux kernel modules. | ||
| 1729 | Typically, a recipe that builds software that includes one or | ||
| 1730 | more kernel modules and has its own means of building | ||
| 1731 | the module inherits this class as opposed to inheriting the | ||
| 1732 | <link linkend='ref-classes-module'><filename>module</filename></link> | ||
| 1733 | class. | ||
| 1734 | </para> | ||
| 1735 | </section> | ||
| 1736 | |||
| 1701 | <section id='ref-classes-multilib*'> | 1737 | <section id='ref-classes-multilib*'> |
| 1702 | <title><filename>multilib*.bbclass</filename></title> | 1738 | <title><filename>multilib*.bbclass</filename></title> |
| 1703 | 1739 | ||
