mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-03 02:02:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: added module_autoload and module_conf variables.

Browse Source 
Fixes [YOCTO #5888]

Two new variables added to the glossary.  These help with
specifying kernel modules that need to auto-load on boot and
with specifying module.d syntax in the modname.conf file.

(From yocto-docs rev: 1ac544c4f6129faafea10691b426cd510ff56a69)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2014-04-10 08:05:37 -07:00
committed by Richard Purdie
parent 89dd1639e7
commit d40aae9a92
1 changed files with 93 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
documentation/ref-manual/ref-variables.xml
View File

@@ -4655,6 +4655,99 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-module_autoload'><glossterm>module_autoload</glossterm>
<glossdef>
<para>
Lists kernel modules that need to be auto-loaded during
boot.
</para>
<para>
You can use this variable anywhere (e.g. machine
configuration file or a distribution configuration file)
including an append file for an
out-of-tree kernel module recipe.
</para>
<para>
Specify it as follows:
<literallayout class='monospaced'>
module_autoload_&lt;modname&gt; = "modname1 modname2 modname3"
</literallayout>
You must use the kernel module name override.
</para>
<para>
Including <filename>module_autoload</filename> causes the
OpenEmbedded build system to populate the
<filename>/etc/modules-load.d/modname.conf</filename>
file with the list of modules to be auto-loaded on boot.
The modules appear one-per-line in the file.
Here is an example of the most common use case:
<literallayout class='monospaced'>
module_autoload_modname = "modname"
</literallayout>
</para>
<para>
For information on how to populate the
<filename>modname.conf</filename> file with
<filename>modprobe.d</filename> syntax lines, see the
<link linkend='var-module_conf'><filename>module_conf</filename></link>
variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-module_conf'><glossterm>module_conf</glossterm>
<glossdef>
<para>
Specifies <filename>modprobe.d</filename> syntax lines
for inclusion in the
<filename>/etc/modprobe.d/modname.conf</filename> file.
</para>
<para>
You can use this variable anywhere (e.g. machine
configuration file or a distribution configuration file)
including an append file for an
out-of-tree kernel module recipe.
</para>
<para>
Here is the general syntax:
<literallayout class='monospaced'>
module_conf_&lt;modname&gt; = "modprobe.d-syntax"
</literallayout>
You must use the kernel module name override.
</para>
<para>
Run <filename>man modprobe.d</filename> in the shell to
find out more information on the exact syntax for lines
you want to provide with <filename>module_conf</filename>.
</para>
<para>
Including <filename>module_conf</filename> causes the
OpenEmbedded build system to populate the
<filename>/etc/modprobe.d/modname.conf</filename>
file with <filename>modprobe.d</filename> syntax lines.
Here is an example:
<literallayout class='monospaced'>
module_conf_&lt;modname&gt; = "options modname arg1=val1 arg2=val2"
</literallayout>
</para>
<para>
For information on how to specify kernel modules to
auto-load on boot, see the
<link linkend='var-module_autoload'><filename>module_autoload</filename></link>
variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm>
<glossdef>
<para>