diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-12-11 12:07:58 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-01-07 14:43:25 +0000 |
| commit | ed0a240e1632682ec4c33341f3e24ad71773cdfc (patch) | |
| tree | 201557f498b77b9f51fad7e12a6009f74aca4c65 /documentation/ref-manual/ref-structure.xml | |
| parent | af19d889ef320f9625aae42eed6688b5cc739793 (diff) | |
| download | poky-ed0a240e1632682ec4c33341f3e24ad71773cdfc.tar.gz | |
documentation: Rename of poky-ref-manual folder to ref-manual.
Changing the folder that holds the YP Reference Manual to be
"ref-manual". This will help with confustion over the manual's
intended purpose.
(From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-structure.xml')
| -rw-r--r-- | documentation/ref-manual/ref-structure.xml | 709 |
1 files changed, 709 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml new file mode 100644 index 0000000000..2fa3341e61 --- /dev/null +++ b/documentation/ref-manual/ref-structure.xml | |||
| @@ -0,0 +1,709 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | |||
| 5 | <chapter id='ref-structure'> | ||
| 6 | |||
| 7 | <title>Source Directory Structure</title> | ||
| 8 | |||
| 9 | <para> | ||
| 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. | ||
| 12 | This chapter describes the Source Directory and gives information about the various | ||
| 13 | files and directories. | ||
| 14 | </para> | ||
| 15 | |||
| 16 | <para> | ||
| 17 | For information on how to establish a local Source Directory on your development system, see the | ||
| 18 | "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" | ||
| 19 | section in the Yocto Project Development Manual. | ||
| 20 | </para> | ||
| 21 | |||
| 22 | <note> | ||
| 23 | The OpenEmbedded build system does not support file or directory names that | ||
| 24 | contain spaces. | ||
| 25 | Be sure that the Source Directory you use does not contain these types | ||
| 26 | of names. | ||
| 27 | </note> | ||
| 28 | |||
| 29 | <section id='structure-core'> | ||
| 30 | <title>Top level core components</title> | ||
| 31 | |||
| 32 | <section id='structure-core-bitbake'> | ||
| 33 | <title><filename>bitbake/</filename></title> | ||
| 34 | |||
| 35 | <para> | ||
| 36 | The <ulink url='source-directory'>Source Directory</ulink> | ||
| 37 | includes a copy of BitBake for ease of use. | ||
| 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 | ||
| 40 | defined by that data. | ||
| 41 | Failures are usually from the metadata and not from BitBake itself. | ||
| 42 | Consequently, most users do not need to worry about BitBake. | ||
| 43 | </para> | ||
| 44 | |||
| 45 | <para> | ||
| 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, | ||
| 48 | which resides in the <filename>bitbake/bin/</filename> directory. | ||
| 49 | Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link> | ||
| 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 | ||
| 52 | variable. | ||
| 53 | </para> | ||
| 54 | |||
| 55 | <para> | ||
| 56 | For more information on BitBake, see the BitBake documentation | ||
| 57 | inculded in the <filename>bitbake/doc/manual</filename> directory of the | ||
| 58 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | ||
| 59 | </para> | ||
| 60 | </section> | ||
| 61 | |||
| 62 | <section id='structure-core-build'> | ||
| 63 | <title><filename>build/</filename></title> | ||
| 64 | |||
| 65 | <para> | ||
| 66 | This directory contains user configuration files and the output | ||
| 67 | generated by the OpenEmbedded build system in its standard configuration where | ||
| 68 | the source tree is combined with the output. | ||
| 69 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
| 70 | is created initially when you <filename>source</filename> | ||
| 71 | the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>. | ||
| 72 | </para> | ||
| 73 | |||
| 74 | <para> | ||
| 75 | It is also possible to place output and configuration | ||
| 76 | files in a directory separate from the | ||
| 77 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | ||
| 78 | by providing a directory name when you <filename>source</filename> | ||
| 79 | the setup script. | ||
| 80 | For information on separating output from your local Source Directory files, see <link | ||
| 81 | linkend='structure-core-script'>&OE_INIT_FILE;</link>. | ||
| 82 | </para> | ||
| 83 | </section> | ||
| 84 | |||
| 85 | <section id='handbook'> | ||
| 86 | <title><filename>documentation</filename></title> | ||
| 87 | |||
| 88 | <para> | ||
| 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 | ||
| 91 | versions of the manuals. | ||
| 92 | Each manual is contained in a sub-folder. | ||
| 93 | For example, the files for this manual reside in | ||
| 94 | <filename>ref-manual</filename>. | ||
| 95 | </para> | ||
| 96 | </section> | ||
| 97 | |||
| 98 | <section id='structure-core-meta'> | ||
| 99 | <title><filename>meta/</filename></title> | ||
| 100 | |||
| 101 | <para> | ||
| 102 | This directory contains the OpenEmbedded Core metadata. | ||
| 103 | The directory holds recipes, common classes, and machine | ||
| 104 | configuration for emulated targets (qemux86, qemuarm, | ||
| 105 | and so on.) | ||
| 106 | </para> | ||
| 107 | </section> | ||
| 108 | |||
| 109 | <section id='structure-core-meta-yocto'> | ||
| 110 | <title><filename>meta-yocto/</filename></title> | ||
| 111 | |||
| 112 | <para> | ||
| 113 | This directory contains the configuration for the Poky | ||
| 114 | reference distribution. | ||
| 115 | </para> | ||
| 116 | </section> | ||
| 117 | |||
| 118 | <section id='structure-core-meta-yocto-bsp'> | ||
| 119 | <title><filename>meta-yocto-bsp/</filename></title> | ||
| 120 | |||
| 121 | <para> | ||
| 122 | This directory contains the Yocto Project reference | ||
| 123 | hardware BSPs. | ||
| 124 | </para> | ||
| 125 | </section> | ||
| 126 | |||
| 127 | <section id='structure-meta-hob'> | ||
| 128 | <title><filename>meta-hob/</filename></title> | ||
| 129 | |||
| 130 | <para> | ||
| 131 | This directory contains template recipes used by the | ||
| 132 | <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> | ||
| 133 | build UI. | ||
| 134 | </para> | ||
| 135 | </section> | ||
| 136 | |||
| 137 | <section id='structure-meta-skeleton'> | ||
| 138 | <title><filename>meta-skeleton/</filename></title> | ||
| 139 | |||
| 140 | <para> | ||
| 141 | This directory contains template recipes for BSP and kernel development. | ||
| 142 | </para> | ||
| 143 | </section> | ||
| 144 | |||
| 145 | <section id='structure-core-scripts'> | ||
| 146 | <title><filename>scripts/</filename></title> | ||
| 147 | |||
| 148 | <para> | ||
| 149 | This directory contains various integration scripts that implement | ||
| 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 | ||
| 152 | directory to the shell's <filename>PATH</filename> environment variable. | ||
| 153 | </para> | ||
| 154 | |||
| 155 | <para> | ||
| 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 | ||
| 158 | <filename>send_pull_request</filename>. | ||
| 159 | </para> | ||
| 160 | </section> | ||
| 161 | |||
| 162 | <section id='structure-core-script'> | ||
| 163 | <title><filename>&OE_INIT_FILE;</filename></title> | ||
| 164 | |||
| 165 | <para> | ||
| 166 | This script sets up the OpenEmbedded build environment. | ||
| 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 | ||
| 169 | current working directory. | ||
| 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 | ||
| 172 | the bulk of the work. | ||
| 173 | </para> | ||
| 174 | |||
| 175 | <para> | ||
| 176 | By default, running this script without a Build Directory argument creates the | ||
| 177 | <filename>build</filename> directory. | ||
| 178 | If you provide a Build Directory argument when you <filename>source</filename> | ||
| 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. | ||
| 181 | For example, the following command creates a Build Directory named | ||
| 182 | <filename>mybuilds</filename> that is outside of the | ||
| 183 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: | ||
| 184 | <literallayout class='monospaced'> | ||
| 185 | $ source &OE_INIT_FILE; ~/mybuilds | ||
| 186 | </literallayout> | ||
| 187 | <note> | ||
| 188 | The OpenEmbedded build system does not support file or directory names that | ||
| 189 | contain spaces. | ||
| 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 | ||
| 192 | or directory names, the script returns an error indicating no such | ||
| 193 | file or directory. | ||
| 194 | Be sure to use a Source Directory free of names containing spaces. | ||
| 195 | </note> | ||
| 196 | </para> | ||
| 197 | </section> | ||
| 198 | |||
| 199 | <section id='structure-basic-top-level'> | ||
| 200 | <title><filename>LICENSE, README, and README.hardware</filename></title> | ||
| 201 | |||
| 202 | <para> | ||
| 203 | These files are standard top-level files. | ||
| 204 | </para> | ||
| 205 | </section> | ||
| 206 | </section> | ||
| 207 | |||
| 208 | <section id='structure-build'> | ||
| 209 | <title>The Build Directory - <filename>build/</filename></title> | ||
| 210 | |||
| 211 | <section id='structure-build-pseudodone'> | ||
| 212 | <title><filename>build/pseudodone</filename></title> | ||
| 213 | |||
| 214 | <para> | ||
| 215 | This tag file indicates that the initial pseudo binary was created. | ||
| 216 | The file is built the first time BitBake is invoked. | ||
| 217 | </para> | ||
| 218 | </section> | ||
| 219 | |||
| 220 | <section id='structure-build-conf-local.conf'> | ||
| 221 | <title><filename>build/conf/local.conf</filename></title> | ||
| 222 | |||
| 223 | <para> | ||
| 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 | ||
| 226 | <filename>local.conf.sample</filename>. | ||
| 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 | ||
| 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 | ||
| 231 | relatively rare. | ||
| 232 | </para> | ||
| 233 | |||
| 234 | <para> | ||
| 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 | ||
| 237 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), | ||
| 238 | where you want to downloaded files | ||
| 239 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), | ||
| 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 | ||
| 242 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>). | ||
| 243 | </para> | ||
| 244 | </section> | ||
| 245 | |||
| 246 | <section id='structure-build-conf-bblayers.conf'> | ||
| 247 | <title><filename>build/conf/bblayers.conf</filename></title> | ||
| 248 | |||
| 249 | <para> | ||
| 250 | This file defines layers, which are directory trees, traversed (or walked) by BitBake. | ||
| 251 | If <filename>bblayers.conf</filename> | ||
| 252 | is not present, it is created from <filename>bblayers.conf.sample</filename> when | ||
| 253 | you <filename>source</filename> the environment setup script. | ||
| 254 | </para> | ||
| 255 | |||
| 256 | <para> | ||
| 257 | The <filename>bblayers.conf</filename> file uses the | ||
| 258 | <link linkend='var-BBLAYERS'><filename>BBLAYERS</filename></link> variable to | ||
| 259 | list the layers BitBake tries to find. | ||
| 260 | The file uses the | ||
| 261 | <link linkend='var-BBLAYERS_NON_REMOVABLE'><filename>BBLAYERS_NON_REMOVABLE</filename></link> | ||
| 262 | variable to list layers that must not be removed. | ||
| 263 | </para> | ||
| 264 | </section> | ||
| 265 | |||
| 266 | <section id='structure-build-conf-sanity_info'> | ||
| 267 | <title><filename>build/conf/sanity_info</filename></title> | ||
| 268 | |||
| 269 | <para> | ||
| 270 | This file is created during the build to indicate the state of the sanity checks. | ||
| 271 | </para> | ||
| 272 | </section> | ||
| 273 | |||
| 274 | <section id='structure-build-downloads'> | ||
| 275 | <title><filename>build/downloads/</filename></title> | ||
| 276 | |||
| 277 | <para> | ||
| 278 | This directory is used for the upstream source tarballs. | ||
| 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 | ||
| 281 | <filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable. | ||
| 282 | </para> | ||
| 283 | </section> | ||
| 284 | |||
| 285 | <section id='structure-build-sstate-cache'> | ||
| 286 | <title><filename>build/sstate-cache/</filename></title> | ||
| 287 | |||
| 288 | <para> | ||
| 289 | This directory is used for the shared state cache. | ||
| 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 | ||
| 292 | <filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable. | ||
| 293 | </para> | ||
| 294 | </section> | ||
| 295 | |||
| 296 | <section id='structure-build-tmp'> | ||
| 297 | <title><filename>build/tmp/</filename></title> | ||
| 298 | |||
| 299 | <para> | ||
| 300 | This directory receives all the OpenEmbedded build system's output. | ||
| 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), | ||
| 303 | you can remove everything in the <filename>tmp</filename> directory or get rid of the | ||
| 304 | directory completely. | ||
| 305 | If you do, you should also completely remove the <filename>build/sstate-cache</filename> | ||
| 306 | directory as well. | ||
| 307 | </para> | ||
| 308 | </section> | ||
| 309 | |||
| 310 | <section id='structure-build-tmp-buildstats'> | ||
| 311 | <title><filename>build/tmp/buildstats/</filename></title> | ||
| 312 | |||
| 313 | <para> | ||
| 314 | This directory stores the build statistics. | ||
| 315 | </para> | ||
| 316 | </section> | ||
| 317 | |||
| 318 | <section id='structure-build-tmp-cache'> | ||
| 319 | <title><filename>build/tmp/cache/</filename></title> | ||
| 320 | |||
| 321 | <para> | ||
| 322 | When BitBake parses the metadata, it creates a cache file of the result that can | ||
| 323 | be used when subsequently running commands. | ||
| 324 | These results are stored here on a per-machine basis. | ||
| 325 | </para> | ||
| 326 | </section> | ||
| 327 | |||
| 328 | <section id='structure-build-tmp-deploy'> | ||
| 329 | <title><filename>build/tmp/deploy/</filename></title> | ||
| 330 | |||
| 331 | <para> | ||
| 332 | This directory contains any 'end result' output from the OpenEmbedded build process. | ||
| 333 | </para> | ||
| 334 | </section> | ||
| 335 | |||
| 336 | <section id='structure-build-tmp-deploy-deb'> | ||
| 337 | <title><filename>build/tmp/deploy/deb/</filename></title> | ||
| 338 | |||
| 339 | <para> | ||
| 340 | This directory receives any <filename>.deb</filename> packages produced by | ||
| 341 | the build process. | ||
| 342 | The packages are sorted into feeds for different architecture types. | ||
| 343 | </para> | ||
| 344 | </section> | ||
| 345 | |||
| 346 | <section id='structure-build-tmp-deploy-rpm'> | ||
| 347 | <title><filename>build/tmp/deploy/rpm/</filename></title> | ||
| 348 | |||
| 349 | <para> | ||
| 350 | This directory receives any <filename>.rpm</filename> packages produced by | ||
| 351 | the build process. | ||
| 352 | The packages are sorted into feeds for different architecture types. | ||
| 353 | </para> | ||
| 354 | </section> | ||
| 355 | |||
| 356 | <section id='structure-build-tmp-deploy-licenses'> | ||
| 357 | <title><filename>build/tmp/deploy/licenses/</filename></title> | ||
| 358 | |||
| 359 | <para> | ||
| 360 | This directory receives package licensing information. | ||
| 361 | For example, the directory contains sub-directories for <filename>bash</filename>, | ||
| 362 | <filename>busybox</filename>, and <filename>eglibc</filename> (among others) that in turn | ||
| 363 | contain appropriate <filename>COPYING</filename> license files with other licensing information. | ||
| 364 | </para> | ||
| 365 | </section> | ||
| 366 | |||
| 367 | <section id='structure-build-tmp-deploy-images'> | ||
| 368 | <title><filename>build/tmp/deploy/images/</filename></title> | ||
| 369 | |||
| 370 | <para> | ||
| 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. | ||
| 373 | </para> | ||
| 374 | |||
| 375 | <para> | ||
| 376 | Be careful when deleting files in this directory. | ||
| 377 | You can safely delete old images from this directory (e.g. | ||
| 378 | <filename>core-image-*</filename>, <filename>hob-image-*</filename>, | ||
| 379 | 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 | ||
| 382 | image. | ||
| 383 | Because these files, however, are not directly produced from the image, if you | ||
| 384 | delete them they will not be automatically re-created when you build the image again. | ||
| 385 | </para> | ||
| 386 | |||
| 387 | <para> | ||
| 388 | If you do accidentally delete files here, you will need to force them to be | ||
| 389 | re-created. | ||
| 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: | ||
| 392 | <literallayout class='monospaced'> | ||
| 393 | $ bitbake -c clean virtual/kernel | ||
| 394 | $ bitbake virtual/kernel | ||
| 395 | </literallayout> | ||
| 396 | </para> | ||
| 397 | </section> | ||
| 398 | |||
| 399 | <section id='structure-build-tmp-deploy-ipk'> | ||
| 400 | <title><filename>build/tmp/deploy/ipk/</filename></title> | ||
| 401 | |||
| 402 | <para> | ||
| 403 | This directory receives <filename>.ipk</filename> packages produced by | ||
| 404 | the build process.</para> | ||
| 405 | </section> | ||
| 406 | |||
| 407 | <section id='structure-build-tmp-sysroots'> | ||
| 408 | <title><filename>build/tmp/sysroots/</filename></title> | ||
| 409 | |||
| 410 | <para> | ||
| 411 | This directory contains shared header files and libraries as well as other shared | ||
| 412 | data. | ||
| 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 | ||
| 415 | the one Build Directory. | ||
| 416 | </para> | ||
| 417 | </section> | ||
| 418 | |||
| 419 | <section id='structure-build-tmp-stamps'> | ||
| 420 | <title><filename>build/tmp/stamps/</filename></title> | ||
| 421 | |||
| 422 | <para> | ||
| 423 | This directory holds information that BitBake uses for accounting purposes | ||
| 424 | to track what tasks have run and when they have run. | ||
| 425 | The directory is sub-divided by architecture, package name, and | ||
| 426 | version. | ||
| 427 | Following is an example: | ||
| 428 | <literallayout class='monospaced'> | ||
| 429 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do | ||
| 430 | </literallayout> | ||
| 431 | Although the files in the directory are empty of data, | ||
| 432 | BitBake uses the filenames and timestamps for tracking purposes. | ||
| 433 | </para> | ||
| 434 | </section> | ||
| 435 | |||
| 436 | <section id='structure-build-tmp-log'> | ||
| 437 | <title><filename>build/tmp/log/</filename></title> | ||
| 438 | |||
| 439 | <para> | ||
| 440 | This directory contains general logs that are not otherwise placed using the | ||
| 441 | package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. | ||
| 442 | Examples of logs are the output from the <filename>check_pkg</filename> or | ||
| 443 | <filename>distro_check</filename> tasks. | ||
| 444 | Running a build does not necessarily mean this directory is created. | ||
| 445 | </para> | ||
| 446 | </section> | ||
| 447 | |||
| 448 | <section id='structure-build-tmp-pkgdata'> | ||
| 449 | <title><filename>build/tmp/pkgdata/</filename></title> | ||
| 450 | |||
| 451 | <para> | ||
| 452 | This directory contains intermediate packaging data that is used later in the packaging process. | ||
| 453 | For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section. | ||
| 454 | </para> | ||
| 455 | </section> | ||
| 456 | |||
| 457 | <section id='structure-build-tmp-work'> | ||
| 458 | <title><filename>build/tmp/work/</filename></title> | ||
| 459 | |||
| 460 | <para> | ||
| 461 | This directory contains architecture-specific work sub-directories | ||
| 462 | for packages built by BitBake. | ||
| 463 | All tasks execute from the appropriate work directory. | ||
| 464 | For example, the source for a particular package is unpacked, | ||
| 465 | patched, configured and compiled all within its own work directory. | ||
| 466 | Within the work directory, organization is based on the package group | ||
| 467 | and version for which the source is being compiled | ||
| 468 | as defined by the | ||
| 469 | <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. | ||
| 470 | </para> | ||
| 471 | |||
| 472 | <para> | ||
| 473 | It is worth considering the structure of a typical work directory. | ||
| 474 | As an example, consider the <filename>linux-yocto-kernel-3.0</filename> | ||
| 475 | on the machine <filename>qemux86</filename> | ||
| 476 | built within the Yocto Project. | ||
| 477 | For this package, a work directory of | ||
| 478 | <filename>tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....></filename>, | ||
| 479 | referred to as the | ||
| 480 | <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, is created. | ||
| 481 | Within this directory, the source is unpacked to | ||
| 482 | <filename>linux-qemux86-standard-build</filename> and then patched by Quilt | ||
| 483 | (see the | ||
| 484 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Modifying Package | ||
| 485 | Source Code with Quilt</ulink>" section in the Yocto Project Development Manual. | ||
| 486 | Within the <filename>linux-qemux86-standard-build</filename> directory, | ||
| 487 | standard Quilt directories <filename>linux-3.0/patches</filename> | ||
| 488 | and <filename>linux-3.0/.pc</filename> are created, | ||
| 489 | and standard Quilt commands can be used. | ||
| 490 | </para> | ||
| 491 | |||
| 492 | <para> | ||
| 493 | There are other directories generated within <filename>WORKDIR</filename>. | ||
| 494 | The most important directory is <filename>WORKDIR/temp/</filename>, | ||
| 495 | which has log files for each task (<filename>log.do_*.pid</filename>) | ||
| 496 | and contains the scripts BitBake runs for each task | ||
| 497 | (<filename>run.do_*.pid</filename>). | ||
| 498 | The <filename>WORKDIR/image/</filename> directory is where "make | ||
| 499 | install" places its output that is then split into sub-packages | ||
| 500 | within <filename>WORKDIR/packages-split/</filename>. | ||
| 501 | </para> | ||
| 502 | </section> | ||
| 503 | </section> | ||
| 504 | |||
| 505 | <section id='structure-meta'> | ||
| 506 | <title>The Metadata - <filename>meta/</filename></title> | ||
| 507 | |||
| 508 | <para> | ||
| 509 | As mentioned previously, metadata is the core of the Yocto Project. | ||
| 510 | Metadata has several important subdivisions: | ||
| 511 | </para> | ||
| 512 | |||
| 513 | <section id='structure-meta-classes'> | ||
| 514 | <title><filename>meta/classes/</filename></title> | ||
| 515 | |||
| 516 | <para> | ||
| 517 | This directory contains the <filename>*.bbclass</filename> files. | ||
| 518 | Class files are used to abstract common code so it can be reused by multiple | ||
| 519 | packages. | ||
| 520 | Every package inherits the <filename>base.bbclass</filename> file. | ||
| 521 | Examples of other important classes are <filename>autotools.bbclass</filename>, which | ||
| 522 | in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort. | ||
| 523 | Another example is <filename>kernel.bbclass</filename> that contains common code and functions | ||
| 524 | for working with the Linux kernel. | ||
| 525 | Functions like image generation or packaging also have their specific class files | ||
| 526 | such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and | ||
| 527 | <filename>package*.bbclass</filename>. | ||
| 528 | </para> | ||
| 529 | </section> | ||
| 530 | |||
| 531 | <section id='structure-meta-conf'> | ||
| 532 | <title><filename>meta/conf/</filename></title> | ||
| 533 | |||
| 534 | <para> | ||
| 535 | This directory contains the core set of configuration files that start from | ||
| 536 | <filename>bitbake.conf</filename> and from which all other configuration | ||
| 537 | files are included. | ||
| 538 | See the include statements at the end of the file and you will note that even | ||
| 539 | <filename>local.conf</filename> is loaded from there. | ||
| 540 | While <filename>bitbake.conf</filename> sets up the defaults, you can often override | ||
| 541 | these by using the (<filename>local.conf</filename>) file, machine file or | ||
| 542 | the distribution configuration file. | ||
| 543 | </para> | ||
| 544 | </section> | ||
| 545 | |||
| 546 | <section id='structure-meta-conf-machine'> | ||
| 547 | <title><filename>meta/conf/machine/</filename></title> | ||
| 548 | |||
| 549 | <para> | ||
| 550 | This directory contains all the machine configuration files. | ||
| 551 | If you set <filename>MACHINE="qemux86"</filename>, | ||
| 552 | the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this | ||
| 553 | directory. | ||
| 554 | The <filename>include</filename> directory contains various data common to multiple machines. | ||
| 555 | If you want to add support for a new machine to the Yocto Project, look in this directory. | ||
| 556 | </para> | ||
| 557 | </section> | ||
| 558 | |||
| 559 | <section id='structure-meta-conf-distro'> | ||
| 560 | <title><filename>meta/conf/distro/</filename></title> | ||
| 561 | |||
| 562 | <para> | ||
| 563 | Any distribution-specific configuration is controlled from this directory. | ||
| 564 | For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here. | ||
| 565 | This directory includes the versions and the | ||
| 566 | <filename>SRCDATE</filename> definitions for applications that are configured here. | ||
| 567 | An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>. | ||
| 568 | Although this file mainly inherits its configuration from Poky. | ||
| 569 | </para> | ||
| 570 | </section> | ||
| 571 | |||
| 572 | <section id='structure-meta-recipes-bsp'> | ||
| 573 | <title><filename>meta/recipes-bsp/</filename></title> | ||
| 574 | |||
| 575 | <para> | ||
| 576 | This directory contains anything linking to specific hardware or hardware | ||
| 577 | configuration information such as "u-boot" and "grub". | ||
| 578 | </para> | ||
| 579 | </section> | ||
| 580 | |||
| 581 | <section id='structure-meta-recipes-connectivity'> | ||
| 582 | <title><filename>meta/recipes-connectivity/</filename></title> | ||
| 583 | |||
| 584 | <para> | ||
| 585 | This directory contains libraries and applications related to communication with other devices. | ||
| 586 | </para> | ||
| 587 | </section> | ||
| 588 | |||
| 589 | <section id='structure-meta-recipes-core'> | ||
| 590 | <title><filename>meta/recipes-core/</filename></title> | ||
| 591 | |||
| 592 | <para> | ||
| 593 | This directory contains what is needed to build a basic working Linux image | ||
| 594 | including commonly used dependencies. | ||
| 595 | </para> | ||
| 596 | </section> | ||
| 597 | |||
| 598 | <section id='structure-meta-recipes-devtools'> | ||
| 599 | <title><filename>meta/recipes-devtools/</filename></title> | ||
| 600 | |||
| 601 | <para> | ||
| 602 | This directory contains tools that are primarily used by the build system. | ||
| 603 | The tools, however, can also be used on targets. | ||
| 604 | </para> | ||
| 605 | </section> | ||
| 606 | |||
| 607 | <section id='structure-meta-recipes-extended'> | ||
| 608 | <title><filename>meta/recipes-extended/</filename></title> | ||
| 609 | |||
| 610 | <para> | ||
| 611 | This directory contains non-essential applications that add features compared to the | ||
| 612 | alternatives in core. | ||
| 613 | You might need this directory for full tool functionality or for Linux Standard Base (LSB) | ||
| 614 | compliance. | ||
| 615 | </para> | ||
| 616 | </section> | ||
| 617 | |||
| 618 | <section id='structure-meta-recipes-gnome'> | ||
| 619 | <title><filename>meta/recipes-gnome/</filename></title> | ||
| 620 | |||
| 621 | <para> | ||
| 622 | This directory contains all things related to the GTK+ application framework. | ||
| 623 | </para> | ||
| 624 | </section> | ||
| 625 | |||
| 626 | <section id='structure-meta-recipes-graphics'> | ||
| 627 | <title><filename>meta/recipes-graphics/</filename></title> | ||
| 628 | |||
| 629 | <para> | ||
| 630 | This directory contains X and other graphically related system libraries | ||
| 631 | </para> | ||
| 632 | </section> | ||
| 633 | |||
| 634 | <section id='structure-meta-recipes-kernel'> | ||
| 635 | <title><filename>meta/recipes-kernel/</filename></title> | ||
| 636 | |||
| 637 | <para> | ||
| 638 | This directory contains the kernel and generic applications and libraries that | ||
| 639 | have strong kernel dependencies. | ||
| 640 | </para> | ||
| 641 | </section> | ||
| 642 | |||
| 643 | <section id='structure-meta-recipes-multimedia'> | ||
| 644 | <title><filename>meta/recipes-multimedia/</filename></title> | ||
| 645 | |||
| 646 | <para> | ||
| 647 | This directory contains codecs and support utilities for audio, images and video. | ||
| 648 | </para> | ||
| 649 | </section> | ||
| 650 | |||
| 651 | <section id='structure-meta-recipes-qt'> | ||
| 652 | <title><filename>meta/recipes-qt/</filename></title> | ||
| 653 | |||
| 654 | <para> | ||
| 655 | This directory contains all things related to the Qt application framework. | ||
| 656 | </para> | ||
| 657 | </section> | ||
| 658 | |||
| 659 | <section id='structure-meta-recipes-rt'> | ||
| 660 | <title><filename>meta/recipes-rt/</filename></title> | ||
| 661 | |||
| 662 | <para> | ||
| 663 | This directory contains package and image recipes for using and testing | ||
| 664 | the <filename>PREEMPT_RT</filename> kernel. | ||
| 665 | </para> | ||
| 666 | </section> | ||
| 667 | |||
| 668 | <section id='structure-meta-recipes-sato'> | ||
| 669 | <title><filename>meta/recipes-sato/</filename></title> | ||
| 670 | |||
| 671 | <para> | ||
| 672 | This directory contains the Sato demo/reference UI/UX and its associated applications | ||
| 673 | and configuration data. | ||
| 674 | </para> | ||
| 675 | </section> | ||
| 676 | |||
| 677 | <section id='structure-meta-recipes-support'> | ||
| 678 | <title><filename>meta/recipes-support/</filename></title> | ||
| 679 | |||
| 680 | <para> | ||
| 681 | This directory contains recipes that used by other recipes, but that are not directly | ||
| 682 | included in images (i.e. dependencies of other recipes). | ||
| 683 | </para> | ||
| 684 | </section> | ||
| 685 | |||
| 686 | <section id='structure-meta-site'> | ||
| 687 | <title><filename>meta/site/</filename></title> | ||
| 688 | |||
| 689 | <para> | ||
| 690 | This directory contains a list of cached results for various architectures. | ||
| 691 | Because certain "autoconf" test results cannot be determined when cross-compiling due to | ||
| 692 | the tests not able to run on a live system, the information in this directory is | ||
| 693 | passed to "autoconf" for the various architectures. | ||
| 694 | </para> | ||
| 695 | </section> | ||
| 696 | |||
| 697 | <section id='structure-meta-recipes-txt'> | ||
| 698 | <title><filename>meta/recipes.txt</filename></title> | ||
| 699 | |||
| 700 | <para> | ||
| 701 | This file is a description of the contents of <filename>recipes-*</filename>. | ||
| 702 | </para> | ||
| 703 | </section> | ||
| 704 | </section> | ||
| 705 | |||
| 706 | </chapter> | ||
| 707 | <!-- | ||
| 708 | vim: expandtab tw=80 ts=4 | ||
| 709 | --> | ||
