diff options
Diffstat (limited to 'bitbake')
-rw-r--r-- | bitbake/doc/user-manual/user-manual-execution.xml | 12 | ||||
-rw-r--r-- | bitbake/doc/user-manual/user-manual-fetching.xml | 2 | ||||
-rw-r--r-- | bitbake/doc/user-manual/user-manual-intro.xml | 16 | ||||
-rw-r--r-- | bitbake/doc/user-manual/user-manual-metadata.xml | 40 | ||||
-rw-r--r-- | bitbake/doc/user-manual/user-manual-ref-variables.xml | 53 |
5 files changed, 71 insertions, 52 deletions
diff --git a/bitbake/doc/user-manual/user-manual-execution.xml b/bitbake/doc/user-manual/user-manual-execution.xml index 6110a93e2a..a67516e858 100644 --- a/bitbake/doc/user-manual/user-manual-execution.xml +++ b/bitbake/doc/user-manual/user-manual-execution.xml | |||
@@ -85,8 +85,10 @@ | |||
85 | Next, the <filename>bitbake.conf</filename> file is searched | 85 | Next, the <filename>bitbake.conf</filename> file is searched |
86 | using the <filename>BBPATH</filename> variable that was | 86 | using the <filename>BBPATH</filename> variable that was |
87 | just constructed. | 87 | just constructed. |
88 | The <filename>bitbake.conf</filename> file usually indicates | 88 | The <filename>bitbake.conf</filename> file may also include other |
89 | all the other key include files to parse. | 89 | configuration files using the |
90 | <filename>include</filename> or | ||
91 | <filename>require</filename> directives. | ||
90 | </para> | 92 | </para> |
91 | 93 | ||
92 | <para> | 94 | <para> |
@@ -358,11 +360,11 @@ | |||
358 | 360 | ||
359 | <para> | 361 | <para> |
360 | As an example of adding an extra provider, suppose a recipe named | 362 | As an example of adding an extra provider, suppose a recipe named |
361 | <filename>package1.bb</filename> contained the following: | 363 | <filename>foo_1.0.bb</filename> contained the following: |
362 | <literallayout class='monospaced'> | 364 | <literallayout class='monospaced'> |
363 | PROVIDES += "virtual/package" | 365 | PROVIDES += "virtual/bar_1.0" |
364 | </literallayout> | 366 | </literallayout> |
365 | The recipe now provides both "package1" and "virtual/package". | 367 | The recipe now provides both "foo_1.0" and "virtual/bar_1.0". |
366 | The "virtual/" namespace is often used to denote cases where | 368 | The "virtual/" namespace is often used to denote cases where |
367 | multiple providers are expected with the user choosing between | 369 | multiple providers are expected with the user choosing between |
368 | them. | 370 | them. |
diff --git a/bitbake/doc/user-manual/user-manual-fetching.xml b/bitbake/doc/user-manual/user-manual-fetching.xml index c66596ed6e..5aa53defc4 100644 --- a/bitbake/doc/user-manual/user-manual-fetching.xml +++ b/bitbake/doc/user-manual/user-manual-fetching.xml | |||
@@ -50,7 +50,7 @@ | |||
50 | </para> | 50 | </para> |
51 | 51 | ||
52 | <para> | 52 | <para> |
53 | The instance of the fetch module is usually followed by: | 53 | The instantiation of the fetch class is usually followed by: |
54 | <literallayout class='monospaced'> | 54 | <literallayout class='monospaced'> |
55 | rootdir = l.getVar('WORKDIR', True) | 55 | rootdir = l.getVar('WORKDIR', True) |
56 | fetcher.unpack(rootdir) | 56 | fetcher.unpack(rootdir) |
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml index d46e823c72..c7f01ad726 100644 --- a/bitbake/doc/user-manual/user-manual-intro.xml +++ b/bitbake/doc/user-manual/user-manual-intro.xml | |||
@@ -421,8 +421,8 @@ | |||
421 | <title>The BitBake Command</title> | 421 | <title>The BitBake Command</title> |
422 | 422 | ||
423 | <para> | 423 | <para> |
424 | The BitBake command is the primary interface to the BitBake | 424 | The <filename>bitbake</filename> command is the primary interface |
425 | tool. | 425 | to the BitBake tool. |
426 | This section presents the BitBake command syntax and provides | 426 | This section presents the BitBake command syntax and provides |
427 | several execution examples. | 427 | several execution examples. |
428 | </para> | 428 | </para> |
@@ -536,13 +536,16 @@ Options: | |||
536 | $ bitbake -b foo_1.0.bb | 536 | $ bitbake -b foo_1.0.bb |
537 | </literallayout> | 537 | </literallayout> |
538 | The following command runs the clean task on the | 538 | The following command runs the clean task on the |
539 | <filename>foo_1.0.bb</filename> recipe file: | 539 | <filename>foo.bb</filename> recipe file: |
540 | <literallayout class='monospaced'> | 540 | <literallayout class='monospaced'> |
541 | $ bitbake -b foo.bb -c clean | 541 | $ bitbake -b foo.bb -c clean |
542 | </literallayout> | 542 | </literallayout> |
543 | <note> | 543 | <note> |
544 | The "-b" option explicitly does not handle recipe | 544 | The "-b" option explicitly does not handle recipe |
545 | dependencies. | 545 | dependencies. |
546 | Other than for debugging purposes, it is instead | ||
547 | recommended that you use the syntax presented in the | ||
548 | next section. | ||
546 | </note> | 549 | </note> |
547 | </para> | 550 | </para> |
548 | </section> | 551 | </section> |
@@ -570,9 +573,7 @@ Options: | |||
570 | "--buildfile" or "-b" only accepts a "PROVIDES". | 573 | "--buildfile" or "-b" only accepts a "PROVIDES". |
571 | You cannot provide anything else. | 574 | You cannot provide anything else. |
572 | By default, a recipe file generally "PROVIDES" its | 575 | By default, a recipe file generally "PROVIDES" its |
573 | "packagename", "packagename-version", and | 576 | "packagename" as shown in the following example: |
574 | "packagename-version-revision" as shown in the following | ||
575 | example: | ||
576 | <literallayout class='monospaced'> | 577 | <literallayout class='monospaced'> |
577 | $ bitbake foo | 578 | $ bitbake foo |
578 | </literallayout> | 579 | </literallayout> |
@@ -628,7 +629,8 @@ Options: | |||
628 | 629 | ||
629 | <para> | 630 | <para> |
630 | Here are two examples that create dependency graphs. | 631 | Here are two examples that create dependency graphs. |
631 | The second example omits common depends from the graph: | 632 | The second example omits depends common in OpenEmbedded from |
633 | the graph: | ||
632 | <literallayout class='monospaced'> | 634 | <literallayout class='monospaced'> |
633 | $ bitbake -g foo | 635 | $ bitbake -g foo |
634 | 636 | ||
diff --git a/bitbake/doc/user-manual/user-manual-metadata.xml b/bitbake/doc/user-manual/user-manual-metadata.xml index 3a19b96303..f7682c0fed 100644 --- a/bitbake/doc/user-manual/user-manual-metadata.xml +++ b/bitbake/doc/user-manual/user-manual-metadata.xml | |||
@@ -41,14 +41,18 @@ | |||
41 | contents using a syntax that is similar to shell scripting. | 41 | contents using a syntax that is similar to shell scripting. |
42 | Following is an example that results in <filename>A</filename> | 42 | Following is an example that results in <filename>A</filename> |
43 | containing "aval" and <filename>B</filename> evaluating to | 43 | containing "aval" and <filename>B</filename> evaluating to |
44 | "preavalpost". | 44 | "preavalpost" based on that current value of |
45 | <filename>A</filename>. | ||
45 | <literallayout class='monospaced'> | 46 | <literallayout class='monospaced'> |
46 | A = "aval" | 47 | A = "aval" |
47 | B = "pre${A}post" | 48 | B = "pre${A}post" |
48 | </literallayout> | 49 | </literallayout> |
49 | Because the expansion happens later, the value of | 50 | You should realize that whenever <filename>B</filename> is |
50 | <filename>B</filename> expands differently if the value | 51 | referenced, its evaluation will depend on the state of |
51 | of <filename>A</filename> changes. | 52 | <filename>A</filename> at that time. |
53 | Thus, later evaluations of <filename>B</filename> in the | ||
54 | previous example could result in different values | ||
55 | depending on the value of <filename>A</filename>. | ||
52 | </para> | 56 | </para> |
53 | </section> | 57 | </section> |
54 | 58 | ||
@@ -1387,19 +1391,16 @@ | |||
1387 | Using "expand=True" expands the value.</entry> | 1391 | Using "expand=True" expands the value.</entry> |
1388 | </row> | 1392 | </row> |
1389 | <row> | 1393 | <row> |
1390 | <entry align="left"><filename>d.setVar("X", value)</filename></entry> | 1394 | <entry align="left"><filename>d.setVar("X", "value")</filename></entry> |
1391 | <entry align="left">Sets the variable "X" to the value of the Python | 1395 | <entry align="left">Sets the variable "X" to "value".</entry> |
1392 | variable called "value".</entry> | ||
1393 | </row> | 1396 | </row> |
1394 | <row> | 1397 | <row> |
1395 | <entry align="left"><filename>d.appendVar("X", value)</filename></entry> | 1398 | <entry align="left"><filename>d.appendVar("X", "value")</filename></entry> |
1396 | <entry align="left">Adds the value of the Python variable called | 1399 | <entry align="left">Adds "value" to the end of the variable "X".</entry> |
1397 | "value" to the end of the variable "X".</entry> | ||
1398 | </row> | 1400 | </row> |
1399 | <row> | 1401 | <row> |
1400 | <entry align="left"><filename>d.prependVar("X", value)</filename></entry> | 1402 | <entry align="left"><filename>d.prependVar("X", "value")</filename></entry> |
1401 | <entry align="left">Adds the value of the Python variable called | 1403 | <entry align="left">Adds "value" to the start of the variable "X".</entry> |
1402 | "value" to the start of the variable "X".</entry> | ||
1403 | </row> | 1404 | </row> |
1404 | <row> | 1405 | <row> |
1405 | <entry align="left"><filename>d.delVar("X")</filename></entry> | 1406 | <entry align="left"><filename>d.delVar("X")</filename></entry> |
@@ -1415,18 +1416,17 @@ | |||
1415 | Using "expand=True" expands the named flag.</entry> | 1416 | Using "expand=True" expands the named flag.</entry> |
1416 | </row> | 1417 | </row> |
1417 | <row> | 1418 | <row> |
1418 | <entry align="left"><filename>d.setVarFlag("X", flag, value)</filename></entry> | 1419 | <entry align="left"><filename>d.setVarFlag("X", flag, "value")</filename></entry> |
1419 | <entry align="left">Sets the named flag for variable "X" to the value | 1420 | <entry align="left">Sets the named flag for variable "X" to "value".</entry> |
1420 | of the Python variable called "value".</entry> | ||
1421 | </row> | 1421 | </row> |
1422 | <row> | 1422 | <row> |
1423 | <entry align="left"><filename>d.appendVarFlag("X", flag, value)</filename></entry> | 1423 | <entry align="left"><filename>d.appendVarFlag("X", flag, "value")</filename></entry> |
1424 | <entry align="left">Appends a value to the named flag on the | 1424 | <entry align="left">Appends "value" to the named flag on the |
1425 | variable "X".</entry> | 1425 | variable "X".</entry> |
1426 | </row> | 1426 | </row> |
1427 | <row> | 1427 | <row> |
1428 | <entry align="left"><filename>d.prependVarFlag("X", flag, value)</filename></entry> | 1428 | <entry align="left"><filename>d.prependVarFlag("X", flag, "value")</filename></entry> |
1429 | <entry align="left">Prepends a value to the named flag on | 1429 | <entry align="left">Prepends "value" to the named flag on |
1430 | the variable "X".</entry> | 1430 | the variable "X".</entry> |
1431 | </row> | 1431 | </row> |
1432 | <row> | 1432 | <row> |
diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index b785f04aba..6a5af89ffa 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml | |||
@@ -102,6 +102,15 @@ | |||
102 | </glossdef> | 102 | </glossdef> |
103 | </glossentry> | 103 | </glossentry> |
104 | 104 | ||
105 | <glossentry id='var-BB_CONSOLELOG'><glossterm>BB_CONSOLELOG</glossterm> | ||
106 | <glossdef> | ||
107 | <para> | ||
108 | Specifies the path to a log file into which BitBake's user | ||
109 | interface writes output during the build. | ||
110 | </para> | ||
111 | </glossdef> | ||
112 | </glossentry> | ||
113 | |||
105 | <glossentry id='var-BB_CURRENTTASK'><glossterm>BB_CURRENTTASK</glossterm> | 114 | <glossentry id='var-BB_CURRENTTASK'><glossterm>BB_CURRENTTASK</glossterm> |
106 | <glossdef> | 115 | <glossdef> |
107 | <para> | 116 | <para> |
@@ -681,12 +690,19 @@ | |||
681 | <glossentry id='var-BB_SIGNATURE_EXCLUDE_FLAGS'><glossterm>BB_SIGNATURE_EXCLUDE_FLAGS</glossterm> | 690 | <glossentry id='var-BB_SIGNATURE_EXCLUDE_FLAGS'><glossterm>BB_SIGNATURE_EXCLUDE_FLAGS</glossterm> |
682 | <glossdef> | 691 | <glossdef> |
683 | <para> | 692 | <para> |
684 | Lists flags that can be safely excluded from checksum | 693 | Lists variable flags (varflags) |
694 | that can be safely excluded from checksum | ||
685 | and dependency data for keys in the datastore. | 695 | and dependency data for keys in the datastore. |
686 | When generating checksum or dependency data for keys in the | 696 | When generating checksum or dependency data for keys in the |
687 | datastore, the flags set against that key are normally | 697 | datastore, the flags set against that key are normally |
688 | included in the checksum. | 698 | included in the checksum. |
689 | </para> | 699 | </para> |
700 | |||
701 | <para> | ||
702 | For more information on varflags, see the | ||
703 | "<link linkend='variable-flags'>Variable Flags</link>" | ||
704 | section. | ||
705 | </para> | ||
690 | </glossdef> | 706 | </glossdef> |
691 | </glossentry> | 707 | </glossentry> |
692 | 708 | ||
@@ -959,7 +975,23 @@ | |||
959 | 975 | ||
960 | <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> | 976 | <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> |
961 | <glossdef> | 977 | <glossdef> |
962 | <para>Variable that controls how BitBake displays logs on build failure.</para> | 978 | <para> |
979 | If set to a value, enables printing the task log when | ||
980 | reporting a failed task. | ||
981 | </para> | ||
982 | </glossdef> | ||
983 | </glossentry> | ||
984 | |||
985 | <glossentry id='var-BBINCLUDELOGS_LINES'><glossterm>BBINCLUDELOGS_LINES</glossterm> | ||
986 | <glossdef> | ||
987 | <para> | ||
988 | If | ||
989 | <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link> | ||
990 | is set, specifies the maximum number of lines from the | ||
991 | task log file to print when reporting a failed task. | ||
992 | If you do not set <filename>BBINCLUDELOGS_LINES</filename>, | ||
993 | the entire log is printed. | ||
994 | </para> | ||
963 | </glossdef> | 995 | </glossdef> |
964 | </glossentry> | 996 | </glossentry> |
965 | 997 | ||
@@ -1483,14 +1515,6 @@ | |||
1483 | the upstream source, and then locations specified by | 1515 | the upstream source, and then locations specified by |
1484 | <filename>MIRRORS</filename> in that order. | 1516 | <filename>MIRRORS</filename> in that order. |
1485 | </para> | 1517 | </para> |
1486 | |||
1487 | <para> | ||
1488 | Assuming your distribution (<filename>DISTRO</filename>) | ||
1489 | is "poky", the default value for | ||
1490 | <filename>MIRRORS</filename> is defined in the | ||
1491 | <filename>conf/distro/poky.conf</filename> file in the | ||
1492 | <filename>meta-yocto</filename> Git repository. | ||
1493 | </para> | ||
1494 | </glossdef> | 1518 | </glossdef> |
1495 | </glossentry> | 1519 | </glossentry> |
1496 | 1520 | ||
@@ -1697,15 +1721,6 @@ | |||
1697 | </para> | 1721 | </para> |
1698 | 1722 | ||
1699 | <para> | 1723 | <para> |
1700 | Assuming your distribution | ||
1701 | (<filename>DISTRO</filename>) | ||
1702 | is "poky", the default value for | ||
1703 | <filename>PREMIRRORS</filename> is defined in the | ||
1704 | <filename>conf/distro/poky.conf</filename> file in the | ||
1705 | <filename>meta-yocto</filename> Git repository. | ||
1706 | </para> | ||
1707 | |||
1708 | <para> | ||
1709 | Typically, you would add a specific server for the | 1724 | Typically, you would add a specific server for the |
1710 | build system to attempt before any others by adding | 1725 | build system to attempt before any others by adding |
1711 | something like the following to your configuration: | 1726 | something like the following to your configuration: |