summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-model.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual/dev-manual-model.xml')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml35
1 files changed, 18 insertions, 17 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 4452d2a4e2..c14c524aa5 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -236,7 +236,7 @@
236 "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section 236 "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section
237 for an example that changes the source code of the kernel. 237 for an example that changes the source code of the kernel.
238 For information on how to configure the kernel, see the 238 For information on how to configure the kernel, see the
239 "<link linkend='configuring-the-kernel'>Configuring the Kernel</link> section. 239 "<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section.
240 </para> 240 </para>
241 241
242 <section id='kernel-overview'> 242 <section id='kernel-overview'>
@@ -347,7 +347,8 @@
347 What happens during the build? 347 What happens during the build?
348 When you build the kernel on your development system, all files needed for the build 348 When you build the kernel on your development system, all files needed for the build
349 are taken from the source repositories pointed to by the 349 are taken from the source repositories pointed to by the
350 <filename>SRC_URI</filename> variable and gathered in a temporary work area 350 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable
351 and gathered in a temporary work area
351 where they are subsequently used to create the unique kernel. 352 where they are subsequently used to create the unique kernel.
352 Thus, in a sense, the process constructs a local source tree specific to your 353 Thus, in a sense, the process constructs a local source tree specific to your
353 kernel to generate the new kernel image - a source generator if you will. 354 kernel to generate the new kernel image - a source generator if you will.
@@ -394,8 +395,8 @@
394 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both 395 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
395 in the Yocto Project Quick Start for requirements.</para></listitem> 396 in the Yocto Project Quick Start for requirements.</para></listitem>
396 <listitem><para><emphasis>Establish a local copy of project files on your 397 <listitem><para><emphasis>Establish a local copy of project files on your
397 system</emphasis>: Having the <link linkend='source-directory'>source 398 system</emphasis>: Having the <link linkend='source-directory'>Source
398 directory</link> on your system gives you access to the build process and tools 399 Directory</link> on your system gives you access to the build process and tools
399 you need. 400 you need.
400 For information on how to get these files, see the bulleted item 401 For information on how to get these files, see the bulleted item
401 "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual. 402 "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual.
@@ -439,7 +440,7 @@
439 <filename>.config</filename>. 440 <filename>.config</filename>.
440 Try to resist the temptation of directly editing the <filename>.config</filename> 441 Try to resist the temptation of directly editing the <filename>.config</filename>
441 file found in the 442 file found in the
442 <link linkend='build-directory'>build directory</link> at 443 <link linkend='build-directory'>Build Directory</link> at
443 <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>. 444 <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>.
444 Doing so, can produce unexpected results when the OpenEmbedded build system 445 Doing so, can produce unexpected results when the OpenEmbedded build system
445 regenerates the configuration file.</para> 446 regenerates the configuration file.</para>
@@ -986,10 +987,10 @@
986 <listitem><para><emphasis> 987 <listitem><para><emphasis>
987 <filename>Build System Derived Toolchain:</filename></emphasis> 988 <filename>Build System Derived Toolchain:</filename></emphasis>
988 Select this mode if the cross-toolchain has been installed and built 989 Select this mode if the cross-toolchain has been installed and built
989 as part of the build directory. 990 as part of the Build Directory.
990 When you select <filename>Build system derived toolchain</filename>, 991 When you select <filename>Build system derived toolchain</filename>,
991 you are using the toolchain bundled 992 you are using the toolchain bundled
992 inside the build directory. 993 inside the Build Directory.
993 </para></listitem> 994 </para></listitem>
994 </itemizedlist> 995 </itemizedlist>
995 </para></listitem> 996 </para></listitem>
@@ -1008,9 +1009,9 @@
1008 However, doing so is discouraged.</note></para> 1009 However, doing so is discouraged.</note></para>
1009 <para>If you are using a system-derived toolchain, the path you provide 1010 <para>If you are using a system-derived toolchain, the path you provide
1010 for the <filename>Toolchain Root Location</filename> 1011 for the <filename>Toolchain Root Location</filename>
1011 field is the build directory. 1012 field is the Build Directory.
1012 See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using 1013 See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using
1013 BitBake and the build directory</ulink>" section in the Yocto Project Application 1014 BitBake and the Build Directory</ulink>" section in the Yocto Project Application
1014 Developer's Guide for information on how to install the toolchain into the build 1015 Developer's Guide for information on how to install the toolchain into the build
1015directory.</para></listitem> 1016directory.</para></listitem>
1016 <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> 1017 <listitem><para><emphasis>Specify the Sysroot Location:</emphasis>
@@ -1053,7 +1054,7 @@ directory.</para></listitem>
1053 and specify any custom options.</para> 1054 and specify any custom options.</para>
1054 <para>If you selected <filename>Build system derived toolchain</filename>, 1055 <para>If you selected <filename>Build system derived toolchain</filename>,
1055 the target kernel you built will be located in the 1056 the target kernel you built will be located in the
1056 build directory in <filename>tmp/deploy/images</filename> directory. 1057 Build Directory in <filename>tmp/deploy/images</filename> directory.
1057 If you selected <filename>Standalone pre-built toolchain</filename>, the 1058 If you selected <filename>Standalone pre-built toolchain</filename>, the
1058 pre-built image you downloaded is located 1059 pre-built image you downloaded is located
1059 in the directory you specified when you downloaded the image.</para> 1060 in the directory you specified when you downloaded the image.</para>
@@ -1409,7 +1410,7 @@ directory.</para></listitem>
1409 <orderedlist> 1410 <orderedlist>
1410 <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem> 1411 <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem>
1411 <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem> 1412 <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem>
1412 <listitem><para>Enter the build directory where you want to put your final images.</para></listitem> 1413 <listitem><para>Enter the Build Directory where you want to put your final images.</para></listitem>
1413 <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem> 1414 <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem>
1414 <listitem><para>Use Hob to customize and build your own images. 1415 <listitem><para>Use Hob to customize and build your own images.
1415 For information on Hob, see the 1416 For information on Hob, see the
@@ -1480,7 +1481,7 @@ directory.</para></listitem>
1480 to figure out your solution. 1481 to figure out your solution.
1481 After you have initially built the package, you can iteratively tweak the 1482 After you have initially built the package, you can iteratively tweak the
1482 source code, which is located in the 1483 source code, which is located in the
1483 <link linkend='build-directory'>build directory</link>, and then 1484 <link linkend='build-directory'>Build Directory</link>, and then
1484 you can force a re-compile and quickly test your altered code. 1485 you can force a re-compile and quickly test your altered code.
1485 Once you settle on a solution, you can then preserve your changes in the form of 1486 Once you settle on a solution, you can then preserve your changes in the form of
1486 patches. 1487 patches.
@@ -1494,7 +1495,7 @@ directory.</para></listitem>
1494 1495
1495 <para> 1496 <para>
1496 During a build, the unpacked temporary source code used by recipes 1497 During a build, the unpacked temporary source code used by recipes
1497 to build packages is available in the build directory as 1498 to build packages is available in the Build Directory as
1498 defined by the 1499 defined by the
1499 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable. 1500 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable.
1500 Below is the default value for the <filename>S</filename> variable as defined in the 1501 Below is the default value for the <filename>S</filename> variable as defined in the
@@ -1528,7 +1529,7 @@ directory.</para></listitem>
1528 Let's look at an example without variables. 1529 Let's look at an example without variables.
1529 Assuming a top-level <link linkend='source-directory'>Source Directory</link> 1530 Assuming a top-level <link linkend='source-directory'>Source Directory</link>
1530 named <filename>poky</filename> 1531 named <filename>poky</filename>
1531 and a default build directory of <filename>poky/build</filename>, 1532 and a default Build Directory of <filename>poky/build</filename>,
1532 the following is the work directory for the <filename>acl</filename> recipe that 1533 the following is the work directory for the <filename>acl</filename> recipe that
1533 creates the <filename>acl</filename> package: 1534 creates the <filename>acl</filename> package:
1534 <literallayout class='monospaced'> 1535 <literallayout class='monospaced'>
@@ -1543,7 +1544,7 @@ directory.</para></listitem>
1543 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1544 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1544 </literallayout> 1545 </literallayout>
1545 Again, assuming top-level Source Directory named <filename>poky</filename> 1546 Again, assuming top-level Source Directory named <filename>poky</filename>
1546 and a default build directory of <filename>poky/build</filename>, the 1547 and a default Build Directory of <filename>poky/build</filename>, the
1547 following are the work and temporary source directories, respectively, 1548 following are the work and temporary source directories, respectively,
1548 for the <filename>acl</filename> package that is being 1549 for the <filename>acl</filename> package that is being
1549 built for a MIPS-based device: 1550 built for a MIPS-based device:
@@ -1591,7 +1592,7 @@ directory.</para></listitem>
1591 <orderedlist> 1592 <orderedlist>
1592 <listitem><para><emphasis>Find the Source Code:</emphasis> 1593 <listitem><para><emphasis>Find the Source Code:</emphasis>
1593 The temporary source code used by the OpenEmbedded build system is kept in the 1594 The temporary source code used by the OpenEmbedded build system is kept in the
1594 build directory. 1595 Build Directory.
1595 See the 1596 See the
1596 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" 1597 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
1597 section to learn how to locate the directory that has the temporary source code for a 1598 section to learn how to locate the directory that has the temporary source code for a
@@ -1689,7 +1690,7 @@ directory.</para></listitem>
1689 <orderedlist> 1690 <orderedlist>
1690 <listitem><para><emphasis>Find the Source Code:</emphasis> 1691 <listitem><para><emphasis>Find the Source Code:</emphasis>
1691 The temporary source code used by the OpenEmbedded build system is kept in the 1692 The temporary source code used by the OpenEmbedded build system is kept in the
1692 build directory. 1693 Build Directory.
1693 See the 1694 See the
1694 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" 1695 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
1695 section to learn how to locate the directory that has the temporary source code for a 1696 section to learn how to locate the directory that has the temporary source code for a