summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-14 06:57:45 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-18 16:15:28 +0200
commit8eb706a41b040cf1397c2ebe5517c40031f4d1fb (patch)
treee712abfb9878b9ab803b7c862799b769b682f631 /documentation/ref-manual/ref-variables.xml
parent323929d1ee5d18da7aebf1e536706f00f65f4f35 (diff)
downloadpoky-8eb706a41b040cf1397c2ebe5517c40031f4d1fb.tar.gz
ref-manual, dev-manual: Applied migration review edits.
Applied the full set of first draft revision edits for the new migration section for 1.7. Comments from Paul Eggleton. (From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74) 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/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml83
1 files changed, 23 insertions, 60 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1cff5bdfaa..aadae01ac4 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4458,7 +4458,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4458 <para> 4458 <para>
4459 Specify it as follows: 4459 Specify it as follows:
4460 <literallayout class='monospaced'> 4460 <literallayout class='monospaced'>
4461 KERNEL_MODULE_AUTOLOAD = "modname1 modname2 modname3" 4461 KERNEL_MODULE_AUTOLOAD += "modname1 modname2 modname3"
4462 </literallayout> 4462 </literallayout>
4463 </para> 4463 </para>
4464 4464
@@ -4470,7 +4470,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4470 The modules appear one-per-line in the file. 4470 The modules appear one-per-line in the file.
4471 Here is an example of the most common use case: 4471 Here is an example of the most common use case:
4472 <literallayout class='monospaced'> 4472 <literallayout class='monospaced'>
4473 KERNEL_MODULE_AUTOLOAD = "modname" 4473 KERNEL_MODULE_AUTOLOAD += "modname"
4474 </literallayout> 4474 </literallayout>
4475 </para> 4475 </para>
4476 4476
@@ -4487,58 +4487,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4487 <glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm> 4487 <glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm>
4488 <glossdef> 4488 <glossdef>
4489 <para> 4489 <para>
4490 Specifies 4490 Provides a list of modules for which the OpenEmbedded
4491 <ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink> 4491 build system expects to find
4492 syntax lines for inclusion in the 4492 <link linkend='var-module_conf'><filename>module_conf_&lt;modname&gt;</filename></link>
4493 <filename>/etc/modprobe.d/modname.conf</filename> file. 4493 values that specify configuration for each of the modules.
4494 <note> 4494 For information on how to provide those module
4495 The <filename>KERNEL_MODULE_PROBECONF</filename> 4495 configurations, see the
4496 variable behaves the same as the 4496 <link linkend='var-module_conf'><filename>module_conf_*</filename></link>
4497 <link linkend='var-module_conf'><filename>module_conf</filename></link> 4497 variable.
4498 variable with the exception of not having to use a
4499 module name override.
4500 </note>
4501 </para>
4502
4503 <para>
4504 You can use the
4505 <filename>KERNEL_MODULE_PROBECONF</filename> variable
4506 anywhere it can be recognized by the kernel recipe or
4507 an out-of-tree kernel module recipe (e.g. a machine
4508 configuration file, a distribution configuration file, an
4509 append file for the recipe, or the recipe itself).
4510 </para>
4511
4512 <para>
4513 Here is the general syntax:
4514 <literallayout class='monospaced'>
4515 KERNEL_MODULE_PROBECONF = "&lt;modprobe.d syntax&gt;"
4516 </literallayout>
4517 </para>
4518
4519 <para>
4520 Run <filename>man modprobe.d</filename> in the shell to
4521 find out more information on the exact syntax
4522 you want to provide with <filename>KERNEL_MODULE_PROBECONF</filename>.
4523 </para>
4524
4525 <para>
4526 Including <filename>KERNEL_MODULE_PROBECONF</filename> causes
4527 the OpenEmbedded build system to populate the
4528 <filename>/etc/modprobe.d/modname.conf</filename>
4529 file with <filename>modprobe.d</filename> syntax lines.
4530 Here is an example that adds the options
4531 <filename>arg1</filename> and <filename>arg2</filename>
4532 to a module named <filename>mymodule</filename>:
4533 <literallayout class='monospaced'>
4534 KERNEL_MODULE_PROBECONF = "options mymodule arg1=val1 arg2=val2"
4535 </literallayout>
4536 </para>
4537
4538 <para>
4539 For information on how to specify kernel modules to
4540 auto-load on boot, see the
4541 <filename>KERNEL_MODULE_AUTOLOAD</filename> variable.
4542 </para> 4498 </para>
4543 </glossdef> 4499 </glossdef>
4544 </glossentry> 4500 </glossentry>
@@ -5410,12 +5366,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5410 <para> 5366 <para>
5411 This variable has been replaced by the 5367 This variable has been replaced by the
5412 <filename>KERNEL_MODULE_AUTOLOAD</filename> variable. 5368 <filename>KERNEL_MODULE_AUTOLOAD</filename> variable.
5413 You should replace all occurrences of the 5369 You should replace all occurrences of
5414 <filename>module_autoload</filename> variable with 5370 <filename>module_autoload</filename> with additions to
5415 <filename>KERNEL_MODULE_AUTOLOAD</filename> variables. 5371 <filename>KERNEL_MODULE_AUTOLOAD</filename>, for example:
5372 <literallayout class='monospaced'>
5373 module_autoload_rfcomm = "rfcomm"
5374 </literallayout>
5375 should now be replaced with:
5376 <literallayout class='monospaced'>
5377 KERNEL_MODULE_AUTOLOAD += "rfcomm"
5378 </literallayout>
5416 See the 5379 See the
5417 <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> 5380 <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
5418 variable for a description of the variable. 5381 variable for more information.
5419 </para> 5382 </para>
5420 </glossdef> 5383 </glossdef>
5421 </glossentry> 5384 </glossentry>
@@ -5437,7 +5400,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5437 recipe, or the recipe itself). 5400 recipe, or the recipe itself).
5438 If you use this variable, you must also be sure to list 5401 If you use this variable, you must also be sure to list
5439 the module name in the 5402 the module name in the
5440 <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link> 5403 <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
5441 variable. 5404 variable.
5442 </para> 5405 </para>
5443 5406
@@ -5471,7 +5434,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5471 <para> 5434 <para>
5472 For information on how to specify kernel modules to 5435 For information on how to specify kernel modules to
5473 auto-load on boot, see the 5436 auto-load on boot, see the
5474 <link linkend='var-module_autoload'><filename>module_autoload</filename></link> 5437 <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
5475 variable. 5438 variable.
5476 </para> 5439 </para>
5477 </glossdef> 5440 </glossdef>