ref-manual: Added new KERNEL_MODULE_PROBECONF variable

Added this new variable to the variable glossary.

(From yocto-docs rev: d2d75631777f6cef3472bde428ed65419c99457e)

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-10-13 10:31:14 -07:00
committed by Richard Purdie
parent 55169b9141
commit d6c0a7d540

View File

@@ -4434,6 +4434,65 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm>
<glossdef>
<para>
Specifies
<ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink>
syntax lines for inclusion in the
<filename>/etc/modprobe.d/modname.conf</filename> file.
<note>
The <filename>KERNEL_MODULE_PROBECONF</filename>
variable behaves the same as the
<link linkend='var-module_conf'><filename>module_conf</filename></link>
variable with the exception of not having to use a
module name override.
</note>
</para>
<para>
You can use the
<filename>KERNEL_MODULE_PROBECONF</filename> variable
anywhere it can be recognized by the kernel recipe or
an out-of-tree kernel module recipe (e.g. a machine
configuration file, a distribution configuration file, an
append file for the recipe, or the recipe itself).
</para>
<para>
Here is the general syntax:
<literallayout class='monospaced'>
KERNEL_MODULE_PROBECONF = "&lt;modprobe.d syntax&gt;"
</literallayout>
</para>
<para>
Run <filename>man modprobe.d</filename> in the shell to
find out more information on the exact syntax
you want to provide with <filename>KERNEL_MODULE_PROBECONF</filename>.
</para>
<para>
Including <filename>KERNEL_MODULE_PROBECONF</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 that adds the options
<filename>arg1</filename> and <filename>arg2</filename>
to a module named <filename>mymodule</filename>:
<literallayout class='monospaced'>
KERNEL_MODULE_PROBECONF = "options mymodule arg1=val1 arg2=val2"
</literallayout>
</para>
<para>
For information on how to specify kernel modules to
auto-load on boot, see the
<filename>KERNEL_MODULE_AUTOLOAD</filename> variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-KERNEL_PATH'><glossterm>KERNEL_PATH</glossterm>
<glossdef>
<para>