diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-07-02 14:34:39 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-07-03 14:55:03 +0100 |
commit | 5966b44893a39847d3d590566dd488323a11ff73 (patch) | |
tree | 4cc4c8a6fd8403ea0d9708eb9c449d1e0b8eded2 /documentation/poky-ref-manual/usingpoky.xml | |
parent | 7064538309121c23323d442db6c9f0b11c8d6431 (diff) | |
download | poky-5966b44893a39847d3d590566dd488323a11ff73.tar.gz |
documentation/poky-ref-manual: Yocto Project scrub
I have changed as many "Yocto Project" terms as possible so that
better reflect reality.
(From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/usingpoky.xml')
-rw-r--r-- | documentation/poky-ref-manual/usingpoky.xml | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index 914a0f5771..6ce36014f1 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml | |||
@@ -8,15 +8,15 @@ | |||
8 | <para> | 8 | <para> |
9 | This chapter describes common usage for the Yocto Project. | 9 | This chapter describes common usage for the Yocto Project. |
10 | The information is introductory in nature as other manuals in the Yocto Project | 10 | The information is introductory in nature as other manuals in the Yocto Project |
11 | provide more details on how to use the Yocto Project. | 11 | documentation set provide more details on how to use the Yocto Project. |
12 | </para> | 12 | </para> |
13 | 13 | ||
14 | <section id='usingpoky-build'> | 14 | <section id='usingpoky-build'> |
15 | <title>Running a Build</title> | 15 | <title>Running a Build</title> |
16 | 16 | ||
17 | <para> | 17 | <para> |
18 | You can find general information on how to build an image using the | 18 | You can find general information on how to build an image using the OpenEmbedded build |
19 | Yocto Project in the | 19 | system in the |
20 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" | 20 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" |
21 | section of The Yocto Project Quick Start. | 21 | section of The Yocto Project Quick Start. |
22 | This section provides a summary of the build process and provides information | 22 | This section provides a summary of the build process and provides information |
@@ -36,7 +36,7 @@ | |||
36 | 36 | ||
37 | <para> | 37 | <para> |
38 | The <filename>build_dir</filename> is optional and specifies the directory Yocto Project | 38 | The <filename>build_dir</filename> is optional and specifies the directory Yocto Project |
39 | uses for the build. | 39 | uses for the build - the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. |
40 | If you do not specify a build directory it defaults to <filename>build</filename> | 40 | If you do not specify a build directory it defaults to <filename>build</filename> |
41 | in your current working directory. | 41 | in your current working directory. |
42 | A common practice is to use a different build directory for different targets. | 42 | A common practice is to use a different build directory for different targets. |
@@ -56,11 +56,11 @@ | |||
56 | <para> | 56 | <para> |
57 | The <filename>target</filename> is the name of the recipe you want to build. | 57 | The <filename>target</filename> is the name of the recipe you want to build. |
58 | Common targets are the images in <filename>meta/recipes-core/images</filename>, | 58 | Common targets are the images in <filename>meta/recipes-core/images</filename>, |
59 | <filename>/meta/recipes-sato/images</filename>, etc. all found in the Yocto Project | 59 | <filename>/meta/recipes-sato/images</filename>, etc. all found in the |
60 | files. | 60 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. |
61 | Or, the target can be the name of a recipe for a specific piece of software such as | 61 | Or, the target can be the name of a recipe for a specific piece of software such as |
62 | <application>busybox</application>. | 62 | <application>busybox</application>. |
63 | For more details about the images the Yocto Project supports, see the | 63 | For more details about the images the OpenEmbedded build system supports, see the |
64 | "<link linkend="ref-images">Reference: Images</link>" appendix. | 64 | "<link linkend="ref-images">Reference: Images</link>" appendix. |
65 | </para> | 65 | </para> |
66 | 66 | ||
@@ -89,7 +89,8 @@ | |||
89 | 89 | ||
90 | <para> | 90 | <para> |
91 | Once an image has been built, it often needs to be installed. | 91 | Once an image has been built, it often needs to be installed. |
92 | The images and kernels built by the Yocto Project are placed in the build directory in | 92 | The images and kernels built by the OpenEmbedded build system are placed in the |
93 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> in | ||
93 | <filename class="directory">tmp/deploy/images</filename>. | 94 | <filename class="directory">tmp/deploy/images</filename>. |
94 | For information on how to run pre-built images such as <filename>qemux86</filename> | 95 | For information on how to run pre-built images such as <filename>qemux86</filename> |
95 | and <filename>qemuarm</filename>, see the | 96 | and <filename>qemuarm</filename>, see the |
@@ -104,12 +105,12 @@ | |||
104 | <title>Debugging Build Failures</title> | 105 | <title>Debugging Build Failures</title> |
105 | 106 | ||
106 | <para> | 107 | <para> |
107 | The exact method for debugging Yocto Project build failures depends on the nature of the | 108 | The exact method for debugging build failures depends on the nature of the |
108 | problem and on the system's area from which the bug originates. | 109 | problem and on the system's area from which the bug originates. |
109 | Standard debugging practices such as comparison against the last | 110 | Standard debugging practices such as comparison against the last |
110 | known working version with examination of the changes and the re-application of steps | 111 | known working version with examination of the changes and the re-application of steps |
111 | to identify the one causing the problem are | 112 | to identify the one causing the problem are |
112 | valid for Yocto Project just as they are for any other system. | 113 | valid for the Yocto Project just as they are for any other system. |
113 | Even though it is impossible to detail every possible potential failure, | 114 | Even though it is impossible to detail every possible potential failure, |
114 | this section provides some general tips to aid in debugging. | 115 | this section provides some general tips to aid in debugging. |
115 | </para> | 116 | </para> |
@@ -263,10 +264,10 @@ | |||
263 | </para> | 264 | </para> |
264 | 265 | ||
265 | <para> | 266 | <para> |
266 | For guidance on how logging is handled | 267 | For guidance on how logging is handled in both Python and Bash recipes, see the |
267 | in both Python and Bash recipes, see the | ||
268 | <filename>logging.bbclass</filename> file in the | 268 | <filename>logging.bbclass</filename> file in the |
269 | <filename>meta/classes</filename> directory of the Yocto Project files. | 269 | <filename>meta/classes</filename> folder of the |
270 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. | ||
270 | </para> | 271 | </para> |
271 | 272 | ||
272 | <section id='logging-with-python'> | 273 | <section id='logging-with-python'> |