diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-09-15 06:10:32 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-09-25 17:57:18 +0100 |
commit | b57c529115e787df37aaf90790c7026fd8426bc3 (patch) | |
tree | 394ff0b88a0351183e76eff9394c8b2ae2f8c413 | |
parent | 319f4ee481bc6b3361f2ca589f9a48cacbd5fd8c (diff) | |
download | poky-b57c529115e787df37aaf90790c7026fd8426bc3.tar.gz |
documentation/dev-manual/dev-manual-newbie.xml: new terms
I moved the terms "Yocto Project Files" and "Yocto Project Build
Tree" into this development manual. They were previous defined
in the ADT manual. It makes more sense to have them where with other
terms.
(From yocto-docs rev: 2133110fd280db8cfbe998e6b46cdee0b260e777)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 0bc0be2164..c3df1c2958 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -132,6 +132,44 @@ | |||
132 | environment might find helpful. | 132 | environment might find helpful. |
133 | Some terms are universal but are included here just in case: | 133 | Some terms are universal but are included here just in case: |
134 | <itemizedlist> | 134 | <itemizedlist> |
135 | <listitem><para><emphasis>The Yocto Project Files:</emphasis> | ||
136 | This term refers to the directory structure created as a result of downloading | ||
137 | and unpacking a Yocto Project release tarball or setting up a Git repository | ||
138 | by cloning <filename>git://git.yoctoproject.org/poky</filename>.</para> | ||
139 | <para>The Yocto Project files contain BitBake, Documentation, metadata and | ||
140 | other files that all support the development environment. | ||
141 | Consequently, you must have the Yocto Project files in place on your development | ||
142 | system in order to do any development using the Yocto Project.</para> | ||
143 | <para>The name of the top-level directory of the Yocto Project file structure | ||
144 | is derived from the Yocto Project release tarball. | ||
145 | For example, downloading and unpacking <filename>poky-edison-6.0.tar.bz2</filename> | ||
146 | results in a Yocto Project source tree whose Yocto Project source directory is named | ||
147 | <filename>poky-edison-6.0</filename>. | ||
148 | If you create a Git repository, then you can name the repository anything you like.</para> | ||
149 | <para>You can find instruction on how to set up the Yocto Project files on your | ||
150 | host development system by reading | ||
151 | the | ||
152 | "<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#getting-setup'>Getting | ||
153 | Setup</ulink>" section in | ||
154 | <ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'> | ||
155 | The Yocto Project Development Manual</ulink>.</para></listitem> | ||
156 | <listitem><para><emphasis>Yocto Project Build Tree:</emphasis> | ||
157 | This term refers to the area where the Yocto Project builds images. | ||
158 | The area is created when you <filename>source</filename> the Yocto Project setup | ||
159 | environment script that is found in the Yocto Project files area. | ||
160 | (e.g. <filename>oe-init-build-env</filename>). | ||
161 | You can create the Yocto Project build tree anywhere you want on your | ||
162 | development system. | ||
163 | Here is an example that creates the tree in <filename>mybuilds</filename> | ||
164 | and names the Yocto Project build directory <filename>YP-6.0</filename>: | ||
165 | <literallayout class='monospaced'> | ||
166 | $ source poky-edison-6.0/oe-init-build-env $HOME/mybuilds/YP-6.0 | ||
167 | </literallayout> | ||
168 | If you don't specifically name the build directory, BitBake creates it | ||
169 | in the current directory and uses the name <filename>build</filename>. | ||
170 | Also, if you supply an existing directory, then BitBake uses that | ||
171 | directory as the Yocto Project build directory and populates the build tree | ||
172 | beneath it.</para></listitem> | ||
135 | <listitem><para><emphasis>Image</emphasis> - An image is the result produced when | 173 | <listitem><para><emphasis>Image</emphasis> - An image is the result produced when |
136 | BitBake processes a given collection of recipes and related metadata. | 174 | BitBake processes a given collection of recipes and related metadata. |
137 | Images are the binary output that runs on specific hardware and for specific | 175 | Images are the binary output that runs on specific hardware and for specific |