summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/user-manual/user-manual-execution.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-06 09:48:37 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-09 18:59:04 -0700
commit40ab94036081f9fdc4ebf6126b077149c2a97c31 (patch)
tree65075fcb43ab2e731a9891063878d13addf0737e /bitbake/doc/user-manual/user-manual-execution.xml
parent96294ee40748dd96da7203cedf93a42e34b2a468 (diff)
downloadpoky-40ab94036081f9fdc4ebf6126b077149c2a97c31.tar.gz
bitbake: user-manual: Review edits applied from Paul Eggleton.
Review of the entire manual by Paul. I have implemented his suggestions throughout. (Bitbake rev: 5cd310d1df194cd171691a4bcfb98024e2bc66b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/user-manual/user-manual-execution.xml')
-rw-r--r--bitbake/doc/user-manual/user-manual-execution.xml62
1 files changed, 17 insertions, 45 deletions
diff --git a/bitbake/doc/user-manual/user-manual-execution.xml b/bitbake/doc/user-manual/user-manual-execution.xml
index d451ebb533..6110a93e2a 100644
--- a/bitbake/doc/user-manual/user-manual-execution.xml
+++ b/bitbake/doc/user-manual/user-manual-execution.xml
@@ -87,21 +87,6 @@
87 just constructed. 87 just constructed.
88 The <filename>bitbake.conf</filename> file usually indicates 88 The <filename>bitbake.conf</filename> file usually indicates
89 all the other key include files to parse. 89 all the other key include files to parse.
90 The usual convention is to have machine, distro, site, and local
91 configurations.
92 This means a user provides their own customizations
93 through a <filename>local.conf</filename> file.
94 </para>
95
96 <para>
97 As mentioned in the previous paragraph, two of the other notable
98 configuration files are the distro and machine configuration
99 files.
100 These configuration files are normally identified by
101 variables unique to the build systems using BitBake.
102 For example, the Yocto Project uses the
103 <filename>DISTRO</filename> and <filename>MACHINE</filename>
104 variables, respectively.
105 </para> 90 </para>
106 91
107 <para> 92 <para>
@@ -122,7 +107,7 @@
122 107
123 <para> 108 <para>
124 The base configuration metadata is global 109 The base configuration metadata is global
125 and therefore affects all packages and tasks that are executed. 110 and therefore affects all recipes and tasks that are executed.
126 </para> 111 </para>
127 112
128 <para> 113 <para>
@@ -161,10 +146,11 @@
161 These variables might have been set from the environment 146 These variables might have been set from the environment
162 depending on the environment variables previously 147 depending on the environment variables previously
163 mentioned or set in the configuration files. 148 mentioned or set in the configuration files.
164 See the 149 The
165 "<link linkend='ref-variables-glos'>Variables Glossary</link>" 150 "<link linkend='ref-variables-glos'>Variables Glossary</link>"
166 for a full list of variables. 151 chapter presents a full list of variables.
167 The following list shows common variables set: 152<!--
153 Here are some common ones used:
168 <itemizedlist> 154 <itemizedlist>
169 <listitem><para> 155 <listitem><para>
170 <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> 156 <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
@@ -215,6 +201,7 @@
215 <link linkend='var-BBINCLUDED'><filename>BBINCLUDED</filename></link> 201 <link linkend='var-BBINCLUDED'><filename>BBINCLUDED</filename></link>
216 </para></listitem> 202 </para></listitem>
217 </itemizedlist> 203 </itemizedlist>
204-->
218 </para> 205 </para>
219 206
220 <para> 207 <para>
@@ -305,7 +292,7 @@
305 </para> 292 </para>
306 293
307 <para> 294 <para>
308 BitBake does not need all this information. 295 BitBake does not need all of this information.
309 It only needs a small subset of the information to make 296 It only needs a small subset of the information to make
310 decisions about the recipe. 297 decisions about the recipe.
311 Consequently, BitBake caches the values in which it is 298 Consequently, BitBake caches the values in which it is
@@ -375,7 +362,7 @@
375 <literallayout class='monospaced'> 362 <literallayout class='monospaced'>
376 PROVIDES += "virtual/package" 363 PROVIDES += "virtual/package"
377 </literallayout> 364 </literallayout>
378 The recipe now provides both "package1" and "virtual/package. 365 The recipe now provides both "package1" and "virtual/package".
379 The "virtual/" namespace is often used to denote cases where 366 The "virtual/" namespace is often used to denote cases where
380 multiple providers are expected with the user choosing between 367 multiple providers are expected with the user choosing between
381 them. 368 them.
@@ -395,20 +382,8 @@
395 The default 382 The default
396 <link linkend='var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></link> 383 <link linkend='var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></link>
397 is the provider with the same name as the target. 384 is the provider with the same name as the target.
398 </para> 385 Bitbake iterates through each target it needs to build and
399 386 resolves them and their dependencies using this process.
400 <para>
401 Bitbake iterates through each target it needs to build and resolve
402 them using this process.
403 As an example, suppose the target is
404 <filename>core-image-sato</filename>.
405 In this case, it would lead to
406 <filename>packagegroup-core-x11-sato</filename>,
407 which in turn leads to recipes like
408 <filename>matchbox-terminal</filename>, <filename>pcmanfm</filename>
409 and <filename>gthumb</filename>.
410 These recipes in turn depend on <filename>eglibc</filename>
411 and the toolchain.
412 </para> 387 </para>
413 388
414 <para> 389 <para>
@@ -418,21 +393,21 @@
418 Version comparisons are made using the same method as Debian. 393 Version comparisons are made using the same method as Debian.
419 You can use the 394 You can use the
420 <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link> 395 <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link>
421 variable to specify a particular version (usually in the distro configuration). 396 variable to specify a particular version.
422 You can influence the order by using the 397 You can influence the order by using the
423 <link linkend='var-DEFAULT_PREFERENCE'><filename>DEFAULT_PREFERENCE</filename></link> 398 <link linkend='var-DEFAULT_PREFERENCE'><filename>DEFAULT_PREFERENCE</filename></link>
424 variable. 399 variable.
425 By default, files have a preference of "0". 400 By default, files have a preference of "0".
426 Setting the <filename>DEFAULT_PREFERENCE</filename> to "-1" makes the 401 Setting the <filename>DEFAULT_PREFERENCE</filename> to "-1" makes the
427 package unlikely to be used unless it is explicitly referenced. 402 recipe unlikely to be used unless it is explicitly referenced.
428 Setting the <filename>DEFAULT_PREFERENCE</filename> to "1" makes it likely the package is used. 403 Setting the <filename>DEFAULT_PREFERENCE</filename> to "1" makes it likely the recipe is used.
429 <filename>PREFERRED_VERSION</filename> overrides any <filename>DEFAULT_PREFERENCE</filename> setting. 404 <filename>PREFERRED_VERSION</filename> overrides any <filename>DEFAULT_PREFERENCE</filename> setting.
430 <filename>DEFAULT_PREFERENCE</filename> is often used to mark newer and more experimental package 405 <filename>DEFAULT_PREFERENCE</filename> is often used to mark newer and more experimental recipe
431 versions until they have undergone sufficient testing to be considered stable. 406 versions until they have undergone sufficient testing to be considered stable.
432 </para> 407 </para>
433 408
434 <para> 409 <para>
435 When there are multiple “versions” of a given package, 410 When there are multiple “versions” of a given recipe,
436 BitBake defaults to selecting the most recent 411 BitBake defaults to selecting the most recent
437 version, unless otherwise specified. 412 version, unless otherwise specified.
438 If the recipe in question has a 413 If the recipe in question has a
@@ -573,12 +548,12 @@
573 <para> 548 <para>
574 Tasks can either be a shell task or a Python task. 549 Tasks can either be a shell task or a Python task.
575 For shell tasks, BitBake writes a shell script to 550 For shell tasks, BitBake writes a shell script to
576 <filename>${WORKDIR}/temp/run.do_taskname.pid</filename> 551 <filename>${</filename><link linkend='var-T'><filename>T</filename></link><filename>}/run.do_taskname.pid</filename>
577 and then executes the script. 552 and then executes the script.
578 The generated shell script contains all the exported variables, 553 The generated shell script contains all the exported variables,
579 and the shell functions with all variables expanded. 554 and the shell functions with all variables expanded.
580 Output from the shell script goes to the file 555 Output from the shell script goes to the file
581 <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>. 556 <filename>${T}/log.do_taskname.pid</filename>.
582 Looking at the expanded shell functions in the run file and 557 Looking at the expanded shell functions in the run file and
583 the output in the log files is a useful debugging technique. 558 the output in the log files is a useful debugging technique.
584 </para> 559 </para>
@@ -831,9 +806,6 @@
831 a setscene task named <filename>xxx_setscene</filename>. 806 a setscene task named <filename>xxx_setscene</filename>.
832 The setscene version of the task executes and provides the necessary 807 The setscene version of the task executes and provides the necessary
833 artifacts returning either success or failure. 808 artifacts returning either success or failure.
834 <note>
835 Artifacts might need to be fetched from the network.
836 </note>
837 </para> 809 </para>
838 810
839 <para> 811 <para>