diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-07-19 10:54:45 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-07-20 12:32:54 +0100 |
commit | 98a1fd1e734db50380a3a37d35767ccb4cc21f7c (patch) | |
tree | e567faa8d95cabadb8b9f812ae325140fdc77290 /documentation | |
parent | 24340ed5d1f153610a0452e48babcadd4fc50b63 (diff) | |
download | poky-98a1fd1e734db50380a3a37d35767ccb4cc21f7c.tar.gz |
documentation: Config fragment sections updated
I have updated both the section for configuration fragments found
in the BSP and dev manuals.
Reported-by: James Abernathy <jabernathy@gmail.com>
(From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/bsp-guide/bsp.xml | 22 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 46 |
2 files changed, 46 insertions, 22 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 0159f48848..05094ca77d 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -596,22 +596,22 @@ | |||
596 | </para> | 596 | </para> |
597 | 597 | ||
598 | <para> | 598 | <para> |
599 | For example, suppose you had a set of configuration options in a file called | 599 | For example, suppose you had a some configuration options in a file called |
600 | <filename>myconfig.cfg</filename>. | 600 | <filename>network_configs.cfg</filename>. |
601 | If you put that file inside a directory named <filename>/linux-yocto</filename> and then added | 601 | You can place that file inside a directory named <filename>/linux-yocto</filename> and then add |
602 | a <filename>SRC_URI</filename> statement such as the following to the append file, | 602 | a <filename>SRC_URI</filename> statement such as the following to the append file. |
603 | those configuration options will be picked up and applied when the kernel is built. | 603 | When the OpenEmbedded build system builds the kernel, the configuration options are |
604 | picked up and applied. | ||
604 | <literallayout class='monospaced'> | 605 | <literallayout class='monospaced'> |
605 | SRC_URI += "file://myconfig.cfg" | 606 | SRC_URI += "file://network_configs.cfg" |
606 | </literallayout> | 607 | </literallayout> |
607 | </para> | 608 | </para> |
608 | 609 | ||
609 | <para> | 610 | <para> |
610 | As mentioned earlier, you can group related configurations into multiple files and | 611 | To group related configurations into multiple files, you perform a similar procedure. |
611 | name them all in the <filename>SRC_URI</filename> statement as well. | 612 | Here is an example that groups separate configurations specifically for Ethernet and graphics |
612 | For example, you could group separate configurations specifically for Ethernet and graphics | 613 | into their own files and adds the configurations |
613 | into their own files and add those by using a <filename>SRC_URI</filename> statement like the | 614 | by using a <filename>SRC_URI</filename> statement like the following in your append file: |
614 | following in your append file: | ||
615 | <literallayout class='monospaced'> | 615 | <literallayout class='monospaced'> |
616 | SRC_URI += "file://myconfig.cfg \ | 616 | SRC_URI += "file://myconfig.cfg \ |
617 | file://eth.cfg \ | 617 | file://eth.cfg \ |
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index d96d78d49e..b8708ff19f 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -1362,18 +1362,29 @@ | |||
1362 | </section> | 1362 | </section> |
1363 | 1363 | ||
1364 | <section id='creating-config-fragments'> | 1364 | <section id='creating-config-fragments'> |
1365 | <title>Creating Config Fragments</title> | 1365 | <title>Creating Configuration Fragments</title> |
1366 | 1366 | ||
1367 | <para> | 1367 | <para> |
1368 | Configuration fragments are simply kernel options that appear in a file. | 1368 | Configuration fragments are simply kernel options that appear in a file |
1369 | placed where the OpenEmbedded build system can find and apply them. | ||
1369 | Syntactically, the configuration statement is identical to what would appear | 1370 | Syntactically, the configuration statement is identical to what would appear |
1370 | in the <filename>.config</filename>. | 1371 | in the <filename>.config</filename> file, which is in the |
1371 | For example, issuing the following from the shell would create a config fragment | 1372 | <link linkend='build-directory'>build directory</link> in |
1373 | <filename>tmp/work/<arch>-poky-linux/linux-yocto-<release-specific-string>/linux-<arch>-<build-type></filename>. | ||
1374 | </para> | ||
1375 | |||
1376 | <para> | ||
1377 | It is simple to create a configuration fragment. | ||
1378 | For example, issuing the following from the shell creates a configuration fragment | ||
1372 | file named <filename>my_smp.cfg</filename> that enables multi-processor support | 1379 | file named <filename>my_smp.cfg</filename> that enables multi-processor support |
1373 | within the kernel: | 1380 | within the kernel: |
1374 | <literallayout class='monospaced'> | 1381 | <literallayout class='monospaced'> |
1375 | $ echo "CONFIG_SMP=y" >> my_smp.cfg | 1382 | $ echo "CONFIG_SMP=y" >> my_smp.cfg |
1376 | </literallayout> | 1383 | </literallayout> |
1384 | <note> | ||
1385 | All configuration files must use the <filename>.cfg</filename> extension in order | ||
1386 | for the OpenEmbedded build system to recognize them as a configuration fragment. | ||
1387 | </note> | ||
1377 | </para> | 1388 | </para> |
1378 | 1389 | ||
1379 | <para> | 1390 | <para> |
@@ -1382,15 +1393,28 @@ | |||
1382 | <filename>SRC_URI</filename>. | 1393 | <filename>SRC_URI</filename>. |
1383 | The OpenEmbedded build system will pick up the configuration and add it to the | 1394 | The OpenEmbedded build system will pick up the configuration and add it to the |
1384 | kernel's configuration. | 1395 | kernel's configuration. |
1385 | For example, assume you add the following to your | 1396 | For example, suppose you had a set of configuration options in a file called |
1386 | <filename>linux-yocto_3.0.bbappend</filename> file: | 1397 | <filename>myconfig.cfg</filename>. |
1398 | If you put that file inside a directory named <filename>/linux-yocto</filename> | ||
1399 | that resides in the same directory as the kernel's append file and then add | ||
1400 | a <filename>SRC_URI</filename> statement such as the following to the kernel's append file, | ||
1401 | those configuration options will be picked up and applied when the kernel is built. | ||
1402 | <literallayout class='monospaced'> | ||
1403 | SRC_URI += "file://myconfig.cfg" | ||
1404 | </literallayout> | ||
1405 | </para> | ||
1406 | |||
1407 | <para> | ||
1408 | As mentioned earlier, you can group related configurations into multiple files and | ||
1409 | name them all in the <filename>SRC_URI</filename> statement as well. | ||
1410 | For example, you could group separate configurations specifically for Ethernet and graphics | ||
1411 | into their own files and add those by using a <filename>SRC_URI</filename> statement like the | ||
1412 | following in your append file: | ||
1387 | <literallayout class='monospaced'> | 1413 | <literallayout class='monospaced'> |
1388 | file://my_smp.cfg | 1414 | SRC_URI += "file://myconfig.cfg \ |
1415 | file://eth.cfg \ | ||
1416 | file://gfx.cfg" | ||
1389 | </literallayout> | 1417 | </literallayout> |
1390 | You would put the config fragment file <filename>my_smp.cfg</filename> in a | ||
1391 | sub-directory with the same root name (<filename>linux-yocto</filename>) | ||
1392 | beneath the directory that contains your <filename>linux-yocto_3.0.bbappend</filename> | ||
1393 | file and the build system will pick up and apply the fragment. | ||
1394 | </para> | 1418 | </para> |
1395 | </section> | 1419 | </section> |
1396 | 1420 | ||