diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-12-07 17:29:51 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-11 16:17:56 +0000 |
commit | 73ffb8298b545a1a1fb96bc5952b7365c4c43bfd (patch) | |
tree | 9c6473cb4e3c5dd8370c2d417c304e1a302fa643 /documentation/poky-ref-manual/ref-structure.xml | |
parent | acb3f72afaa28ba5d23ca6e5cdf9f1162ea656a3 (diff) | |
download | poky-73ffb8298b545a1a1fb96bc5952b7365c4c43bfd.tar.gz |
Documentation: poky-ref-manual - Removed all trailing whitespace.
(From yocto-docs rev: 564a28c2501034ea7e2eb16afc43dfaf931b6f6f)
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/ref-structure.xml')
-rw-r--r-- | documentation/poky-ref-manual/ref-structure.xml | 260 |
1 files changed, 130 insertions, 130 deletions
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index 166907ceef..673b05a52b 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml | |||
@@ -9,7 +9,7 @@ | |||
9 | <para> | 9 | <para> |
10 | The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components. | 10 | The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components. |
11 | Understanding them and knowing where they are located is key to using the Yocto Project well. | 11 | Understanding them and knowing where they are located is key to using the Yocto Project well. |
12 | This chapter describes the Source Directory and gives information about the various | 12 | This chapter describes the Source Directory and gives information about the various |
13 | files and directories. | 13 | files and directories. |
14 | </para> | 14 | </para> |
15 | 15 | ||
@@ -35,26 +35,26 @@ | |||
35 | <para> | 35 | <para> |
36 | The <ulink url='source-directory'>Source Directory</ulink> | 36 | The <ulink url='source-directory'>Source Directory</ulink> |
37 | includes a copy of BitBake for ease of use. | 37 | includes a copy of BitBake for ease of use. |
38 | The copy usually matches the current stable BitBake release from the BitBake project. | 38 | The copy usually matches the current stable BitBake release from the BitBake project. |
39 | BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks | 39 | BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks |
40 | defined by that data. | 40 | defined by that data. |
41 | Failures are usually from the metadata and not from BitBake itself. | 41 | Failures are usually from the metadata and not from BitBake itself. |
42 | Consequently, most users do not need to worry about BitBake. | 42 | Consequently, most users do not need to worry about BitBake. |
43 | </para> | 43 | </para> |
44 | 44 | ||
45 | <para> | 45 | <para> |
46 | When you run the <filename>bitbake</filename> command, the wrapper script in | 46 | When you run the <filename>bitbake</filename> command, the wrapper script in |
47 | <filename>scripts/</filename> is executed to run the main BitBake executable, | 47 | <filename>scripts/</filename> is executed to run the main BitBake executable, |
48 | which resides in the <filename>bitbake/bin/</filename> directory. | 48 | which resides in the <filename>bitbake/bin/</filename> directory. |
49 | Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link> | 49 | Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link> |
50 | script places the <filename>scripts</filename> and <filename>bitbake/bin</filename> | 50 | script places the <filename>scripts</filename> and <filename>bitbake/bin</filename> |
51 | directories (in that order) into the shell's <filename>PATH</filename> environment | 51 | directories (in that order) into the shell's <filename>PATH</filename> environment |
52 | variable. | 52 | variable. |
53 | </para> | 53 | </para> |
54 | 54 | ||
55 | <para> | 55 | <para> |
56 | For more information on BitBake, see the BitBake documentation | 56 | For more information on BitBake, see the BitBake documentation |
57 | inculded in the <filename>bitbake/doc/manual</filename> directory of the | 57 | inculded in the <filename>bitbake/doc/manual</filename> directory of the |
58 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 58 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
59 | </para> | 59 | </para> |
60 | </section> | 60 | </section> |
@@ -63,21 +63,21 @@ | |||
63 | <title><filename>build/</filename></title> | 63 | <title><filename>build/</filename></title> |
64 | 64 | ||
65 | <para> | 65 | <para> |
66 | This directory contains user configuration files and the output | 66 | This directory contains user configuration files and the output |
67 | generated by the OpenEmbedded build system in its standard configuration where | 67 | generated by the OpenEmbedded build system in its standard configuration where |
68 | the source tree is combined with the output. | 68 | the source tree is combined with the output. |
69 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 69 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
70 | is created initially when you <filename>source</filename> | 70 | is created initially when you <filename>source</filename> |
71 | the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>. | 71 | the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>. |
72 | </para> | 72 | </para> |
73 | 73 | ||
74 | <para> | 74 | <para> |
75 | It is also possible to place output and configuration | 75 | It is also possible to place output and configuration |
76 | files in a directory separate from the | 76 | files in a directory separate from the |
77 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 77 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
78 | by providing a directory name when you <filename>source</filename> | 78 | by providing a directory name when you <filename>source</filename> |
79 | the setup script. | 79 | the setup script. |
80 | For information on separating output from your local Source Directory files, see <link | 80 | For information on separating output from your local Source Directory files, see <link |
81 | linkend='structure-core-script'>&OE_INIT_FILE;</link>. | 81 | linkend='structure-core-script'>&OE_INIT_FILE;</link>. |
82 | </para> | 82 | </para> |
83 | </section> | 83 | </section> |
@@ -88,9 +88,9 @@ | |||
88 | <para> | 88 | <para> |
89 | This directory holds the source for the Yocto Project documentation | 89 | This directory holds the source for the Yocto Project documentation |
90 | as well as templates and tools that allow you to generate PDF and HTML | 90 | as well as templates and tools that allow you to generate PDF and HTML |
91 | versions of the manuals. | 91 | versions of the manuals. |
92 | Each manual is contained in a sub-folder. | 92 | Each manual is contained in a sub-folder. |
93 | For example, the files for this manual reside in | 93 | For example, the files for this manual reside in |
94 | <filename>poky-ref-manual</filename>. | 94 | <filename>poky-ref-manual</filename>. |
95 | </para> | 95 | </para> |
96 | </section> | 96 | </section> |
@@ -99,7 +99,7 @@ | |||
99 | <title><filename>meta/</filename></title> | 99 | <title><filename>meta/</filename></title> |
100 | 100 | ||
101 | <para> | 101 | <para> |
102 | This directory contains the OpenEmbedded Core metadata. | 102 | This directory contains the OpenEmbedded Core metadata. |
103 | The directory holds recipes, common classes, and machine | 103 | The directory holds recipes, common classes, and machine |
104 | configuration for emulated targets (qemux86, qemuarm, | 104 | configuration for emulated targets (qemux86, qemuarm, |
105 | and so on.) | 105 | and so on.) |
@@ -138,7 +138,7 @@ | |||
138 | <title><filename>meta-skeleton/</filename></title> | 138 | <title><filename>meta-skeleton/</filename></title> |
139 | 139 | ||
140 | <para> | 140 | <para> |
141 | This directory contains template recipes for BSP and kernel development. | 141 | This directory contains template recipes for BSP and kernel development. |
142 | </para> | 142 | </para> |
143 | </section> | 143 | </section> |
144 | 144 | ||
@@ -146,7 +146,7 @@ | |||
146 | <title><filename>scripts/</filename></title> | 146 | <title><filename>scripts/</filename></title> |
147 | 147 | ||
148 | <para> | 148 | <para> |
149 | This directory contains various integration scripts that implement | 149 | This directory contains various integration scripts that implement |
150 | extra functionality in the Yocto Project environment (e.g. QEMU scripts). | 150 | extra functionality in the Yocto Project environment (e.g. QEMU scripts). |
151 | The <link linkend="structure-core-script">&OE_INIT_FILE;</link> script appends this | 151 | The <link linkend="structure-core-script">&OE_INIT_FILE;</link> script appends this |
152 | directory to the shell's <filename>PATH</filename> environment variable. | 152 | directory to the shell's <filename>PATH</filename> environment variable. |
@@ -154,7 +154,7 @@ | |||
154 | 154 | ||
155 | <para> | 155 | <para> |
156 | The <filename>scripts</filename> directory has useful scripts that assist contributing | 156 | The <filename>scripts</filename> directory has useful scripts that assist contributing |
157 | back to the Yocto Project, such as <filename>create_pull_request</filename> and | 157 | back to the Yocto Project, such as <filename>create_pull_request</filename> and |
158 | <filename>send_pull_request</filename>. | 158 | <filename>send_pull_request</filename>. |
159 | </para> | 159 | </para> |
160 | </section> | 160 | </section> |
@@ -163,23 +163,23 @@ | |||
163 | <title><filename>&OE_INIT_FILE;</filename></title> | 163 | <title><filename>&OE_INIT_FILE;</filename></title> |
164 | 164 | ||
165 | <para> | 165 | <para> |
166 | This script sets up the OpenEmbedded build environment. | 166 | This script sets up the OpenEmbedded build environment. |
167 | Running this script with the <filename>source</filename> command in | 167 | Running this script with the <filename>source</filename> command in |
168 | a shell makes changes to <filename>PATH</filename> and sets other core BitBake variables based on the | 168 | a shell makes changes to <filename>PATH</filename> and sets other core BitBake variables based on the |
169 | current working directory. | 169 | current working directory. |
170 | You need to run this script before running BitBake commands. | 170 | You need to run this script before running BitBake commands. |
171 | The script uses other scripts within the <filename>scripts</filename> directory to do | 171 | The script uses other scripts within the <filename>scripts</filename> directory to do |
172 | the bulk of the work. | 172 | the bulk of the work. |
173 | </para> | 173 | </para> |
174 | 174 | ||
175 | <para> | 175 | <para> |
176 | By default, running this script without a Build Directory argument creates the | 176 | By default, running this script without a Build Directory argument creates the |
177 | <filename>build</filename> directory. | 177 | <filename>build</filename> directory. |
178 | If you provide a Build Directory argument when you <filename>source</filename> | 178 | If you provide a Build Directory argument when you <filename>source</filename> |
179 | the script, you direct OpenEmbedded build system to create a | 179 | the script, you direct OpenEmbedded build system to create a |
180 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> of your choice. | 180 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> of your choice. |
181 | For example, the following command creates a Build Directory named | 181 | For example, the following command creates a Build Directory named |
182 | <filename>mybuilds</filename> that is outside of the | 182 | <filename>mybuilds</filename> that is outside of the |
183 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: | 183 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: |
184 | <literallayout class='monospaced'> | 184 | <literallayout class='monospaced'> |
185 | $ source &OE_INIT_FILE; ~/mybuilds | 185 | $ source &OE_INIT_FILE; ~/mybuilds |
@@ -189,7 +189,7 @@ | |||
189 | contain spaces. | 189 | contain spaces. |
190 | If you attempt to run the <filename>&OE_INIT_FILE;</filename> script | 190 | If you attempt to run the <filename>&OE_INIT_FILE;</filename> script |
191 | from a Source Directory that contains spaces in either the filenames | 191 | from a Source Directory that contains spaces in either the filenames |
192 | or directory names, the script returns an error indicating no such | 192 | or directory names, the script returns an error indicating no such |
193 | file or directory. | 193 | file or directory. |
194 | Be sure to use a Source Directory free of names containing spaces. | 194 | Be sure to use a Source Directory free of names containing spaces. |
195 | </note> | 195 | </note> |
@@ -200,7 +200,7 @@ | |||
200 | <title><filename>LICENSE, README, and README.hardware</filename></title> | 200 | <title><filename>LICENSE, README, and README.hardware</filename></title> |
201 | 201 | ||
202 | <para> | 202 | <para> |
203 | These files are standard top-level files. | 203 | These files are standard top-level files. |
204 | </para> | 204 | </para> |
205 | </section> | 205 | </section> |
206 | </section> | 206 | </section> |
@@ -212,8 +212,8 @@ | |||
212 | <title><filename>build/pseudodone</filename></title> | 212 | <title><filename>build/pseudodone</filename></title> |
213 | 213 | ||
214 | <para> | 214 | <para> |
215 | This tag file indicates that the initial pseudo binary was created. | 215 | This tag file indicates that the initial pseudo binary was created. |
216 | The file is built the first time BitBake is invoked. | 216 | The file is built the first time BitBake is invoked. |
217 | </para> | 217 | </para> |
218 | </section> | 218 | </section> |
219 | 219 | ||
@@ -221,24 +221,24 @@ | |||
221 | <title><filename>build/conf/local.conf</filename></title> | 221 | <title><filename>build/conf/local.conf</filename></title> |
222 | 222 | ||
223 | <para> | 223 | <para> |
224 | This file contains all the local user configuration for your build environment. | 224 | This file contains all the local user configuration for your build environment. |
225 | If there is no <filename>local.conf</filename> present, it is created from | 225 | If there is no <filename>local.conf</filename> present, it is created from |
226 | <filename>local.conf.sample</filename>. | 226 | <filename>local.conf.sample</filename>. |
227 | The <filename>local.conf</filename> file contains documentation on the various configuration options. | 227 | The <filename>local.conf</filename> file contains documentation on the various configuration options. |
228 | Any variable set here overrides any variable set elsewhere within the environment unless | 228 | Any variable set here overrides any variable set elsewhere within the environment unless |
229 | that variable is hard-coded within a file (e.g. by using '=' instead of '?='). | 229 | that variable is hard-coded within a file (e.g. by using '=' instead of '?='). |
230 | Some variables are hard-coded for various reasons but these variables are | 230 | Some variables are hard-coded for various reasons but these variables are |
231 | relatively rare. | 231 | relatively rare. |
232 | </para> | 232 | </para> |
233 | 233 | ||
234 | <para> | 234 | <para> |
235 | Edit this file to set the <filename><link linkend='var-MACHINE'>MACHINE</link></filename> | 235 | Edit this file to set the <filename><link linkend='var-MACHINE'>MACHINE</link></filename> |
236 | for which you want to build, which package types you wish to use | 236 | for which you want to build, which package types you wish to use |
237 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), | 237 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), |
238 | where you want to downloaded files | 238 | where you want to downloaded files |
239 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), | 239 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), |
240 | and how you want your host machine to use resources | 240 | and how you want your host machine to use resources |
241 | (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> and | 241 | (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> and |
242 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>). | 242 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>). |
243 | </para> | 243 | </para> |
244 | </section> | 244 | </section> |
@@ -248,8 +248,8 @@ | |||
248 | 248 | ||
249 | <para> | 249 | <para> |
250 | This file defines layers, which are directory trees, traversed (or walked) by BitBake. | 250 | This file defines layers, which are directory trees, traversed (or walked) by BitBake. |
251 | If <filename>bblayers.conf</filename> | 251 | If <filename>bblayers.conf</filename> |
252 | is not present, it is created from <filename>bblayers.conf.sample</filename> when | 252 | is not present, it is created from <filename>bblayers.conf.sample</filename> when |
253 | you <filename>source</filename> the environment setup script. | 253 | you <filename>source</filename> the environment setup script. |
254 | </para> | 254 | </para> |
255 | 255 | ||
@@ -276,7 +276,7 @@ | |||
276 | 276 | ||
277 | <para> | 277 | <para> |
278 | This directory is used for the upstream source tarballs. | 278 | This directory is used for the upstream source tarballs. |
279 | The directory can be reused by multiple builds or moved to another location. | 279 | The directory can be reused by multiple builds or moved to another location. |
280 | You can control the location of this directory through the | 280 | You can control the location of this directory through the |
281 | <filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable. | 281 | <filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable. |
282 | </para> | 282 | </para> |
@@ -287,7 +287,7 @@ | |||
287 | 287 | ||
288 | <para> | 288 | <para> |
289 | This directory is used for the shared state cache. | 289 | This directory is used for the shared state cache. |
290 | The directory can be reused by multiple builds or moved to another location. | 290 | The directory can be reused by multiple builds or moved to another location. |
291 | You can control the location of this directory through the | 291 | You can control the location of this directory through the |
292 | <filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable. | 292 | <filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable. |
293 | </para> | 293 | </para> |
@@ -298,9 +298,9 @@ | |||
298 | 298 | ||
299 | <para> | 299 | <para> |
300 | This directory receives all the OpenEmbedded build system's output. | 300 | This directory receives all the OpenEmbedded build system's output. |
301 | BitBake creates this directory if it does not exist. | 301 | BitBake creates this directory if it does not exist. |
302 | As a last resort, to clean up a build and start it from scratch (other than the downloads), | 302 | As a last resort, to clean up a build and start it from scratch (other than the downloads), |
303 | you can remove everything in the <filename>tmp</filename> directory or get rid of the | 303 | you can remove everything in the <filename>tmp</filename> directory or get rid of the |
304 | directory completely. | 304 | directory completely. |
305 | If you do, you should also completely remove the <filename>build/sstate-cache</filename> | 305 | If you do, you should also completely remove the <filename>build/sstate-cache</filename> |
306 | directory as well. | 306 | directory as well. |
@@ -320,7 +320,7 @@ | |||
320 | 320 | ||
321 | <para> | 321 | <para> |
322 | When BitBake parses the metadata, it creates a cache file of the result that can | 322 | When BitBake parses the metadata, it creates a cache file of the result that can |
323 | be used when subsequently running commands. | 323 | be used when subsequently running commands. |
324 | These results are stored here on a per-machine basis. | 324 | These results are stored here on a per-machine basis. |
325 | </para> | 325 | </para> |
326 | </section> | 326 | </section> |
@@ -337,7 +337,7 @@ | |||
337 | <title><filename>build/tmp/deploy/deb/</filename></title> | 337 | <title><filename>build/tmp/deploy/deb/</filename></title> |
338 | 338 | ||
339 | <para> | 339 | <para> |
340 | This directory receives any <filename>.deb</filename> packages produced by | 340 | This directory receives any <filename>.deb</filename> packages produced by |
341 | the build process. | 341 | the build process. |
342 | The packages are sorted into feeds for different architecture types. | 342 | The packages are sorted into feeds for different architecture types. |
343 | </para> | 343 | </para> |
@@ -347,8 +347,8 @@ | |||
347 | <title><filename>build/tmp/deploy/rpm/</filename></title> | 347 | <title><filename>build/tmp/deploy/rpm/</filename></title> |
348 | 348 | ||
349 | <para> | 349 | <para> |
350 | This directory receives any <filename>.rpm</filename> packages produced by | 350 | This directory receives any <filename>.rpm</filename> packages produced by |
351 | the build process. | 351 | the build process. |
352 | The packages are sorted into feeds for different architecture types. | 352 | The packages are sorted into feeds for different architecture types. |
353 | </para> | 353 | </para> |
354 | </section> | 354 | </section> |
@@ -368,16 +368,16 @@ | |||
368 | <title><filename>build/tmp/deploy/images/</filename></title> | 368 | <title><filename>build/tmp/deploy/images/</filename></title> |
369 | 369 | ||
370 | <para> | 370 | <para> |
371 | This directory receives complete filesystem images. | 371 | This directory receives complete filesystem images. |
372 | If you want to flash the resulting image from a build onto a device, look here for the image. | 372 | If you want to flash the resulting image from a build onto a device, look here for the image. |
373 | </para> | 373 | </para> |
374 | 374 | ||
375 | <para> | 375 | <para> |
376 | Be careful when deleting files in this directory. | 376 | Be careful when deleting files in this directory. |
377 | You can safely delete old images from this directory (e.g. | 377 | You can safely delete old images from this directory (e.g. |
378 | <filename>core-image-*</filename>, <filename>hob-image-*</filename>, | 378 | <filename>core-image-*</filename>, <filename>hob-image-*</filename>, |
379 | etc.). | 379 | etc.). |
380 | However, the kernel (<filename>*zImage*</filename>, <filename>*uImage*</filename>, etc.), | 380 | However, the kernel (<filename>*zImage*</filename>, <filename>*uImage*</filename>, etc.), |
381 | bootloader and other supplementary files might be deployed here prior to building an | 381 | bootloader and other supplementary files might be deployed here prior to building an |
382 | image. | 382 | image. |
383 | Because these files, however, are not directly produced from the image, if you | 383 | Because these files, however, are not directly produced from the image, if you |
@@ -385,8 +385,8 @@ | |||
385 | </para> | 385 | </para> |
386 | 386 | ||
387 | <para> | 387 | <para> |
388 | If you do accidentally delete files here, you will need to force them to be | 388 | If you do accidentally delete files here, you will need to force them to be |
389 | re-created. | 389 | re-created. |
390 | In order to do that, you will need to know the target that produced them. | 390 | In order to do that, you will need to know the target that produced them. |
391 | For example, these commands rebuild and re-create the kernel files: | 391 | For example, these commands rebuild and re-create the kernel files: |
392 | <literallayout class='monospaced'> | 392 | <literallayout class='monospaced'> |
@@ -400,7 +400,7 @@ | |||
400 | <title><filename>build/tmp/deploy/ipk/</filename></title> | 400 | <title><filename>build/tmp/deploy/ipk/</filename></title> |
401 | 401 | ||
402 | <para> | 402 | <para> |
403 | This directory receives <filename>.ipk</filename> packages produced by | 403 | This directory receives <filename>.ipk</filename> packages produced by |
404 | the build process.</para> | 404 | the build process.</para> |
405 | </section> | 405 | </section> |
406 | 406 | ||
@@ -408,9 +408,9 @@ | |||
408 | <title><filename>build/tmp/sysroots/</filename></title> | 408 | <title><filename>build/tmp/sysroots/</filename></title> |
409 | 409 | ||
410 | <para> | 410 | <para> |
411 | This directory contains shared header files and libraries as well as other shared | 411 | This directory contains shared header files and libraries as well as other shared |
412 | data. | 412 | data. |
413 | Packages that need to share output with other packages do so within this directory. | 413 | Packages that need to share output with other packages do so within this directory. |
414 | The directory is subdivided by architecture so multiple builds can run within | 414 | The directory is subdivided by architecture so multiple builds can run within |
415 | the one Build Directory. | 415 | the one Build Directory. |
416 | </para> | 416 | </para> |
@@ -420,9 +420,9 @@ | |||
420 | <title><filename>build/tmp/stamps/</filename></title> | 420 | <title><filename>build/tmp/stamps/</filename></title> |
421 | 421 | ||
422 | <para> | 422 | <para> |
423 | This directory holds information that that BitBake uses for accounting purposes | 423 | This directory holds information that that BitBake uses for accounting purposes |
424 | to track what tasks have run and when they have run. | 424 | to track what tasks have run and when they have run. |
425 | The directory is sub-divided by architecture. | 425 | The directory is sub-divided by architecture. |
426 | The files in the directory are empty of data. | 426 | The files in the directory are empty of data. |
427 | However, BitBake uses the filenames and timestamps for tracking purposes. | 427 | However, BitBake uses the filenames and timestamps for tracking purposes. |
428 | </para> | 428 | </para> |
@@ -432,9 +432,9 @@ | |||
432 | <title><filename>build/tmp/log/</filename></title> | 432 | <title><filename>build/tmp/log/</filename></title> |
433 | 433 | ||
434 | <para> | 434 | <para> |
435 | This directory contains general logs that are not otherwise placed using the | 435 | This directory contains general logs that are not otherwise placed using the |
436 | package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. | 436 | package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. |
437 | Examples of logs are the output from the <filename>check_pkg</filename> or | 437 | Examples of logs are the output from the <filename>check_pkg</filename> or |
438 | <filename>distro_check</filename> tasks. | 438 | <filename>distro_check</filename> tasks. |
439 | Running a build does not necessarily mean this directory is created. | 439 | Running a build does not necessarily mean this directory is created. |
440 | </para> | 440 | </para> |
@@ -444,7 +444,7 @@ | |||
444 | <title><filename>build/tmp/pkgdata/</filename></title> | 444 | <title><filename>build/tmp/pkgdata/</filename></title> |
445 | 445 | ||
446 | <para> | 446 | <para> |
447 | This directory contains intermediate packaging data that is used later in the packaging process. | 447 | This directory contains intermediate packaging data that is used later in the packaging process. |
448 | For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section. | 448 | For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section. |
449 | </para> | 449 | </para> |
450 | </section> | 450 | </section> |
@@ -453,7 +453,7 @@ | |||
453 | <title><filename>build/tmp/work/</filename></title> | 453 | <title><filename>build/tmp/work/</filename></title> |
454 | 454 | ||
455 | <para> | 455 | <para> |
456 | This directory contains architecture-specific work sub-directories for packages built by BitBake. | 456 | This directory contains architecture-specific work sub-directories for packages built by BitBake. |
457 | All tasks execute from a work directory. | 457 | All tasks execute from a work directory. |
458 | For example, the source for a particular package is unpacked, patched, configured and compiled all | 458 | For example, the source for a particular package is unpacked, patched, configured and compiled all |
459 | within its own work directory. | 459 | within its own work directory. |
@@ -462,31 +462,31 @@ | |||
462 | </para> | 462 | </para> |
463 | 463 | ||
464 | <para> | 464 | <para> |
465 | It is worth considering the structure of a typical work directory. | 465 | It is worth considering the structure of a typical work directory. |
466 | As an example, consider the <filename>linux-yocto-kernel-3.0</filename> | 466 | As an example, consider the <filename>linux-yocto-kernel-3.0</filename> |
467 | on the machine <filename>qemux86</filename> | 467 | on the machine <filename>qemux86</filename> |
468 | built within the Yocto Project. | 468 | built within the Yocto Project. |
469 | For this package, a work directory of | 469 | For this package, a work directory of |
470 | <filename>tmp/work/qemux86-poky-linux/linux-yocto-3.0+git1+<.....></filename>, | 470 | <filename>tmp/work/qemux86-poky-linux/linux-yocto-3.0+git1+<.....></filename>, |
471 | referred to as <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, is created. | 471 | referred to as <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, is created. |
472 | Within this directory, the source is unpacked to | 472 | Within this directory, the source is unpacked to |
473 | <filename>linux-qemux86-standard-build</filename> and then patched by Quilt | 473 | <filename>linux-qemux86-standard-build</filename> and then patched by Quilt |
474 | (see the | 474 | (see the |
475 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Modifying Package | 475 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Modifying Package |
476 | Source Code with Quilt</ulink>" section in the Yocto Project Development Manual. | 476 | Source Code with Quilt</ulink>" section in the Yocto Project Development Manual. |
477 | Within the <filename>linux-qemux86-standard-build</filename> directory, | 477 | Within the <filename>linux-qemux86-standard-build</filename> directory, |
478 | standard Quilt directories <filename>linux-3.0/patches</filename> | 478 | standard Quilt directories <filename>linux-3.0/patches</filename> |
479 | and <filename>linux-3.0/.pc</filename> are created, | 479 | and <filename>linux-3.0/.pc</filename> are created, |
480 | and standard Quilt commands can be used. | 480 | and standard Quilt commands can be used. |
481 | </para> | 481 | </para> |
482 | 482 | ||
483 | <para> | 483 | <para> |
484 | There are other directories generated within WORKDIR. | 484 | There are other directories generated within WORKDIR. |
485 | The most important directory is WORKDIR<filename>/temp/</filename>, which has log files for each | 485 | The most important directory is WORKDIR<filename>/temp/</filename>, which has log files for each |
486 | task (<filename>log.do_*.pid</filename>) and contains the scripts BitBake runs for | 486 | task (<filename>log.do_*.pid</filename>) and contains the scripts BitBake runs for |
487 | each task (<filename>run.do_*.pid</filename>). | 487 | each task (<filename>run.do_*.pid</filename>). |
488 | The WORKDIR<filename>/image/</filename> directory is where "make | 488 | The WORKDIR<filename>/image/</filename> directory is where "make |
489 | install" places its output that is then split into sub-packages | 489 | install" places its output that is then split into sub-packages |
490 | within WORKDIR<filename>/packages-split/</filename>. | 490 | within WORKDIR<filename>/packages-split/</filename>. |
491 | </para> | 491 | </para> |
492 | </section> | 492 | </section> |
@@ -496,7 +496,7 @@ | |||
496 | <title>The Metadata - <filename>meta/</filename></title> | 496 | <title>The Metadata - <filename>meta/</filename></title> |
497 | 497 | ||
498 | <para> | 498 | <para> |
499 | As mentioned previously, metadata is the core of the Yocto Project. | 499 | As mentioned previously, metadata is the core of the Yocto Project. |
500 | Metadata has several important subdivisions: | 500 | Metadata has several important subdivisions: |
501 | </para> | 501 | </para> |
502 | 502 | ||
@@ -504,16 +504,16 @@ | |||
504 | <title><filename>meta/classes/</filename></title> | 504 | <title><filename>meta/classes/</filename></title> |
505 | 505 | ||
506 | <para> | 506 | <para> |
507 | This directory contains the <filename>*.bbclass</filename> files. | 507 | This directory contains the <filename>*.bbclass</filename> files. |
508 | Class files are used to abstract common code so it can be reused by multiple | 508 | Class files are used to abstract common code so it can be reused by multiple |
509 | packages. | 509 | packages. |
510 | Every package inherits the <filename>base.bbclass</filename> file. | 510 | Every package inherits the <filename>base.bbclass</filename> file. |
511 | Examples of other important classes are <filename>autotools.bbclass</filename>, which | 511 | Examples of other important classes are <filename>autotools.bbclass</filename>, which |
512 | in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort. | 512 | in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort. |
513 | Another example is <filename>kernel.bbclass</filename> that contains common code and functions | 513 | Another example is <filename>kernel.bbclass</filename> that contains common code and functions |
514 | for working with the Linux kernel. | 514 | for working with the Linux kernel. |
515 | Functions like image generation or packaging also have their specific class files | 515 | Functions like image generation or packaging also have their specific class files |
516 | such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and | 516 | such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and |
517 | <filename>package*.bbclass</filename>. | 517 | <filename>package*.bbclass</filename>. |
518 | </para> | 518 | </para> |
519 | </section> | 519 | </section> |
@@ -522,13 +522,13 @@ | |||
522 | <title><filename>meta/conf/</filename></title> | 522 | <title><filename>meta/conf/</filename></title> |
523 | 523 | ||
524 | <para> | 524 | <para> |
525 | This directory contains the core set of configuration files that start from | 525 | This directory contains the core set of configuration files that start from |
526 | <filename>bitbake.conf</filename> and from which all other configuration | 526 | <filename>bitbake.conf</filename> and from which all other configuration |
527 | files are included. | 527 | files are included. |
528 | See the include statements at the end of the file and you will note that even | 528 | See the include statements at the end of the file and you will note that even |
529 | <filename>local.conf</filename> is loaded from there. | 529 | <filename>local.conf</filename> is loaded from there. |
530 | While <filename>bitbake.conf</filename> sets up the defaults, you can often override | 530 | While <filename>bitbake.conf</filename> sets up the defaults, you can often override |
531 | these by using the (<filename>local.conf</filename>) file, machine file or | 531 | these by using the (<filename>local.conf</filename>) file, machine file or |
532 | the distribution configuration file. | 532 | the distribution configuration file. |
533 | </para> | 533 | </para> |
534 | </section> | 534 | </section> |
@@ -537,11 +537,11 @@ | |||
537 | <title><filename>meta/conf/machine/</filename></title> | 537 | <title><filename>meta/conf/machine/</filename></title> |
538 | 538 | ||
539 | <para> | 539 | <para> |
540 | This directory contains all the machine configuration files. | 540 | This directory contains all the machine configuration files. |
541 | If you set <filename>MACHINE="qemux86"</filename>, | 541 | If you set <filename>MACHINE="qemux86"</filename>, |
542 | the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this | 542 | the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this |
543 | directory. | 543 | directory. |
544 | The <filename>include</filename> directory contains various data common to multiple machines. | 544 | The <filename>include</filename> directory contains various data common to multiple machines. |
545 | If you want to add support for a new machine to the Yocto Project, look in this directory. | 545 | If you want to add support for a new machine to the Yocto Project, look in this directory. |
546 | </para> | 546 | </para> |
547 | </section> | 547 | </section> |
@@ -550,10 +550,10 @@ | |||
550 | <title><filename>meta/conf/distro/</filename></title> | 550 | <title><filename>meta/conf/distro/</filename></title> |
551 | 551 | ||
552 | <para> | 552 | <para> |
553 | Any distribution-specific configuration is controlled from this directory. | 553 | Any distribution-specific configuration is controlled from this directory. |
554 | For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here. | 554 | For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here. |
555 | This directory includes the versions and the | 555 | This directory includes the versions and the |
556 | <filename>SRCDATE</filename> definitions for applications that are configured here. | 556 | <filename>SRCDATE</filename> definitions for applications that are configured here. |
557 | An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>. | 557 | An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>. |
558 | Although this file mainly inherits its configuration from Poky. | 558 | Although this file mainly inherits its configuration from Poky. |
559 | </para> | 559 | </para> |
@@ -563,7 +563,7 @@ | |||
563 | <title><filename>meta/recipes-bsp/</filename></title> | 563 | <title><filename>meta/recipes-bsp/</filename></title> |
564 | 564 | ||
565 | <para> | 565 | <para> |
566 | This directory contains anything linking to specific hardware or hardware | 566 | This directory contains anything linking to specific hardware or hardware |
567 | configuration information such as "u-boot" and "grub". | 567 | configuration information such as "u-boot" and "grub". |
568 | </para> | 568 | </para> |
569 | </section> | 569 | </section> |
@@ -580,7 +580,7 @@ | |||
580 | <title><filename>meta/recipes-core/</filename></title> | 580 | <title><filename>meta/recipes-core/</filename></title> |
581 | 581 | ||
582 | <para> | 582 | <para> |
583 | This directory contains what is needed to build a basic working Linux image | 583 | This directory contains what is needed to build a basic working Linux image |
584 | including commonly used dependencies. | 584 | including commonly used dependencies. |
585 | </para> | 585 | </para> |
586 | </section> | 586 | </section> |
@@ -598,8 +598,8 @@ | |||
598 | <title><filename>meta/recipes-extended/</filename></title> | 598 | <title><filename>meta/recipes-extended/</filename></title> |
599 | 599 | ||
600 | <para> | 600 | <para> |
601 | This directory contains non-essential applications that add features compared to the | 601 | This directory contains non-essential applications that add features compared to the |
602 | alternatives in core. | 602 | alternatives in core. |
603 | You might need this directory for full tool functionality or for Linux Standard Base (LSB) | 603 | You might need this directory for full tool functionality or for Linux Standard Base (LSB) |
604 | compliance. | 604 | compliance. |
605 | </para> | 605 | </para> |
@@ -625,7 +625,7 @@ | |||
625 | <title><filename>meta/recipes-kernel/</filename></title> | 625 | <title><filename>meta/recipes-kernel/</filename></title> |
626 | 626 | ||
627 | <para> | 627 | <para> |
628 | This directory contains the kernel and generic applications and libraries that | 628 | This directory contains the kernel and generic applications and libraries that |
629 | have strong kernel dependencies. | 629 | have strong kernel dependencies. |
630 | </para> | 630 | </para> |
631 | </section> | 631 | </section> |
@@ -651,7 +651,7 @@ | |||
651 | 651 | ||
652 | <para> | 652 | <para> |
653 | This directory contains package and image recipes for using and testing | 653 | This directory contains package and image recipes for using and testing |
654 | the <filename>PREEMPT_RT</filename> kernel. | 654 | the <filename>PREEMPT_RT</filename> kernel. |
655 | </para> | 655 | </para> |
656 | </section> | 656 | </section> |
657 | 657 | ||
@@ -668,7 +668,7 @@ | |||
668 | <title><filename>meta/recipes-support/</filename></title> | 668 | <title><filename>meta/recipes-support/</filename></title> |
669 | 669 | ||
670 | <para> | 670 | <para> |
671 | This directory contains recipes that used by other recipes, but that are not directly | 671 | This directory contains recipes that used by other recipes, but that are not directly |
672 | included in images (i.e. dependencies of other recipes). | 672 | included in images (i.e. dependencies of other recipes). |
673 | </para> | 673 | </para> |
674 | </section> | 674 | </section> |
@@ -678,9 +678,9 @@ | |||
678 | 678 | ||
679 | <para> | 679 | <para> |
680 | This directory contains a list of cached results for various architectures. | 680 | This directory contains a list of cached results for various architectures. |
681 | Because certain "autoconf" test results cannot be determined when cross-compiling due to | 681 | Because certain "autoconf" test results cannot be determined when cross-compiling due to |
682 | the tests not able to run on a live system, the information in this directory is | 682 | the tests not able to run on a live system, the information in this directory is |
683 | passed to "autoconf" for the various architectures. | 683 | passed to "autoconf" for the various architectures. |
684 | </para> | 684 | </para> |
685 | </section> | 685 | </section> |
686 | 686 | ||
@@ -694,6 +694,6 @@ | |||
694 | </section> | 694 | </section> |
695 | 695 | ||
696 | </chapter> | 696 | </chapter> |
697 | <!-- | 697 | <!-- |
698 | vim: expandtab tw=80 ts=4 | 698 | vim: expandtab tw=80 ts=4 |
699 | --> | 699 | --> |