summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-04-10 08:05:37 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-11 18:22:51 +0100
commitd40aae9a92bb4e29c0887e40950e75c129cc256c (patch)
tree3c34a7e8aa586628c4792a4229c7749ea95efc76 /documentation/ref-manual
parent89dd1639e7ed64214e24d34f13268981e28c69fd (diff)
downloadpoky-d40aae9a92bb4e29c0887e40950e75c129cc256c.tar.gz
ref-manual: added module_autoload and module_conf variables.
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml93
1 files changed, 93 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 46a9de9856..59ce7136ee 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4655,6 +4655,99 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4655 </glossdef> 4655 </glossdef>
4656 </glossentry> 4656 </glossentry>
4657 4657
4658 <glossentry id='var-module_autoload'><glossterm>module_autoload</glossterm>
4659 <glossdef>
4660 <para>
4661 Lists kernel modules that need to be auto-loaded during
4662 boot.
4663 </para>
4664
4665 <para>
4666 You can use this variable anywhere (e.g. machine
4667 configuration file or a distribution configuration file)
4668 including an append file for an
4669 out-of-tree kernel module recipe.
4670 </para>
4671
4672 <para>
4673 Specify it as follows:
4674 <literallayout class='monospaced'>
4675 module_autoload_&lt;modname&gt; = "modname1 modname2 modname3"
4676 </literallayout>
4677 You must use the kernel module name override.
4678 </para>
4679
4680 <para>
4681 Including <filename>module_autoload</filename> causes the
4682 OpenEmbedded build system to populate the
4683 <filename>/etc/modules-load.d/modname.conf</filename>
4684 file with the list of modules to be auto-loaded on boot.
4685 The modules appear one-per-line in the file.
4686 Here is an example of the most common use case:
4687 <literallayout class='monospaced'>
4688 module_autoload_modname = "modname"
4689 </literallayout>
4690 </para>
4691
4692 <para>
4693 For information on how to populate the
4694 <filename>modname.conf</filename> file with
4695 <filename>modprobe.d</filename> syntax lines, see the
4696 <link linkend='var-module_conf'><filename>module_conf</filename></link>
4697 variable.
4698 </para>
4699 </glossdef>
4700 </glossentry>
4701
4702 <glossentry id='var-module_conf'><glossterm>module_conf</glossterm>
4703 <glossdef>
4704 <para>
4705 Specifies <filename>modprobe.d</filename> syntax lines
4706 for inclusion in the
4707 <filename>/etc/modprobe.d/modname.conf</filename> file.
4708 </para>
4709
4710 <para>
4711 You can use this variable anywhere (e.g. machine
4712 configuration file or a distribution configuration file)
4713 including an append file for an
4714 out-of-tree kernel module recipe.
4715 </para>
4716
4717 <para>
4718 Here is the general syntax:
4719 <literallayout class='monospaced'>
4720 module_conf_&lt;modname&gt; = "modprobe.d-syntax"
4721 </literallayout>
4722 You must use the kernel module name override.
4723 </para>
4724
4725 <para>
4726 Run <filename>man modprobe.d</filename> in the shell to
4727 find out more information on the exact syntax for lines
4728 you want to provide with <filename>module_conf</filename>.
4729 </para>
4730
4731 <para>
4732 Including <filename>module_conf</filename> causes the
4733 OpenEmbedded build system to populate the
4734 <filename>/etc/modprobe.d/modname.conf</filename>
4735 file with <filename>modprobe.d</filename> syntax lines.
4736 Here is an example:
4737 <literallayout class='monospaced'>
4738 module_conf_&lt;modname&gt; = "options modname arg1=val1 arg2=val2"
4739 </literallayout>
4740 </para>
4741
4742 <para>
4743 For information on how to specify kernel modules to
4744 auto-load on boot, see the
4745 <link linkend='var-module_autoload'><filename>module_autoload</filename></link>
4746 variable.
4747 </para>
4748 </glossdef>
4749 </glossentry>
4750
4658 <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm> 4751 <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm>
4659 <glossdef> 4752 <glossdef>
4660 <para> 4753 <para>