mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-04 13:39:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation: dev-manual - Final changes before 1.3 lockdown.

Browse Source 
Made minor changes as needed due to some new sections, links,
and capitalization standards.

(From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77)

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
2012-10-22 13:16:49 -07:00
committed by Richard Purdie
parent 0526e01ddf
commit be3c73bc02
4 changed files with 79 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
documentation/dev-manual/dev-manual-model.xml
View File

@@ -236,7 +236,7 @@
"<link linkend='patching-the-kernel'>Patching the Kernel</link>" section
for an example that changes the source code of the kernel.
For information on how to configure the kernel, see the
"<link linkend='configuring-the-kernel'>Configuring the Kernel</link> section.
"<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section.
</para>
<section id='kernel-overview'>
@@ -347,7 +347,8 @@
What happens during the build?
When you build the kernel on your development system, all files needed for the build
are taken from the source repositories pointed to by the
<filename>SRC_URI</filename> variable and gathered in a temporary work area
<ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable
and gathered in a temporary work area
where they are subsequently used to create the unique kernel.
Thus, in a sense, the process constructs a local source tree specific to your
kernel to generate the new kernel image - a source generator if you will.
@@ -394,8 +395,8 @@
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
in the Yocto Project Quick Start for requirements.</para></listitem>
<listitem><para><emphasis>Establish a local copy of project files on your
system</emphasis>: Having the <link linkend='source-directory'>source
directory</link> on your system gives you access to the build process and tools
system</emphasis>: Having the <link linkend='source-directory'>Source
Directory</link> on your system gives you access to the build process and tools
you need.
For information on how to get these files, see the bulleted item
"<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual.
@@ -439,7 +440,7 @@
<filename>.config</filename>.
Try to resist the temptation of directly editing the <filename>.config</filename>
file found in the
<link linkend='build-directory'>build directory</link> at
<link linkend='build-directory'>Build Directory</link> at
<filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>.
Doing so, can produce unexpected results when the OpenEmbedded build system
regenerates the configuration file.</para>
@@ -986,10 +987,10 @@
<listitem><para><emphasis>
<filename>Build System Derived Toolchain:</filename></emphasis>
Select this mode if the cross-toolchain has been installed and built
as part of the build directory.
as part of the Build Directory.
When you select <filename>Build system derived toolchain</filename>,
you are using the toolchain bundled
inside the build directory.
inside the Build Directory.
</para></listitem>
</itemizedlist>
</para></listitem>
@@ -1008,9 +1009,9 @@
However, doing so is discouraged.</note></para>
<para>If you are using a system-derived toolchain, the path you provide
for the <filename>Toolchain Root Location</filename>
field is the build directory.
field is the Build Directory.
See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using
BitBake and the build directory</ulink>" section in the Yocto Project Application
BitBake and the Build Directory</ulink>" section in the Yocto Project Application
Developer's Guide for information on how to install the toolchain into the build
directory.</para></listitem>
<listitem><para><emphasis>Specify the Sysroot Location:</emphasis>
@@ -1053,7 +1054,7 @@ directory.</para></listitem>
and specify any custom options.</para>
<para>If you selected <filename>Build system derived toolchain</filename>,
the target kernel you built will be located in the
build directory in <filename>tmp/deploy/images</filename> directory.
Build Directory in <filename>tmp/deploy/images</filename> directory.
If you selected <filename>Standalone pre-built toolchain</filename>, the
pre-built image you downloaded is located
in the directory you specified when you downloaded the image.</para>
@@ -1409,7 +1410,7 @@ directory.</para></listitem>
<orderedlist>
<listitem><para>Select your Yocto Bitbake Commander project.</para></listitem>
<listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem>
<listitem><para>Enter the build directory where you want to put your final images.</para></listitem>
<listitem><para>Enter the Build Directory where you want to put your final images.</para></listitem>
<listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem>
<listitem><para>Use Hob to customize and build your own images.
For information on Hob, see the
@@ -1480,7 +1481,7 @@ directory.</para></listitem>
to figure out your solution.
After you have initially built the package, you can iteratively tweak the
source code, which is located in the
<link linkend='build-directory'>build directory</link>, and then
<link linkend='build-directory'>Build Directory</link>, and then
you can force a re-compile and quickly test your altered code.
Once you settle on a solution, you can then preserve your changes in the form of
patches.
@@ -1494,7 +1495,7 @@ directory.</para></listitem>
<para>
During a build, the unpacked temporary source code used by recipes
to build packages is available in the build directory as
to build packages is available in the Build Directory as
defined by the
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable.
Below is the default value for the <filename>S</filename> variable as defined in the
@@ -1528,7 +1529,7 @@ directory.</para></listitem>
Let's look at an example without variables.
Assuming a top-level <link linkend='source-directory'>Source Directory</link>
named <filename>poky</filename>
and a default build directory of <filename>poky/build</filename>,
and a default Build Directory of <filename>poky/build</filename>,
the following is the work directory for the <filename>acl</filename> recipe that
creates the <filename>acl</filename> package:
<literallayout class='monospaced'>
@@ -1543,7 +1544,7 @@ directory.</para></listitem>
${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
</literallayout>
Again, assuming top-level Source Directory named <filename>poky</filename>
and a default build directory of <filename>poky/build</filename>, the
and a default Build Directory of <filename>poky/build</filename>, the
following are the work and temporary source directories, respectively,
for the <filename>acl</filename> package that is being
built for a MIPS-based device:
@@ -1591,7 +1592,7 @@ directory.</para></listitem>
<orderedlist>
<listitem><para><emphasis>Find the Source Code:</emphasis>
The temporary source code used by the OpenEmbedded build system is kept in the
build directory.
Build Directory.
See the
"<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
section to learn how to locate the directory that has the temporary source code for a
@@ -1689,7 +1690,7 @@ directory.</para></listitem>
<orderedlist>
<listitem><para><emphasis>Find the Source Code:</emphasis>
The temporary source code used by the OpenEmbedded build system is kept in the
build directory.
Build Directory.
See the
"<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
section to learn how to locate the directory that has the temporary source code for a